pre-commit-crocodile 2.0.2__tar.gz → 3.0.0__tar.gz

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/.cz.yaml

@@ -133,18 +133,18 @@ commitizen:
       - type: input
         name: scope
         message: 'Scope of the change :'
-        filter: 'lambda text: commitizen.cz.utils.required_validator(text, msg="! Error: Scope is required")'
+        filter: 'required_validator_scope'
         default: ''
       - type: input
         name: subject
         message: 'Title of the commit (starting in lower case and without period) :'
-        filter: 'lambda text: commitizen.cz.utils.required_validator(text.strip(".").strip(), msg="! Error: Title is required")'
+        filter: 'required_validator_title_strip'
         default: ''
       - type: input
         name: body
         message: 'Additional contextual message (Empty to skip) :'
         default: 'Issue: #...'
-        filter: 'commitizen.cz.utils.multiple_line_breaker'
+        filter: 'multiple_line_breaker'
       - type: input
         name: footer
         message: 'Footer information and references (Empty to skip) :'

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/.gitlab-ci.yml

@@ -250,13 +250,16 @@ serve:
       echo -n "${!}" >./docs/.cache/.serve.pid
       sleep 2
     # Generate documentation
-    - network_ip=$(hostname -I | cut -d' ' -f1)
-    - mkdocs serve --dev-addr "${network_ip}:8001" --clean --config-file ./mkdocs.yml --verbose
-    # Release documentation
+    - |
+      network_ip=$(hostname -I | cut -d' ' -f1)
+      mkdocs serve --dev-addr "${network_ip}:8001" --clean --config-file ./mkdocs.yml --verbose || true
   after_script:
+    # Cleanup documentation
     - cat ./docs/.cache/.serve.pid | xargs -r kill >/dev/null 2>&1 || true
+    - rm -rf ./docs/.cache
   rules:
     - if: $CI_LOCAL
+  allow_failure: true
 
 # =============================================================================
 # Stage: prepare
@@ -268,7 +271,10 @@ codestyle:
   script:
     - yapf -i ./docs/*.py ./src/*.py ./src/*/*.py ./setup.py
     - echo '' && git diff --name-status
-    - git diff --quiet
+    - |
+      if [ -z "${CI_LOCAL:-}" ] || [ ! -z "${PRE_COMMIT}" ]; then
+        git diff --quiet
+      fi
   rules:
     - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
       changes:

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/.pre-commit-config.yaml

@@ -1,18 +1,22 @@
 # pre-commit configurations
 default_install_hook_types:
-  - prepare-commit-msg
+  - commit-msg
   - pre-commit
   - pre-push
-default_stages:
   - prepare-commit-msg
+default_stages:
+  - commit-msg
   - pre-commit
   - pre-push
+  - prepare-commit-msg
 minimum_pre_commit_version: 3.8.0
 
 # pre-commit exclusions
 exclude: >
   (?x)(
+    \.patch$|
     \.svg$|
+    eicar\..*$|
     CHANGELOG.md$|
     COPYING.*$|
     LICENSE.*$|
@@ -43,13 +47,21 @@ repos:
       - id: check-yaml
         args: ['--unsafe']
       - id: destroyed-symlinks
-      - id: detect-private-key
+        stages: [commit, push, manual] # Issue: https://github.com/pre-commit/pre-commit-hooks/pull/1085
+      # - id: detect-private-key
       - id: double-quote-string-fixer
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
         args: ['--markdown-linebreak-ext=md']
 
+  # Repository: pre-commit-hooks
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-type-ignore
+      - id: python-no-eval
+
   # Repository: commitizen
   - repo: https://github.com/commitizen-tools/commitizen
     rev: v3.29.0
@@ -66,37 +78,31 @@ repos:
     hooks:
       - id: prepare-commit-message
         name: Prepare commit message automatically
+        entry: python ./src/hooks/prepare_commit_message.py
+        language: python
         description: Automatically prepare the commit message for manual edition
+        args: []
         stages:
           - prepare-commit-msg
-        entry: python ./src/hooks/prepare_commit_message.py
-        args: []
-        language: python
+        additional_dependencies:
+          - PyYAML>=6.0
 
-  # Repository: local-gcil
-  - repo: local
+  # Repository: gcil
+  - repo: https://gitlab.com/RadianDevCore/tools/gcil
+    rev: 9db7ca21
     hooks:
-      - id: local-gcil-codestyle
-        name: check codestyle job with gcil
+      - id: run-gcil-push
+        name: Run GitLab CI job with gcil (codestyle)
         description: Automatically run GitLab CI job with gcil (codestyle)
-        stages:
-          - pre-push
-        entry: gcil
-        args: ['codestyle']
-        language: system
-      - id: local-gcil-lint
-        name: check lint job with gcil
+        args:
+          - 'codestyle'
+      - id: run-gcil-push
+        name: Run GitLab CI job with gcil (lint)
         description: Automatically run GitLab CI job with gcil (lint)
-        stages:
-          - pre-push
-        entry: gcil
-        args: ['lint']
-        language: system
-      - id: local-gcil-typings
-        name: check typings job with gcil
+        args:
+          - 'lint'
+      - id: run-gcil-push
+        name: Run GitLab CI job with gcil (typings)
         description: Automatically run GitLab CI job with gcil (typings)
-        stages:
-          - pre-push
-        entry: gcil
-        args: ['typings']
-        language: system
+        args:
+          - 'typings'

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/CHANGELOG.md

@@ -1,5 +1,87 @@
 # Changelog
 
+<a name="3.0.0"></a>
+## [3.0.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.1.0...3.0.0) (2024-08-25)
+
+### ✨ Features
+
+- **cli:** implement '--config FOLDER' and '--default' configurations ([081fd94](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/081fd94afd0d89ef2ac3ca23c68858c53df1216d))
+- **cli:** implement '--clean' to run 'pre-commit clean' cache cleanups ([b971337](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/b9713370b85e610aa724c2f45322c50dc461227d))
+- **entrypoint:** configure unused hooks upon '--default' use ([a271c43](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/a271c431988f116a57f5fa375eb1bf8cf4dbbc89))
+- **entrypoint:** inject badge in 'README.md' upon '--configure' ([739774d](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/739774d6b44f7cd5ce3b45738758215e74152f69))
+- **entrypoint:** add 'README.md' to '--configure' commmands hint ([8d7ddcc](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8d7ddccf2b530ad02c92a0a29b0894f37e8154df))
+- **entrypoint:** migrate to commitizen '3.29.0+adriandc.20240825' ([9c6f378](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9c6f37849e17f3ccd2baf302789045ed16424e86))
+- **entrypoint:** allow newer commitizen versions usage ([138ef35](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/138ef3533a03ceb0b5a6a7a7568795efd717e975))
+- **entrypoint, features:** refactor into static features classes ([9b85378](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9b85378eb831690fe83550dbea5b9575e1f04fa7))
+- **🚨 BREAKING CHANGE 🚨 |** **main:** avoid running '--run' features upon '--enable' ([1c9134d](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1c9134d152c69fbe34192461f62f1522e32bac21))
+- **prepare_commit_message:** inject signoff if commitizen 'always_signoff' ([f402004](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f402004cde6c84a6bc8857fd6cd6ddcd0618d0a0))
+- **updates:** migrate from deprecated 'pkg_resources' to 'packaging' ([1205341](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1205341bc1b7d7f96dfb8830b32c8853a96a31de))
+
+### 🐛 Bug Fixes
+
+- **entrypoint:** resolve unused hooks issues with '--default' ([9dc8309](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9dc8309dc8c2ff819d7ffe8fc0f7b46f1e52e438))
+- **entrypoint:** remove 'README.md' debugging log in '--configure' ([71ceb42](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/71ceb42808eaabf64998a79624a3be0a7995e29c))
+- **precommit:** resolve '--default' use with existing configuration ([7543149](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/7543149382f5280b074a24b1dbd403821810e36e))
+- **templates:** migrate to 'run-gcil-*' skipped hooks names ([63df3c3](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/63df3c36819540f119f82c1a37e7848078580e13))
+
+### 📚 Documentation
+
+- **readme:** add badge compatibility and syntax documentation ([9de0ad9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9de0ad97fdadf6cccd958b425ab5aafda1c02b38))
+- **readme:** add 'mkdocs' and 'mkdocs-material' references ([f9eac20](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f9eac20e5db2c7b383462930c9b1ca194da07af7))
+- **requirements:** install 'types-PyYAML>=6.0.12.2' as quality dependency ([4d09100](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/4d0910084d1392467dbca5298c01bcab7befaec8))
+
+### ⚙️ Cleanups
+
+- **commitizen:** migrate to new 'filter' syntax (commitizen#1207) ([4342bea](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/4342bea56efb8e9c45bcaa7372770cc0c240ae44))
+- **entrypoint:** constantify '{PACKAGE_REVISION}' template string ([8a77371](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8a77371e9f476293941e27748817b4a858cb6e9a))
+- **pre-commit:** add 'python-check-blanket-type-ignore' and 'python-no-eval' ([31738fe](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/31738fe68508926ed433190d870d7aea4c9464a5))
+- **pre-commit:** simplify and unify 'local-gcil' hooks syntax ([001b11d](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/001b11d840056d2a0a30faabac2e246f450163dd))
+- **pre-commit:** add 'additional_dependencies' for missing YAML ([9c80622](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9c806225083194d7d4e21de7b49fcefe38b53bfd))
+- **pre-commit:** improve syntax for 'args' arguments ([0d7e947](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/0d7e9476f5bf41c56ca699c4339a74900fa073c8))
+- **pre-commit:** migrate to 'run-gcil-*' template 'gcil' hooks ([8e0f5cf](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8e0f5cfcee7db56b2dff830401e97ce8b6a70f86))
+- **pre-commit:** update against 'run-gcil-push' hook template ([cb69d0b](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/cb69d0bbe2b1ca9f0338e005ec1447577355f856))
+- **pre-commit:** add missing 'commit-msg' stage for commitizen ([a27b9dd](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/a27b9dd23b33a0fbd99164a386d01485cc5b51c0))
+
+### 📦 Build
+
+- **requirements:** add 'PyYAML>=6.0' as runtime dependency ([2fe8d58](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/2fe8d58e586daa760d8d062368cdfe33028cddc4))
+
+
+<a name="2.1.0"></a>
+## [2.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.2...2.1.0) (2024-08-24)
+
+### ✨ Features
+
+- **entrypoint:** use 'pre-commit install --allow-missing-config' ([d41b2f3](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d41b2f39d024ba14dde024ae021649b991631a0d))
+- **entrypoint:** use 'pre-commit run --all-files' parameter syntax ([956cb33](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/956cb333028e61d2e1e14b5971d233f4882d069a))
+- **pre-commit:** exclude '.patch' Git patch files from hooks ([e865955](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e865955cc09781725dc0aa88314506b951ce3350))
+- **pre-commit:** disable 'detect-private-key' by default ([5ef6060](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/5ef6060fba92d46fde84530ccb08a271d50d2c94))
+- **pre-commit-config:** exclude 'eicar.*' Anti Malware Testfile ([6dbdb7c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/6dbdb7c5c7727788ffd9974e8dc0dee8c9c0c467))
+
+### 🐛 Bug Fixes
+
+- **pre-commit:** fix 'destroyed-symlinks' v4.6.0 missing stages ([5377b8f](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/5377b8fc5349301a8c10cb24edf3e6d511626ddb))
+- **templates/commits:** avoid failing without 'local-gcil-*' hooks ([1d9dc15](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1d9dc15b5fa3310251b35ab5f7f24398b2cfff93))
+
+### 📚 Documentation
+
+- **components:** add GitLab CI/CD Catalog for components URL ([47068c6](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/47068c6bce3758119db692ff74d0de9370ae199c))
+- **hooks:** fix hooks 'repo:' URL for '.pre-commit-config.yaml' ([b7c059e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/b7c059ef2a72d307c629231606e836ade5564ec5))
+- **hooks:** improve hook '.pre-commit-config.yaml' documentation ([7a3c283](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/7a3c283ffb7c60bcdb9f9909c8b9194755982cfe))
+- **prepare:** fix 'Commit type' list faulty indentation issue ([42f49cb](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/42f49cb494c206752723df29996012ca4935e742))
+
+### ⚙️ Cleanups
+
+- **pre-commit:** fail 'gcil' jobs if 'PRE_COMMIT' is defined ([1fcb35c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1fcb35c0224b31a0641f138c784ca59a53da75b5))
+
+### 🚀 CI
+
+- **gitlab-ci:** improve 'serve' job syntax for YAML rendering ([aa41a7e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/aa41a7e3544e40ede01733a83a9b9b936a8747e0))
+- **gitlab-ci:** cleanup cache upon 'serve' job end ([4574326](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/45743265d47b41929cebda731b444857feba9e14))
+- **gitlab-ci:** ignore 'serve' job failure due to 'Ctrl+C' end ([c8718b5](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c8718b5257069ab7e5410bea086aecece90a39a3))
+- **gitlab-ci:** avoid failures of 'codestyle' upon local launches ([6660428](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/666042865a99dd49fd092abc13e06f3de039b887))
+
+
 <a name="2.0.2"></a>
 ## [2.0.2](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.1...2.0.2) (2024-08-22)
 

{pre_commit_crocodile-2.0.2/pre_commit_crocodile.egg-info → pre_commit_crocodile-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.0.2
+Version: 3.0.0
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -27,6 +27,8 @@ Requires-Python: >=3,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: colored>=1.4.2
+Requires-Dist: packaging>=24.0
+Requires-Dist: PyYAML>=6.0
 Requires-Dist: setuptools>=45.1.0
 Requires-Dist: update_checker>=0.18.0
 
@@ -64,7 +66,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.0.0/docs/preview.svg)
 
 ---
 
@@ -75,7 +77,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ```yaml
 usage: pre-commit-crocodile [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
-                            [-l | -i | -c | -e | -d | -a | -r] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | --default] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -96,8 +98,13 @@ modes arguments:
   -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
+  --default            # Use global default configurations instead of sources
+
 positional arguments:
   --                   # Positional arguments separator (recommended)
 ```
@@ -126,6 +133,22 @@ positional arguments:
 
 ---
 
+## 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)
+
+```markdown title="Badge in Markdown"
+[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
+```
+
+```html title="Badge in HTML"
+<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://img.shields.io/badge/pre--commit-missing-gold)](https://github.com/pre-commit/pre-commit)
 
 ### Import configurations
@@ -168,6 +191,12 @@ pre-commit-crocodile --autoupdate
 pre-commit-crocodile --disable
 ```
 
+### Cleanup hooks
+
+```bash
+pre-commit-crocodile --clean
+```
+
 ---
 
 ## Dependencies
@@ -188,6 +217,8 @@ pre-commit-crocodile --disable
 - [gcil](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
 - [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator
 - [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
+- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown
+- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation
 - [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
 - [pexpect-executor](https://pypi.org/project/pexpect-executor/): Automate interactive CLI tools actions
 - [PyPI](https://pypi.org/): The Python Package Index

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/README.md

@@ -32,7 +32,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.0.0/docs/preview.svg)
 
 ---
 
@@ -43,7 +43,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ```yaml
 usage: pre-commit-crocodile [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
-                            [-l | -i | -c | -e | -d | -a | -r] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | --default] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -64,8 +64,13 @@ modes arguments:
   -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
+  --default            # Use global default configurations instead of sources
+
 positional arguments:
   --                   # Positional arguments separator (recommended)
 ```
@@ -94,6 +99,22 @@ positional arguments:
 
 ---
 
+## 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)
+
+```markdown title="Badge in Markdown"
+[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
+```
+
+```html title="Badge in HTML"
+<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://img.shields.io/badge/pre--commit-missing-gold)](https://github.com/pre-commit/pre-commit)
 
 ### Import configurations
@@ -136,6 +157,12 @@ pre-commit-crocodile --autoupdate
 pre-commit-crocodile --disable
 ```
 
+### Cleanup hooks
+
+```bash
+pre-commit-crocodile --clean
+```
+
 ---
 
 ## Dependencies
@@ -156,6 +183,8 @@ pre-commit-crocodile --disable
 - [gcil](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
 - [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator
 - [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
+- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown
+- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation
 - [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
 - [pexpect-executor](https://pypi.org/project/pexpect-executor/): Automate interactive CLI tools actions
 - [PyPI](https://pypi.org/): The Python Package Index

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/docs/components.md

@@ -16,6 +16,12 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ---
 
+## CI/CD components
+
+**GitLab CI/CD Catalog:** <https://gitlab.com/explore/catalog/RadianDevCore/tools/pre-commit-crocodile>
+
+---
+
 ### `commits` - GitLab CI job to validate newly pushed commits
 
 **Validate commits added on a branch or for a merge request :**

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/docs/hooks.md

@@ -34,7 +34,7 @@ minimum_pre_commit_version: 3.8.0
 repos:
 
   # Repository: pre-commit-crocodile
-  - repo: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile.git
+  - repo: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
     rev: X.Y.Z # Adapt to latest release tag
     hooks:
       - id: ...
@@ -44,22 +44,20 @@ repos:
 
 ### `prepare-commit-message` - Prepare commit message automatically
 
+```yaml title="Sources / .pre-commit-config.yaml"
+  # Repository: pre-commit-crocodile
+  - repo: ...
+    ...
+    hooks:
+      - id: prepare-commit-message
+```
+
 **Automatically prepare the commit message based on changed sources before manual edition :**
 
 - **Launched automatically by Git** upon `prepare-commit-msg` stage using `pre-commit`
-- Parse `Changes to be committed:` **to automatically prepare a `type(scope): ...` helpful template**
+- Parse `Changes to be committed:` **to automatically prepare a `type(scope): ...` title**
 - Commit messages implementation derived from **[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specifications**
 - **Automatically detect and prepare templates like `ci(gitlab-ci):`, `docs(readme):`, `build(makefile):` or `docs(changelog):`**
 - **Automatically evaluate sources specific scopes, for example files or folders under `src/`, or recipe folders in Yocto `recipes-.../` sources**
 - Message body is automatically inserted to help developers document their commits or link to a related issue
 - Commits with sign-off messages automatically receive a `---` separator for readability on GitLab
-
-**Changes to `.pre-commit-config.yaml` :**
-
-```yaml
-  # Repository: pre-commit-crocodile
-  - repo: ...
-    ...
-    hooks:
-      - id: prepare-commit-message
-```

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/docs/prepare.sh

@@ -38,7 +38,7 @@ sed -i "s#\(\[.*\]\)(.*/docs/#\1(assets/images/#g" "${docs_path}/.cache/index.md
     -e 's/\(conventional commits\|semantic versioning\)/**\1**/g' \
     -e "s/ '\([A-Za-z0-9:!]\{1,\}\)' / **\`\1\`** /g" \
     -e 's/^\([^#]\{1,\}\)$/\1  /g' \
-    -e '/^[^#\[<]\{1\}[^`]\{1,\}/s/^/\&nbsp;\&nbsp;\&nbsp;\&nbsp; /g'
+    -e '/^[^#\[<-]\{1\}[^`]\{1,\}/s/^/\&nbsp;\&nbsp;\&nbsp;\&nbsp; /g'
   echo ''
   echo '---'
   echo ''

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0/pre_commit_crocodile.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.0.2
+Version: 3.0.0
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -27,6 +27,8 @@ Requires-Python: >=3,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: colored>=1.4.2
+Requires-Dist: packaging>=24.0
+Requires-Dist: PyYAML>=6.0
 Requires-Dist: setuptools>=45.1.0
 Requires-Dist: update_checker>=0.18.0
 
@@ -64,7 +66,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.0.0/docs/preview.svg)
 
 ---
 
@@ -75,7 +77,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ```yaml
 usage: pre-commit-crocodile [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
-                            [-l | -i | -c | -e | -d | -a | -r] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | --default] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -96,8 +98,13 @@ modes arguments:
   -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
+  --default            # Use global default configurations instead of sources
+
 positional arguments:
   --                   # Positional arguments separator (recommended)
 ```
@@ -126,6 +133,22 @@ positional arguments:
 
 ---
 
+## 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)
+
+```markdown title="Badge in Markdown"
+[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
+```
+
+```html title="Badge in HTML"
+<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://img.shields.io/badge/pre--commit-missing-gold)](https://github.com/pre-commit/pre-commit)
 
 ### Import configurations
@@ -168,6 +191,12 @@ pre-commit-crocodile --autoupdate
 pre-commit-crocodile --disable
 ```
 
+### Cleanup hooks
+
+```bash
+pre-commit-crocodile --clean
+```
+
 ---
 
 ## Dependencies
@@ -188,6 +217,8 @@ pre-commit-crocodile --disable
 - [gcil](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
 - [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator
 - [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
+- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown
+- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation
 - [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
 - [pexpect-executor](https://pypi.org/project/pexpect-executor/): Automate interactive CLI tools actions
 - [PyPI](https://pypi.org/): The Python Package Index

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/pre_commit_crocodile.egg-info/SOURCES.txt

@@ -58,6 +58,12 @@ src/assets/__init__.py
 src/cli/__init__.py
 src/cli/entrypoint.py
 src/cli/main.py
+src/features/__init__.py
+src/features/argcomplete.py
+src/features/commitizen.py
+src/features/git.py
+src/features/precommit.py
+src/features/readme.py
 src/hooks/__init__.py
 src/hooks/configurations.py
 src/hooks/prepare_commit_message.py

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/pre_commit_crocodile.egg-info/requires.txt

@@ -1,3 +1,5 @@
 colored>=1.4.2
+packaging>=24.0
+PyYAML>=6.0
 setuptools>=45.1.0
 update_checker>=0.18.0

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/requirements/quality.txt

@@ -2,5 +2,6 @@ git+https://github.com/AdrianDC/commitizen.git@prerelease # == 3.29.0.AdrianDC.2
 mypy>=0.971
 pre-commit>=3.8.0
 pylint>=2.6.0
+types-PyYAML>=6.0.12.2
 types-setuptools>=65.3.0
 yapf>=0.29.0

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/requirements/runtime.txt

@@ -1,3 +1,5 @@
 colored>=1.4.2
+packaging>=24.0
+PyYAML>=6.0
 setuptools>=45.1.0
 update_checker>=0.18.0

{pre_commit_crocodile-2.0.2 → pre_commit_crocodile-3.0.0}/src/assets/.cz.yaml

@@ -133,18 +133,18 @@ commitizen:
       - type: input
         name: scope
         message: 'Scope of the change :'
-        filter: 'lambda text: commitizen.cz.utils.required_validator(text, msg="! Error: Scope is required")'
+        filter: 'required_validator_scope'
         default: ''
       - type: input
         name: subject
         message: 'Title of the commit (starting in lower case and without period) :'
-        filter: 'lambda text: commitizen.cz.utils.required_validator(text.strip(".").strip(), msg="! Error: Title is required")'
+        filter: 'required_validator_title_strip'
         default: ''
       - type: input
         name: body
         message: 'Additional contextual message (Empty to skip) :'
         default: 'Issue: #...'
-        filter: 'commitizen.cz.utils.multiple_line_breaker'
+        filter: 'multiple_line_breaker'
       - type: input
         name: footer
         message: 'Footer information and references (Empty to skip) :'