Npm (software): Difference between revisions
Line 68: | Line 68: | ||
==Resources== | ==Resources== | ||
* | * [https://zellwk.com/blog/publish-to-npm/ https://zellwk.com/blog/publish-to-npm/ zellwk publish to npm] |
Latest revision as of 14:31, 17 July 2021
NPM is a package manager for JavaScript and TypeScript projects.
Usage
# Install packages from package.json npm install # Install versioned packages from package-lock.json npm ci
package.json
Example package.json
scripts
contains JS commands you can run withnpm run
bin
contains binaries or scripts which get installed globally.
Publishing
- Create an account at https://npmjs.org.
- Login to npm using
npm login
. - Initialize a
package.json
usingnpm init
.- I recommend using a scoped name
@username/package-name
.
- I recommend using a scoped name
- Make a UMD build e.g. using webpack.
- Fill in all the details in
package.json
. - For publishing the most important are: name, version, description, main, module, author, repository, license, files, homepage.
- Fill in all the details in
- Test your package.
- Run your own tests using
npm run test
. - Install to another package using `npm install [dir]`.
- Run your own tests using
- Version and upload to npm
npm version [major|minor|patch]
- npm publish --access public