You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# git-commit plugin |
|
|
|
|
|
The git-commit plugin adds several |
|
|
[git aliases](https://www.git-scm.com/docs/git-config#Documentation/git-config.txt-alias) for |
|
|
[conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) messages. |
|
|
|
|
|
To use it, add `git-commit` to the plugins array in your zshrc file: |
|
|
|
|
|
```zsh |
|
|
plugins=(... git-commit) |
|
|
``` |
|
|
|
|
|
## Syntax |
|
|
|
|
|
```zsh |
|
|
git <type> [(-s, --scope) "<scope>"] [(-a, --attention)] "<message>" |
|
|
``` |
|
|
|
|
|
Where `type` is one of the following: |
|
|
|
|
|
- `build` |
|
|
- `chore` |
|
|
- `ci` |
|
|
- `docs` |
|
|
- `feat` |
|
|
- `fix` |
|
|
- `perf` |
|
|
- `refactor` |
|
|
- `rev` |
|
|
- `style` |
|
|
- `test` |
|
|
- `wip` |
|
|
|
|
|
> NOTE: the alias for `revert` type is `rev`, as otherwise it conflicts with the git command of the same name. |
|
|
> It will still generate a commit message in the format `revert: <message>` |
|
|
|
|
|
> ⚠️ Enabling this plugin will (potentially) overwrite all `alias.<type>` that you manually set. Use with |
|
|
> care! |
|
|
|
|
|
## Examples |
|
|
|
|
|
| Git alias | Command | |
|
|
| --------------------------------------------- | ---------------------------------------------------- | |
|
|
| `git style "remove trailing whitespace"` | `git commit -m "style: remove trailing whitespace"` | |
|
|
| `git wip "work in progress"` | `git commit -m "work in progress"` | |
|
|
| `git fix -s "router" "correct redirect link"` | `git commit -m "fix(router): correct redirect link"` | |
|
|
| `git rev -s "api" "rollback v2"` | `git commit -m "revert(api): rollback v2"` |
|
|
|
|
