|
1 |
| -# pnpm.plugin.zsh |
| 1 | +<p align="center"> |
| 2 | + <a href="#gh-dark-mode-only" target="_blank" rel="noopener noreferrer"> |
| 3 | + <img src=".github/assets/night.svg" alt="pnpm.plugin.zsh"> |
| 4 | + </a> |
2 | 5 |
|
3 |
| -This plugin adds many useful aliases for common _`pnpm`_ commands. |
| 6 | + <a href="#gh-light-mode-only" target="_blank" rel="noopener noreferrer"> |
| 7 | + <img src=".github/assets/day.svg" alt="pnpm.plugin.zsh"> |
| 8 | + </a> |
| 9 | +</p> |
4 | 10 |
|
5 |
| -This plugin has `shell completion` for _`pnpm`_. |
| 11 | +Plugin for aliases and completions for `pnpm` package manager. |
6 | 12 |
|
7 |
| -To use it, add _`pnpm`_ to the plugins array in your `.zshrc` file: |
| 13 | +## Installation |
8 | 14 |
|
9 |
| -## Install |
| 15 | +#### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) |
10 | 16 |
|
11 |
| -```console |
12 |
| -# ZPlug |
13 |
| -zplug "baliestri/pnpm.plugin.zsh" |
| 17 | +```shell |
| 18 | +git clone https://github.com/empresslabs/pnpm.plugin.zsh.git $ZSH_CUSTOM/plugins/pnpm |
| 19 | +``` |
| 20 | + |
| 21 | +```shell |
| 22 | +~/.zshrc |
| 23 | +plugins=(... pnpm) |
| 24 | +``` |
| 25 | + |
| 26 | +#### [zinit](https://github.com/zdharma-continuum/zinit) |
| 27 | + |
| 28 | +```shell |
| 29 | +zinit light empresslabs/pnpm.plugin.zsh |
| 30 | +``` |
| 31 | + |
| 32 | +#### [zi](https://github.com/z-shell/zi) |
| 33 | + |
| 34 | +```shell |
| 35 | +zi light empresslabs/pnpm.plugin.zsh |
| 36 | +``` |
| 37 | + |
| 38 | +#### [zgenom](https://github.com/jandamm/zgenom) |
14 | 39 |
|
15 |
| -# ZI |
16 |
| -zi ice lucid blockf atpull'zi creinstall -q .' |
17 |
| -zi light baliestri/pnpm.plugin.zsh |
| 40 | +```shell |
| 41 | +zgenom load empresslabs/pnpm.plugin.zsh |
18 | 42 | ```
|
19 | 43 |
|
| 44 | +#### [zplug](https://github.com/zplug/zplug) |
| 45 | + |
| 46 | +```shell |
| 47 | +zplug empresslabs/pnpm.plugin.zsh |
| 48 | +``` |
| 49 | + |
| 50 | +## Settings |
| 51 | + |
| 52 | +#### Use plugin-defined completions or pnpm's built-in completions |
| 53 | + |
| 54 | +```shell |
| 55 | +zstyle ":completion:plugins:pnpm" legacy-completion yes |
| 56 | +``` |
| 57 | + |
| 58 | +Add this line to your `~/.zshrc` file to use the plugin-defined completions. If you prefer to use pnpm's built-in completions, remove this line. |
| 59 | + |
20 | 60 | ## Aliases
|
21 | 61 |
|
22 | 62 | | Alias | Command | Description |
|
23 | 63 | | ----- | ------------------------------------ | ----------------------------------------------------------------------------- |
|
24 | 64 | | pn | `pnpm` | The _`pnpm`_ command |
|
25 |
| -| pnx | `pnpm dlx` | Fetch a package, load it and run command | |
| 65 | +| pnx | `pnpm dlx` | Fetch a package, load it and run command | |
26 | 66 | | pna | `pnpm add` | Install a package in dependencies (`package.json`) |
|
27 | 67 | | pnad | `pnpm add --save-dev` | Install a package in devDependencies (`package.json`) |
|
28 | 68 | | pnap | `pnpm add --save-peer` | Install a package in peerDependencies (`package.json`) |
|
@@ -54,3 +94,7 @@ zi light baliestri/pnpm.plugin.zsh
|
54 | 94 | | pnsv | `pnpm server` | Manage a _`pnpm`_ store server |
|
55 | 95 | | pnpub | `pnpm publish` | Publishes a package to the registry |
|
56 | 96 | | pnset | `pnpm setup` | Sets up pnpm |
|
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments