summaryrefslogtreecommitdiff
path: root/plugins/npm/README.md
diff options
context:
space:
mode:
authorAlex Matheson <Alex.kmatheson@gmail.com>2021-12-29 07:12:52 -0600
committerGitHub <noreply@github.com>2021-12-29 14:12:52 +0100
commitce9104c4f3d9ea424346d711f0653cd9e5d81303 (patch)
tree245e5b16ec2ddd201ab0bc545eff2d46596cb277 /plugins/npm/README.md
parent2acb3071cade6395c1dbcee31b6b8d198ebed66a (diff)
downloadzsh-ce9104c4f3d9ea424346d711f0653cd9e5d81303.tar.gz
zsh-ce9104c4f3d9ea424346d711f0653cd9e5d81303.tar.bz2
zsh-ce9104c4f3d9ea424346d711f0653cd9e5d81303.zip
feat(npm): toggle `npm install` / `npm uninstall` by pressing F2 twice (#9717)
Co-authored-by: Marc Cornellà <hello@mcornella.com>
Diffstat (limited to 'plugins/npm/README.md')
-rw-r--r--plugins/npm/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/npm/README.md b/plugins/npm/README.md
index e970c3c7a..8eafc6d61 100644
--- a/plugins/npm/README.md
+++ b/plugins/npm/README.md
@@ -29,3 +29,20 @@ plugins=(... npm)
| `npmI` | `npm init` | Run npm init |
| `npmi` | `npm info` | Run npm info |
| `npmSe` | `npm search` | Run npm search |
+
+## `npm install` / `npm uninstall` toggle
+
+The plugin adds a function that toggles between `npm install` and `npm uninstall` in
+the current command or the last command, for up to 2 previous commands. **The default
+key binding is pressing <kbd>F2</kbd> twice**.
+
+You can change this key binding by adding the following line to your zshrc file:
+
+```zsh
+bindkey -M emacs '<seq>' npm_toggle_install_uninstall
+bindkey -M vicmd '<seq>' npm_toggle_install_uninstall
+bindkey -M viins '<seq>' npm_toggle_install_uninstall
+```
+
+where `<seq>` is a key sequence obtained by running `cat` and pressing the keyboard
+sequence you want.