summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorMarkus Hofbauer <markus.hofbauer@tum.de>2022-11-23 10:23:11 +0100
committerGitHub <noreply@github.com>2022-11-23 10:23:11 +0100
commit8ef9abc9621321c41e89c578bc6f12176696f36c (patch)
tree6cb414eafe2b4d2f5ac2140d8389ae4bc050a143 /plugins
parentfe83581a20ab12010e9168977dc633c9da2924e1 (diff)
downloadzsh-8ef9abc9621321c41e89c578bc6f12176696f36c.tar.gz
zsh-8ef9abc9621321c41e89c578bc6f12176696f36c.tar.bz2
zsh-8ef9abc9621321c41e89c578bc6f12176696f36c.zip
feat(pre-commit) add aliases (#10707)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/pre-commit/README.md19
-rw-r--r--plugins/pre-commit/pre-commit.plugin.zsh8
2 files changed, 27 insertions, 0 deletions
diff --git a/plugins/pre-commit/README.md b/plugins/pre-commit/README.md
new file mode 100644
index 000000000..e6d80d369
--- /dev/null
+++ b/plugins/pre-commit/README.md
@@ -0,0 +1,19 @@
+# Pre-commit plugin
+
+This plugin adds aliases for common commands of [pre-commit](https://pre-commit.com/).
+
+To use this plugin, add it to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... pre-commit)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| ------- | -------------------------------------- | ------------------------------------------------------ |
+| prc | `pre-commit` | The `pre-commit` command |
+| prcau | `pre-commit autoupdate` | Update hooks automatically |
+| prcr | `pre-commit run` | The `pre-commit run` command |
+| prcra | `pre-commit run --all-files` | Run pre-commit hooks on all files |
+| prcrf | `pre-commit run --files` | Run pre-commit hooks on a given list of files |
diff --git a/plugins/pre-commit/pre-commit.plugin.zsh b/plugins/pre-commit/pre-commit.plugin.zsh
new file mode 100644
index 000000000..c3d0c6290
--- /dev/null
+++ b/plugins/pre-commit/pre-commit.plugin.zsh
@@ -0,0 +1,8 @@
+# Aliases for pre-commit
+alias prc='pre-commit'
+
+alias prcau='pre-commit autoupdate'
+
+alias prcr='pre-commit run'
+alias prcra='pre-commit run --all-files'
+alias prcrf='pre-commit run --files'