summaryrefslogtreecommitdiff
path: root/plugins/pre-commit/README.md
blob: e6d80d3690cd8ad39bf07d4c94e7055d25ffe66e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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          |