diff options
| author | Erwan ROUSSEL <erwan.roussel51@gmail.com> | 2018-05-26 22:22:22 +0200 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-05-26 22:22:22 +0200 |
| commit | 8bbef9180e3ba16e717a9587d0c965ab901c1226 (patch) | |
| tree | 79f0403b3d41f9f986c2daa3fe8661b360b7083f /plugins/npm | |
| parent | 62f676116e2f623329aaead72bfed5b4d2faa17f (diff) | |
| download | zsh-8bbef9180e3ba16e717a9587d0c965ab901c1226.tar.gz zsh-8bbef9180e3ba16e717a9587d0c965ab901c1226.tar.bz2 zsh-8bbef9180e3ba16e717a9587d0c965ab901c1226.zip | |
Npm's plugin documentation (#6864)
* Documentation for Npm plugin added
* Fix style and add alias descriptions
Diffstat (limited to 'plugins/npm')
| -rw-r--r-- | plugins/npm/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/plugins/npm/README.md b/plugins/npm/README.md new file mode 100644 index 000000000..202e2b0a4 --- /dev/null +++ b/plugins/npm/README.md @@ -0,0 +1,26 @@ +## npm plugin + +The npm plugin provides completion as well as adding many useful aliases. + +To use it, add npm to the plugins array of your zshrc file: +``` +plugins=(... npm) +``` + +## Aliases + +| 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 | |