pre-commit-crocodile 2.1.0__tar.gz → 3.1.0__tar.gz

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.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.1.0 → pre_commit_crocodile-3.1.0}/.gitlab-ci.yml

@@ -246,7 +246,7 @@ serve:
     # Prepare documentation
     - |
       mkdir -p ./docs/.cache/
-      ls -1 ./.cz.yaml ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
+      ls -1 ./.cz.yaml ./config/* ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
       echo -n "${!}" >./docs/.cache/.serve.pid
       sleep 2
     # Generate documentation
@@ -586,6 +586,15 @@ sonarcloud:
     # Configure Git securities
     - git config --global --add safe.directory "${CI_PROJECT_DIR}"
   script:
+    # Prevent local usage
+    - |
+      if [ ! -z "${CI_LOCAL:-}" ] && [ -z "${SONAR_HOST_URL:-}" ]; then
+        set +x
+        echo ' '
+        echo ' [ERROR] SonarCloud quality job is meant for CI executions only...'
+        echo ' '
+        exit 1
+      fi
     # Scan with SonarCloud
     - sonar-scanner -Dsonar.projectVersion=$(git describe --always) -Dsonar.branch.name=${CI_COMMIT_REF_NAME}
   rules:
@@ -598,6 +607,8 @@ sonarcloud:
       when: always
     - if: $CI_COMMIT_REF_NAME == "main"
       when: always
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      when: always
     - when: never
   allow_failure: true
 
@@ -693,6 +704,11 @@ pages:
       artifacts: false
       optional: true
   script:
+    # Fetch all tags
+    - |
+      if [ -z "${CI_LOCAL:-}" ]; then
+        git fetch --tags --unshallow || true
+      fi
     # Prepare documentation
     - sh ./docs/prepare.sh
     # Generate documentation

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/.pre-commit-config.yaml

@@ -1,12 +1,14 @@
 # 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
@@ -53,6 +55,13 @@ repos:
       - 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
@@ -69,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 -e 'PRE_COMMIT'
-        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 -e 'PRE_COMMIT'
-        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 -e 'PRE_COMMIT'
-        args: ['typings']
-        language: system
+        args:
+          - 'typings'

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/CHANGELOG.md

@@ -1,5 +1,94 @@
 # Changelog
 
+<a name="3.1.0"></a>
+## [3.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/3.0.0...3.1.0) (2024-08-25)
+
+### ✨ Features
+
+- **cli:** implement '--stage STAGE' for '--run' to specify stage ([9ef3d2a](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9ef3d2ac4c9017ca247595da41a7cd9e5f998bd7))
+- **configurations:** implement matcher for 'sonar-project.properties' ([b9627a6](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/b9627a653a5336e3b1483894bd7a3c0c9b71c514))
+- **gcil:** inject 'gcil' badge automatically if configured or installed ([6cfe076](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/6cfe07681fe0ac7e8ac35d4c95da4bc36a8f045f))
+- **gcil:** implement automatic 'run-gcil-push' hooks with whitelist ([56e9e6c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/56e9e6ca4c46e11eb86479127a98042e9a039693))
+- **main:** add '-D' as short flag for '--default' long flag ([6515c29](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/6515c295868477d4bb3f88111b67fbf1d157ae5d))
+- **pre-commit:** add 'pygrep-hooks' hooks to 'pre-commit' template ([8813f81](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8813f8119c88c39a62834fcf1f5a0b8fe74211aa))
+
+### 🐛 Bug Fixes
+
+- **features:** enforce 'Commands' conditional arguments syntax ([142108f](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/142108f37896f9523e43144f3433092b1b4b5952))
+
+### 📚 Documentation
+
+- **cliff:** improve 'Unreleased' and refactor to 'Development' ([abaf0c9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/abaf0c9c11ac9e1e5bbf37fa3d5fe99f9290e436))
+- **mkdocs, prepare:** resolve Markdown support in hidden '<details>' ([d647166](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d647166f68fcccd2ab7ec1c3717622fa365a8bd8))
+- **prepare:** regenerate development 'CHANGELOG' with 'git-cliff' ([0cc6cc7](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/0cc6cc7995c56d91b1fb1eb7f9f63c35ce7c3609))
+- **readme:** link against 'gcil' and 'pexpect-executor' documentation pages ([3044355](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/304435558aeab4e9792b4029c8a9d9b26ef54771))
+- **readme:** add 'gcil:enabled' documentation badge ([f06542b](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f06542bac9d87e6844171cca4d4c96f9182ff91f))
+
+### ⚙️ Cleanups
+
+- **sonar:** wait for SonarCloud Quality Gate status ([f48b69e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f48b69efeb94f034b3fbf84dfaeebb35dfc0e6ea))
+
+### 🚀 CI
+
+- **gitlab-ci:** prevent 'sonarcloud' job launch upon 'gcil' local use ([8ba9700](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8ba97001ad13c6feb40e02dfac391c1169740f0f))
+- **gitlab-ci:** run SonarCloud analysis on merge request pipelines ([0f34e2d](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/0f34e2da8dfff5e7eb27a987dd02ffcc2c7aa3f6))
+- **gitlab-ci:** watch for 'config/*' changes in 'serve' job ([c47e433](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c47e4339fc6f321debce26c57dd265fea51eb3f8))
+- **gitlab-ci:** fetch Git tags history in 'pages' job execution ([c4c8b71](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c4c8b71f55198eae1e273cd00e81df94a87c15f9))
+- **gitlab-ci:** fetch with '--unshallow' for full history in 'pages' ([cd6d65e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/cd6d65e3f82b61afc7d56aadec907bf1489e688a))
+
+### 📦 Build
+
+- **containers:** use 'apk add --no-cache' for lighter images ([d13b26a](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d13b26a2bc88327bebfad60e635604ac786c9f4a))
+- **pages:** add 'git-cliff' to the ':pages' image ([26f26c6](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/26f26c6f0b06e3835a5d553eb5342d2ba5ec94da))
+
+
+<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)
 

{pre_commit_crocodile-2.1.0/pre_commit_crocodile.egg-info → pre_commit_crocodile-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.1.0
+Version: 3.1.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
 
@@ -42,6 +44,7 @@ Requires-Dist: update_checker>=0.18.0
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
@@ -64,7 +67,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.1.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.1.0/docs/preview.svg)
 
 ---
 
@@ -75,7 +78,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 | -D] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -96,8 +99,15 @@ 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
+  -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)
 ```
@@ -126,6 +136,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 +194,12 @@ pre-commit-crocodile --autoupdate
 pre-commit-crocodile --disable
 ```
 
+### Cleanup hooks
+
+```bash
+pre-commit-crocodile --clean
+```
+
 ---
 
 ## Dependencies
@@ -185,11 +217,13 @@ pre-commit-crocodile --disable
 
 - [.gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/): GitLab CI/CD Pipeline Configuration Reference
 - [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0/): Conventional Commits specification for commit messages
-- [gcil](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
+- [gcil](https://radiandevcore.gitlab.io/tools/gcil): 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
+- [pexpect-executor](https://radiandevcore.gitlab.io/tools/pexpect-executor): Automate interactive CLI tools actions
 - [PyPI](https://pypi.org/): The Python Package Index
 - [termtosvg](https://pypi.org/project/termtosvg/): Record terminal sessions as SVG animations
 - [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/README.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
@@ -32,7 +33,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.1.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.1.0/docs/preview.svg)
 
 ---
 
@@ -43,7 +44,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 | -D] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -64,8 +65,15 @@ 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
+  -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)
 ```
@@ -94,6 +102,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 +160,12 @@ pre-commit-crocodile --autoupdate
 pre-commit-crocodile --disable
 ```
 
+### Cleanup hooks
+
+```bash
+pre-commit-crocodile --clean
+```
+
 ---
 
 ## Dependencies
@@ -153,11 +183,13 @@ pre-commit-crocodile --disable
 
 - [.gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/): GitLab CI/CD Pipeline Configuration Reference
 - [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0/): Conventional Commits specification for commit messages
-- [gcil](https://pypi.org/project/gitlabci-local/): Launch .gitlab-ci.yml jobs locally
+- [gcil](https://radiandevcore.gitlab.io/tools/gcil): 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
+- [pexpect-executor](https://radiandevcore.gitlab.io/tools/pexpect-executor): Automate interactive CLI tools actions
 - [PyPI](https://pypi.org/): The Python Package Index
 - [termtosvg](https://pypi.org/project/termtosvg/): Record terminal sessions as SVG animations
 - [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/config/cliff.toml

@@ -16,7 +16,7 @@ body = """
         ## [{{ version }}](<REPO>/commits/{{ version }}) ({{ timestamp | date(format="%Y-%m-%d") }})
     {% endif %}\
 {% else %}\
-    ## [unreleased]
+    ## [Development](<REPO>/commits/main) ({{ commits | last | get(key='committer') | get(key='timestamp')  | date(format="%Y-%m-%d") }})
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}
     ### {{ group | striptags | trim | upper_first }}

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/containers/codestyle/Dockerfile

@@ -2,7 +2,7 @@ ARG IMAGE_BASE=python:3-alpine
 FROM $IMAGE_BASE
 
 # Install dependencies
-RUN apk add -q \
+RUN apk add -q --no-cache  \
       git
 
 # Install requirements

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/containers/commits/Dockerfile

@@ -2,7 +2,7 @@ ARG IMAGE_BASE=python:3-alpine
 FROM $IMAGE_BASE
 
 # Install dependencies
-RUN apk add -q \
+RUN apk add -q --no-cache  \
       git
 
 # Install requirements

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/containers/deploy/Dockerfile

@@ -2,7 +2,7 @@ ARG IMAGE_BASE=python:3-alpine
 FROM $IMAGE_BASE
 
 # Install dependencies
-RUN apk add -q \
+RUN apk add -q --no-cache  \
       gcc \
       git \
       libc-dev \

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/containers/pages/Dockerfile

@@ -2,8 +2,10 @@ ARG IMAGE_BASE=python:3-alpine
 FROM $IMAGE_BASE
 
 # Install dependencies
-RUN apk add -q \
-      git
+RUN apk add -q --no-cache  \
+      git \
+ && apk add -q --no-cache  --repository https://dl-cdn.alpinelinux.org/alpine/edge/community \
+      git-cliff
 
 # Install requirements
 COPY --from='requirements' ./pages.txt /tmp/

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/containers/preview/Dockerfile

@@ -2,7 +2,7 @@ ARG IMAGE_BASE=python:3-alpine
 FROM $IMAGE_BASE
 
 # Install dependencies
-RUN apk add -q \
+RUN apk add -q --no-cache  \
       bash \
       docker \
       git \

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/commitizen.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/commits.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/components.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/hooks.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/pre-commit.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/prepare.sh

@@ -8,7 +8,7 @@ docs_path=$(cd "$(dirname "${BASH_SOURCE:-${0}}")" && pwd -P)
 root_path="${docs_path%/*}"
 
 # Prepare cache
-rm -f "${docs_path}/.cache/*.md"
+rm -f "${docs_path}/.cache/"*.md
 mkdir -p "${docs_path}/.cache/"
 cp -rfv "${docs_path}/"*.md "${docs_path}/.cache/"
 
@@ -51,7 +51,11 @@ sed -i "s#\(\[.*\]\)(.*/docs/#\1(assets/images/#g" "${docs_path}/.cache/index.md
 
 # Export about/changelog
 mkdir -p "${docs_path}/.cache/about/"
-cp -f "${root_path}/CHANGELOG.md" "${docs_path}/.cache/about/changelog.md"
+if ! type git-cliff >/dev/null 2>&1; then
+  alias git-cliff='./.tmp/git-cliff'
+fi
+git-cliff --no-exec --config "${root_path}/config/cliff.toml" --output "${docs_path}/.cache/about/changelog.md"
+diff -u "${root_path}/CHANGELOG.md" "${docs_path}/.cache/about/changelog.md" || true
 
 # Export about/license
 {
@@ -62,6 +66,14 @@ cp -f "${root_path}/CHANGELOG.md" "${docs_path}/.cache/about/changelog.md"
   cat "${root_path}/LICENSE"
 } >"${docs_path}/.cache/about/license.md"
 
+# Bind 'md_in_html' extension
+sed -i \
+  -e 's/<\(details\)>/<\1 markdown>/g' \
+  -e 's/<\(div style="padding-left: 30px"\)>/<\1 markdown>/g' \
+  -e '/<div style="padding-left: 30px"/{ n; /<br/d; }' \
+  "${docs_path}/.cache/"*.md \
+  "${docs_path}/.cache/"*/*.md
+
 # Show cache
 echo ' '
 ls -laR "${docs_path}/.cache/"

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/docs/settings.md

@@ -10,6 +10,7 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_pre-commit-crocodile&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_pre-commit-crocodile)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
+[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
 [![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
 
 Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).

{pre_commit_crocodile-2.1.0 → pre_commit_crocodile-3.1.0}/mkdocs.yml

@@ -36,6 +36,7 @@ extra:
 
 # Pages extensions
 markdown_extensions:
+  - md_in_html
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span