diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2023-01-17 12:46:15 +0100 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2023-01-17 12:46:15 +0100 |
| commit | db7efd2336e4dbe6abf321b00dbc11bc5afb1355 (patch) | |
| tree | 720a58ff82bf0a0e0167594131f872d453b1828e /plugins/pre-commit/README.md | |
| parent | 04b8c052e5b624873b352889423c753ed1baf9c4 (diff) | |
| parent | 8f0e296dbf27026ea0515ebae0d3cc41f236ecdc (diff) | |
| download | zsh-db7efd2336e4dbe6abf321b00dbc11bc5afb1355.tar.gz zsh-db7efd2336e4dbe6abf321b00dbc11bc5afb1355.tar.bz2 zsh-db7efd2336e4dbe6abf321b00dbc11bc5afb1355.zip | |
Merge remote-tracking branch 'github/master'
Diffstat (limited to 'plugins/pre-commit/README.md')
| -rw-r--r-- | plugins/pre-commit/README.md | 19 |
1 files changed, 19 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 | |