linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2025-12-12 01:52:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add auto install feature for pre-commit plugin

Browse source
This commit is contained in:
Marco Di Sarno 2024-04-11 10:58:28 +02:00
commit 6a511c4331
2 changed files with 118 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

47
plugins/pre-commit/README.md
View file

@ -17,3 +17,50 @@ plugins=(... pre-commit)
| 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 |
## Auto install `pre-commit` hook
This plugin can auto install the defined pre-commit hooks from a `.pre-commit-config.yaml`, if it detects that file in your current working dir.
## Settings
#### ZSH_PRE_COMMIT_AUTO_INSTALL
Set `ZSH_PRE_COMMIT_AUTO_INSTALL` to control auto install.
- `prompt` (default) will prompt on a per-directory basis
- `off` will turn the feature off
- any other setting will auto install without prompting.
```zsh
# in ~/.zshrc, before Oh My Zsh is sourced:
ZSH_PRE_COMMIT_AUTO_INSTALL=prompt|off|anything_else_is_on
```
#### ZSH_PRE_COMMIT_CONFIG_FILE
The plugin will default to use `.pre-commit-config.yaml`.
You can override this with the variable `$ZSH_PRE_COMMIT_CONFIG_FILE`, like so:
```zsh
# in ~/.zshrc, before Oh My Zsh is sourced:
ZSH_PRE_COMMIT_CONFIG_FILE=.my-custom-pre-commit-config.yaml
```
#### ZSH_PRE_COMMIT_INSTALLED_LIST
The default behavior of the plugin is to prompt for installation. It will also remember it did so, which will be cached in a list to be defined by: `$ZSH_PRE_COMMIT_INSTALLED_LIST`.
The details for the three options are:
- **Y**es: install and write the current dir into the list.
- **A**sk again for this directory: don't do anything now.
- **N**ever ask again for this directory: don't install, but write the current dir into the list.
By default, this list will be here `${ZSH_CACHE_DIR:-$ZSH/cache}/pre-commit-installed.list"`, but you can set the filename of that list to whatever you want:
```zsh
# in ~/.zshrc, before Oh My Zsh is sourced:
ZSH_PRE_COMMIT_INSTALLED_LIST=/path/to/list
```