From 56de7c85f34a15a4490f4984e128dba78fcebfd3 Mon Sep 17 00:00:00 2001 From: Cédric Malard Date: Tue, 28 Dec 2021 17:06:50 +0100 Subject: docs(aliases): clarify usage (#9990) --- plugins/aliases/README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'plugins/aliases') diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md index 481c1bd4e..bfb6ab8c4 100644 --- a/plugins/aliases/README.md +++ b/plugins/aliases/README.md @@ -1,21 +1,22 @@ -## Aliases Cheatsheet +# Aliases cheatsheet **Maintainer:** [@hqingyi](https://github.com/hqingyi) With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts that are currently available based on the plugins you have enabled. -Enable this plugin by adding it to your `plugins` definition in `~/.zshrc`. +To use it, add `aliases` to the plugins array in your zshrc file: - ``` - plugins=(aliases) - ``` +```zsh +plugins=(aliases) +``` Requirements: Python needs to be installed. -### Usage +## Usage -``` - acs: group all alias - acs $keywordquickly filter alias & highlight -``` +- `acs`: show all aliases by group. + +- `acs `: filter aliases by `` and highlight. + + ![screenshot](https://cloud.githubusercontent.com/assets/3602957/11581913/cb54fb8a-9a82-11e5-846b-5a67f67ad9ad.png) -- cgit v1.2.3-70-g09d2 From c4be9294f26a3cf58fc7f1b4e6cd43931c68b639 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Tue, 28 Dec 2021 17:46:35 +0100 Subject: style(acs): fix style and gitignore __pycache__ folder --- plugins/aliases/.gitignore | 1 + plugins/aliases/aliases.plugin.zsh | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 plugins/aliases/.gitignore (limited to 'plugins/aliases') diff --git a/plugins/aliases/.gitignore b/plugins/aliases/.gitignore new file mode 100644 index 000000000..bee8a64b7 --- /dev/null +++ b/plugins/aliases/.gitignore @@ -0,0 +1 @@ +__pycache__ diff --git a/plugins/aliases/aliases.plugin.zsh b/plugins/aliases/aliases.plugin.zsh index 28d8fba24..b3d9340f0 100644 --- a/plugins/aliases/aliases.plugin.zsh +++ b/plugins/aliases/aliases.plugin.zsh @@ -2,9 +2,10 @@ # # - acs: alias cheatsheet # group alias by command, pass addition argv to grep. -ALIASES_PLUGIN_ROOT=$(cd `dirname $0` && pwd) function acs(){ - which python >>/dev/null - [[ $? -eq 1 ]] && echo "[error]no python executable detected!" && return - alias | python $ALIASES_PLUGIN_ROOT/cheatsheet.py $@ + (( $+commands[python] )) || { + echo "[error] No python executable detected" + return + } + alias | python ${functions_source[$0]:h}/cheatsheet.py $@ } -- cgit v1.2.3-70-g09d2