pre-commit-crocodile 5.0.0__tar.gz → 5.1.0__tar.gz

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/.cz.yaml

@@ -144,7 +144,7 @@ commitizen:
         name: body
         message: 'Additional contextual message (Empty to skip) :'
         default: 'Issue: #...'
-        filter: 'multiple_line_breaker'
+        filter: 'break_multiple_line'
       - type: input
         name: footer
         message: 'Footer information and references (Empty to skip) :'

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/.gitignore

@@ -1,5 +1,6 @@
 # Assets intermediates
 src/assets/.cz.yaml
+src/assets/commits.yml
 
 # Build intermediates
 /build

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/.gitlab-ci.yml

@@ -13,6 +13,8 @@ stages:
   - deploy
 
 variables:
+  CI_LOCAL_REAL_PATHS: 'true'
+  CI_LOCAL_SOCKETS: 'true'
   EXECUTOR_HOST: preview
   EXECUTOR_TOOL: pre-commit-crocodile
   REGISTRY_HOST: registry.gitlab.com
@@ -21,9 +23,7 @@ variables:
 
 .local:
   no_regex: true
-  real_paths: true
-  sockets: true
-  version: 11.0
+  version: 12.0
   volumes:
     - ${HOME}/.docker/config.json:/root/.docker/config.json:ro
 

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+<a name="5.1.0"></a>
+## [5.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/5.0.0...5.1.0) (2025-06-09)
+
+### ✨ Features
+
+- **cli:** implement '--no-components' to import 'commits.yml' template ([c3a6999](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c3a6999908adbc4886dc2767938c8e32c3dbf6e9))
+- **gcil:** raise minimal 'gcil' version to 12.0.0 ([0ac2606](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/0ac26061767becf86d1b1e7c48b81fd676da3701))
+- **templates:** refactor '--no-components' with 'spec: inputs:' ([c2f7365](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c2f7365fb3eb9f29dc4eff575d48199ee67b10a2))
+
+### ⚙️ Cleanups
+
+- **cz:** migrate from 'multiple_line_breaker' to 'break_multiple_line' ([8068901](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8068901bb1811be110a0007b755367fb1bf62aef))
+
+### 🚀 CI
+
+- **gitlab-ci:** migrate to 'CI_LOCAL_*' variables with 'gcil' 12.0.0 ([e8cdad9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e8cdad9589f92e7a591313a0321b0529c9874d77))
+
+
 <a name="5.0.0"></a>
 ## [5.0.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/4.2.1...5.0.0) (2025-06-08)
 

{pre_commit_crocodile-5.0.0/pre_commit_crocodile.egg-info → pre_commit_crocodile-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pre-commit-crocodile
-Version: 5.0.0
+Version: 5.1.0
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -89,7 +89,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/5.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/5.1.0/docs/preview.svg)
 
 ---
 
@@ -102,8 +102,8 @@ 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 | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit] [--offline]
-                            [--stage STAGE] [--]
+                            [-l | -i | -c | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit]
+                            [--no-components] [--offline] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -132,6 +132,7 @@ configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
   -D, --default        # Use global default configurations instead of sources
   --commit             # Commit configurations changes automatically
+  --no-components      # Import components templates locally instead of 'include: component:'
   --offline            # Use offline mode to disable configurations autoupdate
   --stage STAGE        # Run a specific pre-commit stage with --run
                        # (use 'list' to list supported stages)

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/README.md

@@ -40,7 +40,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/5.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/5.1.0/docs/preview.svg)
 
 ---
 
@@ -53,8 +53,8 @@ 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 | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit] [--offline]
-                            [--stage STAGE] [--]
+                            [-l | -i | -c | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit]
+                            [--no-components] [--offline] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -83,6 +83,7 @@ configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
   -D, --default        # Use global default configurations instead of sources
   --commit             # Commit configurations changes automatically
+  --no-components      # Import components templates locally instead of 'include: component:'
   --offline            # Use offline mode to disable configurations autoupdate
   --stage STAGE        # Run a specific pre-commit stage with --run
                        # (use 'list' to list supported stages)

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0/pre_commit_crocodile.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pre-commit-crocodile
-Version: 5.0.0
+Version: 5.1.0
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -89,7 +89,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/5.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/5.1.0/docs/preview.svg)
 
 ---
 
@@ -102,8 +102,8 @@ 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 | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit] [--offline]
-                            [--stage STAGE] [--]
+                            [-l | -i | -c | -b | -e | -d | -a | -C | -r] [--config FOLDER | -D] [--commit]
+                            [--no-components] [--offline] [--stage STAGE] [--]
 
 pre-commit-crocodile: Git hooks intended for developers using pre-commit
 
@@ -132,6 +132,7 @@ configurations arguments:
   --config FOLDER      # Use configurations from a specific folder
   -D, --default        # Use global default configurations instead of sources
   --commit             # Commit configurations changes automatically
+  --no-components      # Import components templates locally instead of 'include: component:'
   --offline            # Use offline mode to disable configurations autoupdate
   --stage STAGE        # Run a specific pre-commit stage with --run
                        # (use 'list' to list supported stages)

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/pre_commit_crocodile.egg-info/SOURCES.txt

@@ -65,6 +65,7 @@ src/__main__.py
 src/assets/.cz.yaml
 src/assets/.pre-commit-config.yaml
 src/assets/__init__.py
+src/assets/commits.yml
 src/cli/__init__.py
 src/cli/entrypoint.py
 src/cli/main.py
@@ -76,6 +77,7 @@ src/features/git.py
 src/features/precommit.py
 src/features/radiandevcore.py
 src/features/readme.py
+src/features/templates.py
 src/hooks/__init__.py
 src/hooks/check_yaml_ruamel_pure.py
 src/hooks/configurations.py

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/setup.py

@@ -10,9 +10,11 @@ from setuptools import find_packages, setup
 # Assets importation
 for asset in [
         '.cz.yaml',
+        'templates/commits.yml',
 ]:
+
     # Import file to assets
-    copyfile(asset, f'src/assets/{asset}')
+    copyfile(asset, f'src/assets/{asset.rsplit("/", maxsplit=1)[-1]}')
 
 # Requirements
 requirements: List[str] = []

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/src/assets/.cz.yaml

@@ -144,7 +144,7 @@ commitizen:
         name: body
         message: 'Additional contextual message (Empty to skip) :'
         default: 'Issue: #...'
-        filter: 'multiple_line_breaker'
+        filter: 'break_multiple_line'
       - type: input
         name: footer
         message: 'Footer information and references (Empty to skip) :'

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/src/cli/entrypoint.py

@@ -18,6 +18,7 @@ from ..features.git import Git
 from ..features.precommit import PreCommit
 from ..features.radiandevcore import RadianDevCore
 from ..features.readme import Readme
+from ..features.templates import Templates
 from ..package.bundle import Bundle
 from ..package.version import Version
 from ..prints.colors import Colors
@@ -43,10 +44,14 @@ class Entrypoint:
     def cli(options: Namespace, ) -> Result:
 
         # Variables
+        asset: str
         command_add: List[str]
         command_commit: List[str]
         configurations_existed: bool = False
         configurations_files: List[str] = []
+        data: str
+        local_ci_data: str
+        local_template: str
 
         # List hooks
         if options.list:
@@ -238,18 +243,16 @@ class Entrypoint:
                   f'{Colors.RESET}')
             print(' ')
 
-            # List configurations files
-            configurations_files += [
-                Commitizen.CONFIGURATION_FILE,
-                PreCommit.CONFIGURATION_FILE,
-            ]
-
             # Export assets files
-            for asset in configurations_files:
+            for asset in [
+                    Commitizen.CONFIGURATION_FILE,
+                    PreCommit.CONFIGURATION_FILE,
+            ]:
                 if Path(asset).exists():
                     configurations_existed = True
                 print(f'exporting configuration in {asset} configuration')
-                data: str = resources_files(Bundle.RESOURCES_ASSETS) \
+                configurations_files += [asset]
+                data = resources_files(Bundle.RESOURCES_ASSETS) \
                     .joinpath(asset) \
                     .read_text(encoding='utf8') \
                     .replace(PreCommit.REV_TEMPLATE, Version.revision())
@@ -274,6 +277,66 @@ class Entrypoint:
                 autoupdate=not options.offline,
             )
 
+        # Export components templates
+        if options.configure and options.no_components:
+
+            # Install templates configurations
+            print(' ')
+            print(f'{Colors.GREEN} ===['
+                  f'{Colors.YELLOW} Configure sources: '
+                  f'{Colors.YELLOW_LIGHT}templates'
+                  f'{Colors.GREEN} ]==='
+                  f'{Colors.RESET}')
+            print(' ')
+
+            # Export templates files
+            for asset in [
+                    Templates.COMMITS_FILE,
+            ]:
+
+                # Export template file
+                print(f'exporting components in {asset} local template')
+                Path(Templates.GITLAB_CI_LOCAL_FOLDER).mkdir(
+                    parents=False,
+                    exist_ok=True,
+                )
+                local_template = f'{Templates.GITLAB_CI_LOCAL_FOLDER}/{asset}'
+                configurations_files += [local_template]
+                data = resources_files(Bundle.RESOURCES_ASSETS) \
+                    .joinpath(asset) \
+                    .read_text(encoding='utf8')
+                with open(
+                        local_template,
+                        encoding='utf8',
+                        mode='w',
+                ) as f:
+                    f.write(data)
+                    if Platform.IS_TTY_STDIN:
+                        sleep(1)
+
+                # Inject template in .gitlab-ci.yml
+                if Path(Gcil.FILE).exists():
+                    local_ci_data = ''
+                    with open(Gcil.FILE, encoding='utf8') as local_ci_file:
+                        local_ci_data = local_ci_file.read()
+                    if asset not in local_ci_data:
+                        with open(
+                                Gcil.FILE,
+                                encoding='utf8',
+                                mode='w',
+                        ) as f:
+                            f.write(
+                                Gcil.EOL.join([
+                                    'include:',
+                                    f'  - local: \'/{local_template}\'',
+                                    '    inputs:',
+                                    '      stage: test',
+                                    f'      name: {asset.rsplit("/", 1)[-1].split(".", 1)[0]}',
+                                    '',
+                                    '',
+                                ]))
+                            f.write(local_ci_data)
+
         # Configure sources or badges
         if options.configure or options.badges:
 

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/src/cli/main.py

@@ -187,6 +187,12 @@ def main() -> None:
         action='store_true',
         help='Commit configurations changes automatically',
     )
+    group.add_argument(
+        '--no-components',
+        dest='no_components',
+        action='store_true',
+        help='Import components templates locally instead of \'include: component:\'',
+    )
     group.add_argument(
         '--offline',
         dest='offline',

{pre_commit_crocodile-5.0.0 → pre_commit_crocodile-5.1.0}/src/features/gcil.py

@@ -19,13 +19,14 @@ class Gcil:
     BADGE_URL: str = 'https://radiandevcore.gitlab.io/tools/gcil'
     BADGE_TEXT: str = 'gcil'
     BINARY: str = 'gcil'
+    EOL: str = '\n'
     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'
+    HOOKS_VERSION_MINIMAL: str = '12.0.0'
     MARKER_NODE: str = '.local:'
     MARKER_VARIABLE: str = 'CI_LOCAL'
 

pre_commit_crocodile-5.1.0/src/features/templates.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+
+# Templates class, pylint: disable=too-few-public-methods
+class Templates:
+
+    # Constants
+    COMMITS_FILE: str = 'commits.yml'
+    GITLAB_CI_LOCAL_FOLDER: str = '.gitlab-ci.d'
+    TEMPLATES_EOL: str = '\n'

pre_commit_crocodile-5.1.0/templates/commits.yml

@@ -0,0 +1,97 @@
+spec:
+  inputs:
+    name:
+      default: commits
+      description: 'Defines the commits job name (Default: commits)'
+    stage:
+      default: test
+      description: 'Defines the commits stage (Default: test)'
+    image:
+      default: registry.gitlab.com/radiandevcore/tools/pre-commit-crocodile/pre-commit-crocodile:commits
+      description: 'Specify the commits image (Default: pre-commit-crocodile:commits public image)'
+---
+
+$[[ inputs.name ]]:
+  image: $[[ inputs.image ]]
+  stage: $[[ inputs.stage ]]
+  needs: []
+  variables:
+    GIT_SUBMODULE_STRATEGY: none
+  before_script:
+    # Check system context
+    - git cz --config ./.cz.yaml version -r
+    # Show commits documentation
+    - |
+      (
+        set +x
+        echo ' '
+        for hint in 'example:33' 'info:36' 'schema:32'; do
+          command="${hint%%:*}"
+          color="${hint##*:}"
+          echo '---'
+          echo "git cz ${command}:"
+          echo -e "\033[1;${color}m"
+          git cz --config ./.cz.yaml "${command}" | sed 's#^$# #g'
+          echo -e '\033[0m '
+        done
+        echo '---'
+      )
+  script:
+    # Detect commits range
+    - set +x
+    - remote=$(git remote -v | grep '(fetch)' | awk '{print $1}' | head -n1)
+    - none_sha='0000000000000000000000000000000000000000'
+    - head_sha=$(git rev-parse "${CI_COMMIT_SHA:-HEAD}")
+    - |
+      if [ ! -z "${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-}" ]; then
+        git fetch "${remote}" "${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}" || true
+        base_sha=$(git rev-parse "${remote}/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}")
+        base_branch=$(git rev-parse --abbrev-ref "${remote}/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}")
+        range_sha="${base_sha}..${head_sha}"
+      elif ! git log --pretty=%P -n1 'HEAD' | grep -q '.'; then
+        base_sha=$(git rev-parse 'HEAD')
+        base_branch=$(git rev-parse --abbrev-ref 'HEAD')
+        range_sha="${head_sha}"
+      elif [ ! -z "${CI_LOCAL:-}" ]; then
+        base_sha=$(git rev-parse "${remote}/HEAD")
+        base_branch=$(git rev-parse --abbrev-ref "${remote}/HEAD")
+        range_sha="${base_sha}..${head_sha}"
+      elif [ ! "${CI_COMMIT_BEFORE_SHA:-${none_sha}}" = "${none_sha}" ] && git cat-file -e "${CI_COMMIT_BEFORE_SHA}" 2>/dev/null; then
+        base_sha="${CI_COMMIT_BEFORE_SHA}"
+        base_branch="${CI_COMMIT_REF_NAME:-}"
+        range_sha="${base_sha}..${head_sha}"
+      else
+        base_sha=$(git rev-parse 'HEAD~1')
+        base_branch=$(git rev-parse --abbrev-ref 'HEAD')
+        range_sha="${base_sha}..${head_sha}"
+      fi
+    # Validate commits range
+    - |
+      set +x
+      echo ' '
+      echo '---'
+      echo -e "\033[0m\033[1mINFO: Commitizen checks from \033[1m'\033[1;36m${base_sha:0:8}\033[0m\033[1m' (\033[1;33m${base_branch}\033[0m\033[1m) to '\033[1;36m${head_sha:0:8}\033[0m\033[1m' (\033[1;33mHEAD\033[0m\033[1m)\033[0m"
+      echo ' '
+      git log --pretty=oneline --abbrev-commit "${range_sha}" | sed "s#^\([^ ]*\) #$(printf '\033[1;33m')\1$(printf '\033[0m') #g"
+      echo ' '
+      set -x
+      git cz --config ./.cz.yaml --no-raise 3 check --rev-range "${range_sha}"
+    # Validate pre-commit checks
+    - |
+      set +x
+      echo ' '
+      skip=$(grep 'id: run-gcil-' .pre-commit-config.yaml | sed 's/.* id: //g' | tr '\n' ',' | sed 's/,$//g' || true)
+      set -x
+      pre-commit install --install-hooks
+      SKIP="${skip}" pre-commit run --all-files --show-diff-on-failure
+    # Validate WIP commits
+    - |
+      set +x
+      if git log --pretty='%s' "${range_sha}" | grep -i '^WIP'; then
+        echo ' '
+        echo " [ERROR] Detected WIP commits in range '${range_sha}'"
+        echo ' '
+        false
+      fi
+  rules:
+    - when: always