From 4c0b82b482be7fd36d5abceefe9901ea5ab3da9e Mon Sep 17 00:00:00 2001 From: Marc Cornellà <marc.cornella@live.com> Date: Wed, 11 Jul 2018 21:40:24 +0200 Subject: yarn: add README --- plugins/yarn/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 plugins/yarn/README.md (limited to 'plugins/yarn/README.md') diff --git a/plugins/yarn/README.md b/plugins/yarn/README.md new file mode 100644 index 000000000..c4e6d6da5 --- /dev/null +++ b/plugins/yarn/README.md @@ -0,0 +1,33 @@ +# 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 | +| ygu | `yarn global upgrade` | Upgrade packages installed globally to their latest version | +| yh | `yarn help` | Show help for a yarn command | +| yin | `yarn install` | Install dependencies defined in `package.json` | +| yls | `yarn list` | List installed packages | +| yout | `yarn outdated` | Check for outdated package dependencies | +| yrm | `yarn remove` | Remove installed packages | +| yrun | `yarn run` | Run a defined package script | +| 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 | -- cgit v1.2.3-70-g09d2 From fa2dc41c233ac2f6a1fea81b6363cd97bb1d199b Mon Sep 17 00:00:00 2001 From: Michy Amrane <marseillaisanonymous@gmail.com> Date: Sun, 28 Oct 2018 19:27:34 +0100 Subject: [yarn] more aliases ^^ (#7310) * more aliases ^^ --- plugins/yarn/README.md | 6 ++++++ plugins/yarn/yarn.plugin.zsh | 6 ++++++ 2 files changed, 12 insertions(+) (limited to 'plugins/yarn/README.md') diff --git a/plugins/yarn/README.md b/plugins/yarn/README.md index c4e6d6da5..671a272d9 100644 --- a/plugins/yarn/README.md +++ b/plugins/yarn/README.md @@ -19,13 +19,19 @@ plugins=(... yarn) | 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 | diff --git a/plugins/yarn/yarn.plugin.zsh b/plugins/yarn/yarn.plugin.zsh index fe752357f..9ed8322cd 100644 --- a/plugins/yarn/yarn.plugin.zsh +++ b/plugins/yarn/yarn.plugin.zsh @@ -4,13 +4,19 @@ alias yad="yarn add --dev" alias yap="yarn add --peer" alias yb="yarn build" alias ycc="yarn cache clean" +alias yga="yarn global add" +alias ygls="yarn global list" +alias ygrm="yarn global remove" alias ygu="yarn global upgrade" alias yh="yarn help" +alias yi="yarn init" alias yin="yarn install" alias yls="yarn list" alias yout="yarn outdated" +alias yp="yarn pack" alias yrm="yarn remove" alias yrun="yarn run" +alias ys="yarn serve" alias yst="yarn start" alias yt="yarn test" alias yuc="yarn global upgrade && yarn cache clean" -- cgit v1.2.3-70-g09d2