8ef9abc9621321c41e89c578bc6f12176696f36c
- Author
- Markus Hofbauer <markus.hofbauer@tum.de>
- Committer
- GitHub <noreply@github.com>
- Date
Message
feat(pre-commit) add aliases (#10707)
Diff
1diff --git a/plugins/pre-commit/README.md b/plugins/pre-commit/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..e6d80d3690cd8ad39bf07d4c94e7055d25ffe66e
4--- /dev/null
5+++ b/plugins/pre-commit/README.md
6@@ -0,0 +1,19 @@
7+# Pre-commit plugin
8+
9+This plugin adds aliases for common commands of [pre-commit](https://pre-commit.com/).
10+
11+To use this plugin, add it to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... pre-commit)
15+```
16+
17+## Aliases
18+
19+| Alias | Command | Description |
20+| ------- | -------------------------------------- | ------------------------------------------------------ |
21+| prc | `pre-commit` | The `pre-commit` command |
22+| prcau | `pre-commit autoupdate` | Update hooks automatically |
23+| prcr | `pre-commit run` | The `pre-commit run` command |
24+| prcra | `pre-commit run --all-files` | Run pre-commit hooks on all files |
25+| prcrf | `pre-commit run --files` | Run pre-commit hooks on a given list of files |
26diff --git a/plugins/pre-commit/pre-commit.plugin.zsh b/plugins/pre-commit/pre-commit.plugin.zsh
27new file mode 100644
28index 0000000000000000000000000000000000000000..c3d0c629036627e29e1c3f0d460aa87b34c4ddf5
29--- /dev/null
30+++ b/plugins/pre-commit/pre-commit.plugin.zsh
31@@ -0,0 +1,8 @@
32+# Aliases for pre-commit
33+alias prc='pre-commit'
34+
35+alias prcau='pre-commit autoupdate'
36+
37+alias prcr='pre-commit run'
38+alias prcra='pre-commit run --all-files'
39+alias prcrf='pre-commit run --files'