npm

🛠Tool

javascript

npm

dev-ops

Manually adding to npm file

Semantic versioning

"jQuery": "~2.0.3", Most recent up to patch release
"jQuery": "^2.0.3", Most recent up to minor release
"jQuery": "2.0.3", That particular version

npm-check-updates (`ncu`)

Show any new dependencies:

ncu

Update packages (Update target version + install new versions):

ncu -u
npm install

Install packages as local dependencies in your project

cd to your project folder
Add a package.json configuration file for npm with:

The following opens an utility that will walk you through creating a package.json file.
```
npm init
```
Alternative which fills out stuff itself 🤯:
```
npm init -f
```

Distribute npm package

See npm-publish article

Add a local folder as npm dependency

Built dependency

Example: A local version of material-ui. Pay attention to the three /// right after file::

"material-ui": "file:///Users/myName/path/to/package/location/material-ui/build",

Own package

Use a relative path

"my-new-package": "../my_stuff/my-new-package",

This is useful for testing self-developed npm packages which live in another local directory.

Pre and Post hooks

Prepend script name with pre or post, e.g. npm run foo will execute npm run prefoo before and npm run postfoo right after the script.

See this nice npm guide

Example excerpt of a package.json file in a blitz.js app:

package.json

"prestart:prod": "yarn migrate",
"start:prod": "blitz start --production --hostname 0.0.0.0 --port 8080",
"migrate": "blitz db migrate deploy",

start:prod is configured on the Digital Ocean server.
prestart:prod makes sure the the migrations are executed before starting the server.

Difference between npm and bower

See this stackoverflow discussion

The biggest difference is that npm has a nested dependency tree (size heavy) while Bower requires a flat dependency tree (puts the burden of dependency resolution on the user).

A nested dependency tree means that your dependencies can have its own dependencies which can have their own, and so on. This is really great on the server where you don’t have to care much about space and latency. It lets you not have to care about dependency conflicts as all your dependencies use e.g. their own version of Underscore. This obviously doesn’t work that well on the front-end. Imagine a site having to download three copies of jQuery.

`npm ci`

This command deletes the node_modules folder every single time!

lock-file

As of npm version 5.7.0 you can use

npm install --package-lock-only

It will automatically fix merge conflicts in package-lock.json files, however, not in package.json files.

Noteworthy npm commands

Command	Result
`$ npm <COMMAND> -h`	show help of `<COMMAND>`
`$ npm install <pkg> --save` `$ npm i <pkg> --save`	install and save as dependency in `package.json`
`$ npm install mocha --save-dev`	install development dependency
`$ NODE_ENV=production npm install` `$ npm install --production`	will not install dev dependencies
`$ npm outdated`	Show outdated packages
`$ npm outdated -g`	Show outdated global packages
`$ npm update`	Update dependencies in `package.json` to newest versions
`$ npm update http-server -g`	update a global package
`$ npm uninstall colors --save`	uninstall and remove from `package.json`
`$ npm uninstall colors --save-dev`	uninstall development dependency

Command	Result
`$ npm list -g --depth=0` `npm ls -g --depth=0`	show all globally installed top level packages

Deleting all `node-modules` folders in directory

List all node_modules folders found in a directory (here current directory .) (it’s like dry run before deletion):

find . -name "node_modules" -type d -prune -print | xargs du -chs

Delete all node_modules found in a Directory

find . -name 'node_modules' -type d -prune -print -exec rm -rf '{}' \;

See this post about it.

Discuss on Twitter ● Improve this article: Edit on GitHub