Fix style and add alias descriptions

This commit is contained in:
Marc Cornellà 2018-05-26 22:21:30 +02:00 committed by GitHub
parent 807abf3565
commit 62c0ae8668
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,23 +1,26 @@
## The npm Plugin
## npm plugin
The [npm](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/npm) plugin provides many [aliases](#aliases).
The npm plugin provides completion as well as adding many useful aliases.
Enable it by adding _npm_ to the [_plugins array_](https://github.com/robbyrussell/oh-my-zsh/blob/master/templates/zshrc.zsh-template#L61) before sourcing OMZ (see [[Plugins]]).
To use it, add npm to the plugins array of your zshrc file:
```
plugins=(... npm)
```
## Aliases
| Alias | Command |
|:------------|:-----------------------------|
| npmg | npm i -g |
| npmS | npm i -S |
| npmD | npm i -D |
| npmE | PATH="$(npm bin)":"$PATH" |
| npmO | npm outdated |
| npmV | npm -v |
| npmL | npm list |
| npmL0 | npm ls --depth=0 |
| npmst | npm start |
| npmt | npm test |
| npmR | npm run |
| npmP | npm publish |
| npmI | npm init |
| Alias | Command | Descripton |
|:------ |:-----------------------------|:----------------------------------------------------------------|
| `npmg` | `npm i -g` | Install dependencies globally |
| `npmS` | `npm i -S` | Install and save to dependencies in your package.json |
| `npmD` | `npm i -D` | Install and save to dev-dependencies in your package.json |
| `npmE` | `PATH="$(npm bin)":"$PATH"` | Run command from node_modules folder based on current directory |
| `npmO` | `npm outdated` | Check which npm modules are outdated |
| `npmV` | `npm -v` | Check package versions |
| `npmL` | `npm list` | List installed packages |
| `npmL0` | `npm ls --depth=0` | List top-level installed packages |
| `npmst` | `npm start` | Run npm start |
| `npmt` | `npm test` | Run npm test |
| `npmR` | `npm run` | Run npm scripts |
| `npmP` | `npm publish` | Run npm publish |
| `npmI` | `npm init` | Run npm init |