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 | -C | -r] [--config FOLDER | -D] [--stage STAGE] [--]
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
-C, --clean # Clean pre-commit cached hooks
-r, --run # Run pre-commit hooks
configurations arguments:
--config FOLDER # Use configurations from a specific folder
-D, --default # Use global default configurations instead of sources
--stage STAGE # Run a specific pre-commit stage with --run
# (use 'list' to list supported stages)
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
}
Compatibility
Projects compatible with pre-commit-crocodile
can use this badge to ease things for developers, both as an indicator and a documentation shortcut button :
[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
<a href="https://radiandevcore.gitlab.io/tools/pre-commit-crocodile"><img src="https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab" alt="pre-commit-crocodile" style="max-width:100%;"></a>
Projects without configurations | ![pre-commit](https://pypi-camo.freetls.fastly.net/cee8f3b2f7f0430b89224bf4d92764f4aeeb901d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7072652d2d636f6d6d69742d6d697373696e672d676f6c64)
Import configurations
pre-commit-crocodile --configure
Projects with configurations | ![pre-commit-crocodile](https://pypi-camo.freetls.fastly.net/535924bc7c15e88fe1e6e29c06f3501f17a3ab87/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7072652d2d636f6d6d69742d2d63726f636f64696c652d656e61626c65642d627269676874677265656e3f6c6f676f3d6769746c6162)
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
Cleanup hooks
pre-commit-crocodile --clean
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
- mkdocs: Project documentation with Markdown
- mkdocs-material: Material theme for mkdocs documentation
- 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-3.1.0.tar.gz
(121.9 kB
view hashes)
Built Distribution
Close
Hashes for pre_commit_crocodile-3.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d93375d79d6d0fce9f9553d111af03328b826711ff2a5468d36c709777cd471 |
|
MD5 | 76d3e9cd484064e6c523debc515a00f0 |
|
BLAKE2b-256 | d36f4323f82ad641db16eb85bd928e22d3a1ae5d1ee9567675a60cfcf5f8eb72 |
Close
Hashes for pre_commit_crocodile-3.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8511ec67d58b5e66684fb4d597536adc8c72bfea0260964771f950586cb5131 |
|
MD5 | d093157f49ab862dbc0558f3c0fc2011 |
|
BLAKE2b-256 | 45d62c82c542b9aeb114deda79910ac34c4680becf17f771e3772aa4cf21cf88 |