A pre-commit hook that checks commit messages for Conventional Commits formatting.
Project description
conventional-pre-commit
A pre-commit
hook to check commit messages for
Conventional Commits formatting.
Usage
Make sure pre-commit
is installed.
Create a blank configuration file at the root of your repo, if needed:
touch .pre-commit-config.yaml
Add a new repo entry to your configuration file:
repos:
# - repo: ...
- repo: https://github.com/compilerla/conventional-pre-commit
rev: <git sha or tag>
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]
Install the pre-commit
script:
pre-commit install --hook-type commit-msg
Make a (normal) commit :x::
$ git commit -m "add a new feature"
[INFO] Initializing environment for ....
Conventional Commit......................................................Failed
- hook id: conventional-pre-commit
- duration: 0.07s
- exit code: 1
[Bad Commit message] >> add a new feature
Your commit message does not follow Conventional Commits formatting
https://www.conventionalcommits.org/
Conventional Commits start with one of the below types, followed by a colon,
followed by the commit message:
build chore ci docs feat fix perf refactor revert style test
Example commit message adding a feature:
feat: implement new API
Example commit message fixing an issue:
fix: remove infinite loop
Optionally, include a scope in parentheses after the type for more context:
fix(account): remove infinite loop
Make a (conventional) commit :heavy_check_mark::
$ git commit -m "feat: add a new feature"
[INFO] Initializing environment for ....
Conventional Commit......................................................Passed
- hook id: conventional-pre-commit
- duration: 0.05s
Install with pip
conventional-pre-commit
can also be installed and used from the command line:
pip install conventional-pre-commit
Then run the command line script:
conventional-pre-commit [types] input
Where [types]
is an optional list of Conventional Commit types to allow (e.g. feat fix chore
)
And input
is a file containing the commit message to check:
conventional-pre-commit feat fix chore ci test .git/COMMIT_MSG
Or from a Python program:
from conventional_pre_commit.format import is_conventional
# prints True
print(is_conventional("feat: this is a conventional commit"))
# prints False
print(is_conventional("nope: this is not a conventional commit"))
# prints True
print(is_conventional("custom: this is a conventional commit", types=["custom"]))
Versioning
Versioning generally follows Semantic Versioning.
Development
conventional-pre-commit
comes with a VS Code devcontainer
configuration to provide a consistent development environment.
With the Remote - Containers
extension enabled, open the folder containing this repository inside Visual Studio Code.
You should receive a prompt in the Visual Studio Code window; click Reopen in Container
to run the development environment
inside the devcontainer.
If you do not receive a prompt, or when you feel like starting from a fresh environment:
Ctrl/Cmd+Shift+P
to bring up the command palette in Visual Studio Code- Type
Remote-Containers
to filter the commands - Select
Rebuild and Reopen in Container
to completely rebuild the devcontainer - Select
Reopen in Container
to reopen the most recent devcontainer build
License
Inspired by matthorgan's pre-commit-conventional-commits
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for conventional_pre_commit-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc03c1d76d7a083286d30367b99aa4610df0c9dd2887b68e672b1ad6fe1d0b7b |
|
MD5 | 4770a00561948d59787ddbc42cbf4a4d |
|
BLAKE2b-256 | ded45d674588f468dbb0fdd1f4888552d5f4fcc8875a8ae570cc2637fe07ad4e |
Hashes for conventional_pre_commit-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11bf5467b1f908b6818b6aa53c2c281973c234e29e62ccec89c5e6244474c1fa |
|
MD5 | 6f94a0eefd814add6093319a619d937b |
|
BLAKE2b-256 | 46348223110cbfeaec9bd3aa662843c86f56f8f26e09a368e689f6ece225870c |