Git hooks intended for developers using pre-commit
Project description
pre-commit-crocodile
Git hooks intended for developers using pre-commit and commitizen.
Documentation: https://radiandevcore.gitlab.io/tools/pre-commit-crocodile
Package: https://pypi.org/project/pre-commit-crocodile/
Features
pre-commit-crocodile
uses the following features:
- CLI - pre-commit: Automated Git hooks before commits and upon pushes
- CLI - commitizen: Commits tools and validation based upon conventional commits
- Hooks - pre-commit-hooks: Common
pre-commit
hooks useful for developers - Hooks -
prepare-commit-msg
: Prepare commit message automatically based on changes
Preview
Usage
usage: pre-commit-crocodile [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
[-l | -i | -c | -e | -d | -a | -r] [--]
pre-commit-crocodile: Git hooks intended for developers using pre-commit
internal arguments:
-h, --help # Show this help message
--version # Show the current version
--no-color # Disable colors outputs with 'NO_COLOR=1'
# (or default settings: [themes] > no_color)
--update-check # Check for newer package updates
--settings # Show the current settings path and contents
--set GROUP KEY VAL # Set settings specific 'VAL' value to [GROUP] > KEY
# or unset by using 'UNSET' as 'VAL'
modes arguments:
-l, --list # List Git hooks installed in sources
-i, --install # Install dependencies for pre-commit hooks
-c, --configure # Update sources with hooks configurations
-e, --enable # Enable pre-commit hooks
-d, --disable # Disable pre-commit hooks
-a, --autoupdate # Autoupdate pre-commit hooks
-r, --run # Run pre-commit hooks
positional arguments:
-- # Positional arguments separator (recommended)
Installation
{
# Option 1: If using pipx
if type pipx >/dev/null 2>&1; then
pipx ensurepath
pipx install pre-commit-crocodile
pipx upgrade pre-commit-crocodile
# Option 2: If using pip
else
sudo pip3 install pre-commit-crocodile
fi
}
Projects without configurations |
Import configurations
pre-commit-crocodile --configure
Projects with configurations |
Install dependencies
pre-commit-crocodile --install
Enable hooks
pre-commit-crocodile --enable
Run hooks
pre-commit-crocodile --run
Update hooks
pre-commit-crocodile --autoupdate
Disable hooks
pre-commit-crocodile --disable
Dependencies
- colored: Terminal colors and styles
- commitizen: Simple commit conventions for internet citizens
- pre-commit: A framework for managing and maintaining pre-commit hooks
- pre-commit-crocodile: Git hooks intended for developers using pre-commit
- setuptools: Build and manage Python packages
- update-checker: Check for package updates on PyPI
References
- .gitlab-ci.yml: GitLab CI/CD Pipeline Configuration Reference
- conventionalcommits: Conventional Commits specification for commit messages
- gcil: Launch .gitlab-ci.yml jobs locally
- git-cliff: CHANGELOG generator
- gitlab-release: Utility for publishing on GitLab
- mypy: Optional static typing for Python
- pexpect-executor: Automate interactive CLI tools actions
- PyPI: The Python Package Index
- termtosvg: Record terminal sessions as SVG animations
- twine: Utility for publishing on PyPI
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pre_commit_crocodile-2.0.2.tar.gz
(113.0 kB
view hashes)
Built Distribution
Close
Hashes for pre_commit_crocodile-2.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 630d11c01e84587eaefd74c4f2890db4178f7705dbfcdd93336f6eb15fefab56 |
|
MD5 | 0bf956fcebb54a40cd4a8c1631ed41a4 |
|
BLAKE2b-256 | 18bdfc21771251b078025bfabf478cfd634ca8589459e943500403090fc7f9c1 |
Close
Hashes for pre_commit_crocodile-2.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11218a26240742d9a3885f74162615cc6f7015633b30c6843ad18861c21cb62d |
|
MD5 | 0b58c46e28bb1e5f0c711ea4c00f27ae |
|
BLAKE2b-256 | 5473b5df32a4ba3e34df546c12067ea612639b95e0e25decf8373697add8ad0e |