diff options
| author | Kozlov Alexander <badryke@gmail.com> | 2018-11-16 13:38:43 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-16 13:38:43 +0300 |
| commit | 8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch) | |
| tree | ee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/yarn/README.md | |
| parent | dd30cf104c9ca42d89d26a134382ca421869ce7e (diff) | |
| parent | 3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff) | |
| download | zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2 zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip | |
Merge branch 'master' into master
Diffstat (limited to 'plugins/yarn/README.md')
| -rw-r--r-- | plugins/yarn/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/plugins/yarn/README.md b/plugins/yarn/README.md new file mode 100644 index 000000000..671a272d9 --- /dev/null +++ b/plugins/yarn/README.md @@ -0,0 +1,39 @@ +# Yarn plugin + +This plugin adds completion for the [Yarn package manager](https://yarnpkg.com/en/), +as well as some aliases for common Yarn commands. + +To use it, add `yarn` to the plugins array in your zshrc file: + +```zsh +plugins=(... yarn) +``` + +## Aliases + +| Alias | Command | Description | +|-------|-------------------------------------------|-------------------------------------------------------------| +| y | `yarn` | The Yarn command | +| ya | `yarn add` | Install a package in dependencies (`package.json`) | +| yad | `yarn add --dev` | Install a package in devDependencies (`package.json`) | +| yap | `yarn add --peer` | Install a package in peerDependencies (`package.json`) | +| yb | `yarn build` | Run the build script defined in `package.json` | +| ycc | `yarn cache clean` | Clean yarn's global cache of packages | +| yga | `yarn global add` | Install packages globally on your operating system | +| ygls | `yarn global list` | Lists global installed packages | +| ygrm | `yarn global remove` | Remove global installed packages from your OS | +| ygu | `yarn global upgrade` | Upgrade packages installed globally to their latest version | +| yh | `yarn help` | Show help for a yarn command | +| yi | `yarn init` | Interactively creates or updates a package.json file | +| yin | `yarn install` | Install dependencies defined in `package.json` | +| yls | `yarn list` | List installed packages | +| yout | `yarn outdated` | Check for outdated package dependencies | +| yp | `yarn pack` | Create a compressed gzip archive of package dependencies | +| yrm | `yarn remove` | Remove installed packages | +| yrun | `yarn run` | Run a defined package script | +| ys | `yarn serve` | Start the dev server | +| yst | `yarn start` | Run the start script defined in `package.json` | +| yt | `yarn test` | Run the test script defined in `package.json` | +| yuc | `yarn global upgrade && yarn cache clean` | Upgrade global packages and clean yarn's global cache | +| yui | `yarn upgrade-interactive` | Prompt for which outdated packages to upgrade | +| yup | `yarn upgrade` | Upgrade packages to their latest version | |