Browse Source

feat(pre-commit) add aliases (#10707)

Markus Hofbauer 1 year ago
parent
commit
8ef9abc962
2 changed files with 27 additions and 0 deletions
  1. 19 0
      plugins/pre-commit/README.md
  2. 8 0
      plugins/pre-commit/pre-commit.plugin.zsh

+ 19 - 0
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          |

+ 8 - 0
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'