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

{pre_commit_crocodile-3.0.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-3.0.0 → pre_commit_crocodile-3.1.0}/CHANGELOG.md

@@ -1,5 +1,47 @@
 # 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)
 

{pre_commit_crocodile-3.0.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: 3.0.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
@@ -44,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/).
@@ -66,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/3.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.1.0/docs/preview.svg)
 
 ---
 
@@ -77,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 | -C | -r] [--config FOLDER | --default] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -103,7 +104,9 @@ modes arguments:
 
 configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
-  --default            # Use global default configurations instead of sources
+  -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)
@@ -214,13 +217,13 @@ pre-commit-crocodile --clean
 
 - [.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-3.0.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/3.0.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 | -C | -r] [--config FOLDER | --default] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -69,7 +70,9 @@ modes arguments:
 
 configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
-  --default            # Use global default configurations instead of sources
+  -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)
@@ -180,13 +183,13 @@ pre-commit-crocodile --clean
 
 - [.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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-3.0.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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 3.0.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
@@ -44,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/).
@@ -66,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/3.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/3.1.0/docs/preview.svg)
 
 ---
 
@@ -77,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 | -C | -r] [--config FOLDER | --default] [--]
+                            [-l | -i | -c | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -103,7 +104,9 @@ modes arguments:
 
 configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
-  --default            # Use global default configurations instead of sources
+  -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)
@@ -214,13 +217,13 @@ pre-commit-crocodile --clean
 
 - [.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-3.0.0 → pre_commit_crocodile-3.1.0}/pre_commit_crocodile.egg-info/SOURCES.txt

@@ -61,6 +61,7 @@ src/cli/main.py
 src/features/__init__.py
 src/features/argcomplete.py
 src/features/commitizen.py
+src/features/gcil.py
 src/features/git.py
 src/features/precommit.py
 src/features/readme.py

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/sonar-project.properties

@@ -5,6 +5,9 @@ sonar.organization=radiandevcore
 sonar.projectName=pre-commit-crocodile
 #sonar.projectVersion=1.0
 
+# Wait for SonarCloud Quality Gate status
+sonar.qualitygate.wait=true
+
 # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
 sonar.sources=src
 

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/assets/.pre-commit-config.yaml

@@ -53,6 +53,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

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/cli/entrypoint.py

@@ -12,6 +12,7 @@ from typing import List, Union
 # Components
 from ..features.argcomplete import Argcomplete
 from ..features.commitizen import Commitizen
+from ..features.gcil import Gcil
 from ..features.git import Git
 from ..features.precommit import PreCommit
 from ..features.readme import Readme
@@ -185,6 +186,9 @@ class Entrypoint:
                 configuration_file=precommit_configuration.name,
             )
 
+            # Configre gcil hooks
+            Gcil.configure_hooks(configuration_file=precommit_configuration.name)
+
         # Configure sources
         if options.configure:
 
@@ -219,6 +223,9 @@ class Entrypoint:
             # Configure unused hooks
             PreCommit.configure_unused_hooks(default=options.default)
 
+            # Configre gcil hooks
+            Gcil.configure_hooks()
+
             # Inject badge to README
             if Readme.exists():
 
@@ -236,20 +243,45 @@ class Entrypoint:
                 # Validate badge in README
                 if not any(Bundle.NAME in line for line in readme_lines):
 
-                    # Inject badge line
+                    # Detect gcil usage
+                    gcil_exists: bool = Gcil.exists()
+                    gcil_configured: bool = Gcil.configured()
+                    gcil_installed: bool = Gcil.installed()
+
+                    # Inject badge lines
                     print(f'injecting badge in {Readme.FILE} documentation')
                     print(' ')
                     for i, line in enumerate(readme_lines):
-                        if not line.strip():
-                            readme_lines.insert(
-                                i + 1,
-                                line,
-                            )
+
+                        # Ignore non-empty lines
+                        if line.strip():
+                            continue
+
+                        # Inject badges separator
+                        readme_lines.insert(
+                            i + 1,
+                            line,
+                        )
+
+                        # Inject pre-commit-crocodile badge
+                        readme_lines.insert(
+                            i + 1,
+                            f'[![{Bundle.NAME}]'
+                            f'({Bundle.BADGE})]'
+                            f'({Bundle.DOCUMENTATION}){line}',
+                        )
+
+                        # Inject gcil badge
+                        if gcil_exists and (gcil_configured or gcil_installed):
                             readme_lines.insert(
                                 i + 1,
-                                f'[![{Bundle.NAME}]({Bundle.BADGE})]({Bundle.DOCUMENTATION}){line}',
+                                f'[![{Gcil.BADGE_TEXT}]'
+                                f'({Gcil.BADGE_IMAGE})]'
+                                f'({Gcil.BADGE_URL}){line}',
                             )
-                            break
+
+                        # Preserve README documentation
+                        break
 
                     # Export README contents
                     Readme.write(readme_lines)
@@ -260,8 +292,8 @@ class Entrypoint:
                     print(' ')
 
             # Show sources status
-            print(' ')
             Git.status(untracked=True)
+            print(' ')
 
             # Show commit hints
             command_add: str = ' '.join([
@@ -276,7 +308,6 @@ class Entrypoint:
                 f'"chore(pre-commit): import \'{Bundle.NAME}\' configurations"',
                 '-s',
             ])
-            print(' ')
             print(f'{Colors.BOLD}Add configurations: '
                   f'{Colors.CYAN}{command_add}'
                   f'{Colors.RESET}')
@@ -357,10 +388,19 @@ class Entrypoint:
             print(' ')
             print(f'{Colors.BOLD} - Run hooks: '
                   f'{Colors.YELLOW_LIGHT}pre-commit'
+                  f'{Colors.CYAN}{f" (stage: {options.stage})" if options.stage else ""}'
                   f'{Colors.RESET}')
             print(' ')
             Platform.flush()
-            PreCommit.run(all_files=True)
+            if options.stage == 'list':
+                hooks_stages: List[str] = PreCommit.stages()
+                print(f'{Colors.BOLD}Supported pre-commit hooks stages:'
+                      f'{Colors.RESET} {", ".join(hooks_stages)}')
+            else:
+                PreCommit.run(
+                    all_files=True,
+                    stage=options.stage,
+                )
 
             # Run commitizen hooks
             print(' ')

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/cli/main.py

@@ -168,11 +168,20 @@ def main() -> None:
         help='Use configurations from a specific folder',
     )
     subgroup.add_argument(
+        '-D',
         '--default',
         dest='default',
         action='store_true',
         help='Use global default configurations instead of sources',
     )
+    group.add_argument(
+        '--stage',
+        dest='stage',
+        action='store',
+        metavar='STAGE',
+        help='Run a specific pre-commit stage with --run\n' \
+             '(use \'list\' to list supported stages)',
+    )
 
     # Arguments positional definitions
     group = parser.add_argument_group('positional arguments')

pre_commit_crocodile-3.1.0/src/features/gcil.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from pathlib import Path
+from re import search
+from typing import List
+
+# Components
+from ..features.precommit import PreCommit
+from ..prints.colors import Colors
+from ..system.commands import Commands
+from ..system.platform import Platform
+
+# Gcil class
+class Gcil:
+
+    # Constants
+    BADGE_IMAGE: str = 'https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab'
+    BADGE_URL: str = 'https://radiandevcore.gitlab.io/tools/gcil'
+    BADGE_TEXT: str = 'gcil'
+    BINARY: str = 'gcil'
+    FILE: str = '.gitlab-ci.yml'
+    HOOK_DESCRIPTION: str = 'Automatically run GitLab CI job with gcil'
+    HOOK_ID: str = 'run-gcil-push'
+    HOOK_NAME: str = 'Run GitLab CI job with gcil'
+    HOOKS_LABEL: str = 'gcil'
+    HOOKS_URL: str = 'https://gitlab.com/RadianDevCore/tools/gcil'
+    HOOKS_VERSION_MINIMAL: str = '10.2.0'
+    MARKER_NODE: str = '.local:'
+    MARKER_VARIABLE: str = 'CI_LOCAL'
+
+    # Jobs
+    JOBS_WHITELIST: List[str] = [
+        r'codestyle[:]?.*',
+        r'lint[:]?.*',
+        r'typings[:]?.*',
+    ]
+
+    # Configure unused hooks, pylint: disable=too-many-branches,too-many-statements
+    @staticmethod
+    def configure_hooks(configuration_file: str = PreCommit.CONFIGURATION_FILE) -> bool:
+
+        # Validate gcil support
+        if not Gcil.exists() or not Gcil.installed():
+            return False
+
+        # Validate pre-commit support
+        if not Path(configuration_file).exists():
+            return False # pragma: no cover
+
+        # Configure pre-commit unused hooks
+        print(' ')
+        print(f'{Colors.BOLD} - Configure sources: '
+              f'{Colors.YELLOW_LIGHT}run-gcil-push'
+              f'{Colors.RESET}')
+        print(' ')
+
+        # Detect supported jobs
+        jobs_list: List[str] = Gcil.jobs_list()
+        jobs_supported: List[str] = []
+        for job in jobs_list:
+            if any(search(fr'^{whitelist}$', job) for whitelist in Gcil.JOBS_WHITELIST):
+                jobs_supported += [job]
+
+        # Show supported jobs hooks
+        print(
+            f'detected supported jobs hooks in configuration: {", ".join(jobs_supported) or "-"}'
+        )
+        Platform.flush()
+
+        # Append hooks configuration
+        if jobs_supported:
+            with open(
+                    configuration_file,
+                    encoding='utf8',
+                    mode='a',
+            ) as file:
+
+                # Inject repository header
+                file.write(
+                    PreCommit.CONFIGURATION_EOL.join([
+                        '',
+                        f'  # Repository: {Gcil.HOOKS_LABEL}',
+                        f'  - repo: {Gcil.HOOKS_URL}',
+                        f'    rev: {Gcil.HOOKS_VERSION_MINIMAL}',
+                        '    hooks:',
+                        '',
+                    ]))
+
+                # Inject repository hooks
+                for job in jobs_supported:
+                    file.write(
+                        PreCommit.CONFIGURATION_EOL.join([
+                            f'      - id: {Gcil.HOOK_ID}',
+                            f'        name: {Gcil.HOOK_NAME} ({job})',
+                            f'        description: {Gcil.HOOK_DESCRIPTION} ({job})',
+                            '        args:',
+                            f"          - '{job}'",
+                            '',
+                        ]))
+
+            # Autoupdate repository
+            print(f'updating {Gcil.HOOKS_LABEL} repository with pre-commit: ', end='')
+            Platform.flush()
+            PreCommit.autoupdate(Gcil.HOOKS_URL)
+            Platform.flush()
+
+        # Result
+        return True
+
+    # Configured
+    @staticmethod
+    def configured() -> bool:
+
+        # Ignore missing file
+        if not Gcil.exists():
+            return False
+
+        # Detect gcil configurations
+        return Commands.grep(
+            Path(Gcil.FILE),
+            Gcil.MARKER_NODE,
+        ) or Commands.grep(
+            Path(Gcil.FILE),
+            Gcil.MARKER_VARIABLE,
+        )
+
+    # Jobs list
+    @staticmethod
+    def jobs_list() -> List[str]:
+
+        # Validate gcil support
+        if not Gcil.exists() or not Gcil.installed():
+            return []
+
+        # Dump jobs configuration
+        gcil_dump: str = Commands.output(Gcil.BINARY, [
+            '--dump',
+        ])
+        if not gcil_dump or gcil_dump == '{}':
+            return []
+
+        # Extract job names
+        jobs: List[str] = []
+        for line in [
+                line for line in gcil_dump.splitlines()
+                if line.strip() and not line.startswith(' ')
+        ]:
+            job: str = line.strip().rstrip(':')
+            if not job.startswith('.'):
+                jobs += [job]
+
+        # Result
+        return jobs
+
+    # Exists
+    @staticmethod
+    def exists() -> bool:
+
+        # Check if configuration exists
+        return Path(Gcil.FILE).exists()
+
+    # Installed
+    @staticmethod
+    def installed() -> bool:
+
+        # Check installed gcil
+        return Commands.exists(Gcil.BINARY)

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/features/git.py

@@ -56,9 +56,9 @@ class Git:
         # Show git status
         return Commands.run(Git.BINARY, [
             'status',
-        ] + [
+        ] + ([
             '--untracked-files',
-        ] if untracked else [])
+        ] if untracked else []))
 
     # Update remote head
     @staticmethod

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/features/precommit.py

@@ -15,6 +15,7 @@ class PreCommit:
 
     # Constants
     BINARY: str = 'pre-commit'
+    CONFIGURATION_EOL: str = '\n'
     CONFIGURATION_EXTENSION: str = '.yaml'
     CONFIGURATION_FILE: str = '.pre-commit-config.yaml'
     HOOKS_APPLY_ERROR: str = ' does not apply to this repository'
@@ -26,12 +27,15 @@ class PreCommit:
 
     # Autoupdate
     @staticmethod
-    def autoupdate() -> bool:
+    def autoupdate(repo: str = '') -> bool:
 
         # Clean pre-commit
         return Commands.run(PreCommit.BINARY, [
             'autoupdate',
-        ] + PreCommit.__flags_configuration)
+        ] + PreCommit.__flags_configuration + ([
+            '--repo',
+            repo,
+        ] if repo else []))
 
     # Clean
     @staticmethod
@@ -47,7 +51,7 @@ class PreCommit:
     def configure_unused_hooks(
         default: bool,
         configuration_file: str = CONFIGURATION_FILE,
-    ) -> None:
+    ) -> bool:
 
         # Variables
         configuration_moved: bool = False
@@ -145,6 +149,9 @@ class PreCommit:
                     else:
                         f.write(line)
 
+        # Result
+        return True
+
     # Dependencies
     @staticmethod
     def dependencies() -> bool:
@@ -182,14 +189,17 @@ class PreCommit:
 
     # Run
     @staticmethod
-    def run(all_files: bool) -> bool:
+    def run(all_files: bool, stage: str = '') -> bool:
 
         # Run commitizen hooks
         return Commands.run(PreCommit.BINARY, [
             'run',
-        ] + PreCommit.__flags_configuration + [
+        ] + PreCommit.__flags_configuration + ([
             '--all-files',
-        ] if all_files else [])
+        ] if all_files else []) + ([
+            '--hook-stage',
+            stage,
+        ] if stage else []))
 
     # Set configuration
     @staticmethod
@@ -204,6 +214,31 @@ class PreCommit:
         else:
             PreCommit.__flags_configuration = []
 
+    # Stages
+    @staticmethod
+    def stages() -> List[str]:
+
+        # Variables
+        hooks_stages: List[str] = []
+
+        # Validate pre-commit
+        if not PreCommit.exists():
+            return hooks_stages # pragma: no cover
+
+        # Get pre-commit run help
+        for line in Commands.output(PreCommit.BINARY, [
+                'run',
+                '--help',
+        ]).splitlines():
+
+            # Parse hooks stages
+            if ' --hook-stage' in line:
+                hooks_stages = line[line.index('{') + 1:line.index('}')].split(',')
+                break
+
+        # Result
+        return hooks_stages
+
     # Uninstall
     @staticmethod
     def uninstall() -> bool:

{pre_commit_crocodile-3.0.0 → pre_commit_crocodile-3.1.0}/src/hooks/configurations.py

@@ -278,6 +278,17 @@ CHANGES_MATCHERS: List[ChangesMatcher] = [
             ),
         ],
     ),
+    ChangesMatcher(
+        commit_scope='sonar',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'^sonar-project.properties$',
+                ],
+            ),
+        ],
+    ),
     ChangesMatcher(
         commit_scope='vscode',
         types=[