pre-commit-crocodile 4.1.0__tar.gz → 4.2.1__tar.gz

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/.gitlab-ci.yml

@@ -1034,7 +1034,6 @@ pages:
 pdf:
   extends:
     - pages
-  stage: deploy
   artifacts:
     expire_in: 1 hour
     paths:

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/.pre-commit-config.yaml

@@ -63,6 +63,10 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
         args: ['--markdown-linebreak-ext=md']
+        exclude: >
+          (?x)(
+            .*.md$
+          )
 
   # Repository: pre-commit-hooks
   - repo: https://github.com/pre-commit/pygrep-hooks
@@ -111,7 +115,7 @@ repos:
 
   # Repository: gcil
   - repo: https://gitlab.com/RadianDevCore/tools/gcil
-    rev: 9db7ca21
+    rev: 10.2.0
     hooks:
       - id: run-gcil-push
         name: Run GitLab CI job with gcil (codestyle)

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/CHANGELOG.md

@@ -1,7 +1,36 @@
 # Changelog
 
+<a name="4.2.1"></a>
+## [4.2.1](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/4.2.0...4.2.1) (2025-05-31)
+
+### 🐛 Bug Fixes
+
+- **precommit:** fix mismatching excludes upon '--configure' ([039a2da](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/039a2da953da11f48e4fa505ddf32f38322b8d98))
+
+
+<a name="4.2.0"></a>
+## [4.2.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/4.1.0...4.2.0) (2025-05-31)
+
+### ✨ Features
+
+- **entrypoint:** avoid 'sleep' calls without user input TTY ([e3ecb29](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e3ecb29f87fbc505d8eec491733809cc56a8a8a6))
+- **pre-commit-config:** exclude '.md' files from 'trailing-whitespace' ([db98cc2](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/db98cc22984380e4f47f16b3f6cd425db98d57ad))
+
+### 🐛 Bug Fixes
+
+- **pre-commit:** fix empty hooks with 'hooks: []' upon '--configure' ([3ef9cbe](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/3ef9cbe3cebcc9627bd4510a519b13ce41cdfd89))
+
+### ⚙️ Cleanups
+
+- **pre-commit:** migrate to 'gcil' 10.2.0 ([257ec3a](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/257ec3ac7a0efcce32aa759c049a3977cc485537))
+
+### 🚀 CI
+
+- **gitlab-ci:** remove unrequired 'stage: deploy' in 'pdf' job ([e07a8f2](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e07a8f29b735772357cd1235d7d76a39345ec0f9))
+
+
 <a name="4.1.0"></a>
-## [4.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/4.0.0...4.1.0) (2025-05-30)
+## [4.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/4.0.0...4.1.0) (2025-05-31)
 
 ### ✨ Features
 

{pre_commit_crocodile-4.1.0/pre_commit_crocodile.egg-info → pre_commit_crocodile-4.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pre-commit-crocodile
-Version: 4.1.0
+Version: 4.2.1
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -88,7 +88,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/4.1.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/4.2.1/docs/preview.svg)
 
 ---
 

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/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/4.1.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/4.2.1/docs/preview.svg)
 
 ---
 

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1/pre_commit_crocodile.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pre-commit-crocodile
-Version: 4.1.0
+Version: 4.2.1
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -88,7 +88,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/4.1.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/4.2.1/docs/preview.svg)
 
 ---
 

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/src/assets/.pre-commit-config.yaml

@@ -63,6 +63,10 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
         args: ['--markdown-linebreak-ext=md']
+        exclude: >
+          (?x)(
+            .*.md$
+          )
 
   # Repository: pre-commit-hooks
   - repo: https://github.com/pre-commit/pygrep-hooks

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/src/cli/entrypoint.py

@@ -118,7 +118,8 @@ class Entrypoint:
                 print(' ')
                 Platform.flush()
                 Argcomplete.configure()
-                sleep(2)
+                if Platform.IS_TTY_STDIN:
+                    sleep(2)
 
             # Install commitizen completion
             if options.install and not Commitizen.configured():
@@ -130,7 +131,8 @@ class Entrypoint:
                 Platform.flush()
                 commitizen_file: str = Commitizen.configure()
                 print(f'commitizen completion enabled in: {commitizen_file}')
-                sleep(1)
+                if Platform.IS_TTY_STDIN:
+                    sleep(1)
 
         # Bind specific configurations
         if options.config:
@@ -190,6 +192,12 @@ class Entrypoint:
                 configuration_file=precommit_configuration.name,
             )
 
+            # Configure useless excludes
+            PreCommit.configure_useless_excludes(
+                default=options.default,
+                configuration_file=precommit_configuration.name,
+            )
+
             # Configre gcil hooks
             Gcil.configure_hooks(configuration_file=precommit_configuration.name)
 
@@ -222,11 +230,15 @@ class Entrypoint:
                         mode='w',
                 ) as f:
                     f.write(data)
-                    sleep(1)
+                    if Platform.IS_TTY_STDIN:
+                        sleep(1)
 
             # Configure unused hooks
             PreCommit.configure_unused_hooks(default=options.default)
 
+            # Configure useless excludes
+            PreCommit.configure_useless_excludes(default=options.default)
+
             # Configre gcil hooks
             Gcil.configure_hooks()
 
@@ -337,7 +349,8 @@ class Entrypoint:
                   f'{Colors.RESET}')
 
             # Delay user interactions
-            sleep(5)
+            if Platform.IS_TTY_STDIN:
+                sleep(5)
 
         # Configure badges
         elif options.badges and configurations_files:
@@ -363,7 +376,8 @@ class Entrypoint:
                   f'{Colors.RESET}')
 
             # Delay user interactions
-            sleep(5)
+            if Platform.IS_TTY_STDIN:
+                sleep(5)
 
         # Enable hooks
         if options.enable:

{pre_commit_crocodile-4.1.0 → pre_commit_crocodile-4.2.1}/src/features/precommit.py

@@ -3,7 +3,7 @@
 # Standard libraries
 from pathlib import Path
 from shutil import copyfile, move
-from typing import List
+from typing import Dict, List
 
 # Components
 from ..features.git import Git
@@ -19,6 +19,8 @@ class PreCommit:
     CONFIGURATION_EXTENSION: str = '.yaml'
     CONFIGURATION_FILE: str = '.pre-commit-config.yaml'
     HOOKS_APPLY_ERROR: str = ' does not apply to this repository'
+    HOOKS_EXCLUDE_DELIMITER: str = ' for '
+    HOOKS_EXCLUDE_ERROR: str = ' does not match any files'
     PACKAGE: str = 'pre-commit'
     REV_TEMPLATE: str = '{PACKAGE_REVISION}'
 
@@ -46,7 +48,7 @@ class PreCommit:
             'clean',
         ])
 
-    # Configure unused hooks, pylint: disable=too-many-branches,too-many-statements
+    # Configure unused hooks, pylint: disable=too-many-branches,too-many-locals,too-many-statements
     @staticmethod
     def configure_unused_hooks(
         default: bool,
@@ -57,9 +59,14 @@ class PreCommit:
         configuration_moved: bool = False
         configuration_tmp: bool = False
         data_lines: List[str]
-        hook_id: str
+        hook_id: str = '- id: '
         hook_offset: str
         hook_section: bool
+        hooks_element: str = 'hooks:'
+        hooks_empty_flag: Dict[int, bool]
+        hooks_ending: str
+        hooks_index: int
+        hooks_line: str
         hooks_unused: List[str] = []
 
         # Fake pre-commit configuration
@@ -118,36 +125,185 @@ class PreCommit:
 
         # Disable pre-commit unused hooks
         if hooks_unused:
+
+            # Parse pre-commit hooks
+            data_lines = []
+            hook_section = False
+            hooks_empty_flag = {}
+            hooks_index = -1
             with open(
                     configuration_file,
                     encoding='utf8',
                     mode='r',
             ) as f:
-                data_lines = f.readlines()
+                for line in f.readlines():
+                    line_stripped = line.strip()
+
+                    # Parse lines
+                    if not line_stripped:
+                        data_lines.append(line)
+                        hook_section = False
+                    elif line_stripped.startswith(hooks_element):
+                        hooks_index = len(data_lines)
+                        hooks_empty_flag[hooks_index] = True
+                        data_lines.append(line)
+                    elif any(
+                            line_stripped == f'{hook_id}{hook}' for hook in hooks_unused):
+                        data_lines.append(line.replace(hook_id, f'# {hook_id}'))
+                        hook_offset = line[0:line.find(hook_id)]
+                        hook_section = True
+                    elif line_stripped.startswith(hook_id):
+                        data_lines.append(line)
+                        if hooks_index != -1:
+                            hooks_empty_flag[hooks_index] = False
+                        hook_section = False
+                    elif hook_section:
+                        data_lines.append(f'{hook_offset}#   {line.lstrip()}')
+                    else:
+                        data_lines.append(line)
+                        hooks_index = -1
+
+            # Fix empty hooks
+            for index, empty in hooks_empty_flag.items():
+                if empty:
+                    hooks_line = data_lines[index]
+                    hooks_ending = hooks_line[len(hooks_line.rstrip('\r\n')):]
+                    data_lines[index] = hooks_line.rstrip('\r\n') + ' []' + hooks_ending
+
+            # Write pre-commit hooks
             with open(
                     configuration_file,
                     encoding='utf8',
                     mode='w',
             ) as f:
-                hook_section = False
-                hook_id = '- id: '
-                for line in data_lines:
+                f.writelines(data_lines)
+
+        # Result
+        return True
+
+    # Configure useless excludes
+    @staticmethod
+    def configure_useless_excludes(
+        default: bool,
+        configuration_file: str = CONFIGURATION_FILE,
+    ) -> bool:
+
+        # Variables
+        configuration_moved: bool = False
+        configuration_tmp: bool = False
+        data_lines: List[str]
+        hook_exclude: str = 'exclude: '
+        hook_id: str = '- id: '
+        hook_offset: str
+        hook_property: bool
+        hook_section: bool
+        hooks_unused: List[str] = []
+
+        # Fake pre-commit configuration
+        if default and configuration_file != PreCommit.CONFIGURATION_FILE:
+            if Path(PreCommit.CONFIGURATION_FILE).exists():
+                move(PreCommit.CONFIGURATION_FILE, f'{PreCommit.CONFIGURATION_FILE}.tmp')
+                configuration_moved = True
+            else:
+                configuration_tmp = True
+            copyfile(
+                configuration_file,
+                PreCommit.CONFIGURATION_FILE,
+            )
+
+        # Prestage pre-commit configuration
+        if not default or configuration_moved or configuration_tmp:
+            Commands.run(Git.BINARY, [
+                'add',
+                PreCommit.CONFIGURATION_FILE,
+            ])
+
+        # Configure pre-commit unused hooks
+        print(' ')
+        print(f'{Colors.BOLD} - Configure sources: '
+              f'{Colors.YELLOW_LIGHT}check-useless-excludes'
+              f'{Colors.RESET}')
+        print(' ')
+        for line in Commands.output(PreCommit.BINARY, [
+                'run',
+        ] + PreCommit.__flags_configuration + [
+                '--all-files',
+                'check-useless-excludes',
+        ]).splitlines():
+            if PreCommit.HOOKS_EXCLUDE_ERROR not in line:
+                continue
+            hooks_unused += [
+                line[line.find(PreCommit.HOOKS_EXCLUDE_DELIMITER) \
+                     + len(PreCommit.HOOKS_EXCLUDE_DELIMITER) \
+                     :line.find(PreCommit.HOOKS_EXCLUDE_ERROR)]
+            ]
+
+        # Cleanup fake pre-commit configuration
+        if configuration_moved or configuration_tmp:
+            Path(PreCommit.CONFIGURATION_FILE).unlink()
+
+        # Restore pre-commit configurations
+        if configuration_moved:
+            move(f'{PreCommit.CONFIGURATION_FILE}.tmp', PreCommit.CONFIGURATION_FILE)
+
+        # Reset pre-commit configuration
+        if not default or configuration_moved or configuration_tmp:
+            Commands.run(Git.BINARY, [
+                'reset',
+                'HEAD',
+                PreCommit.CONFIGURATION_FILE,
+            ])
+
+        # Show unused hooks
+        print(f'detected unused hooks in configuration: {", ".join(hooks_unused) or "-"}')
+
+        # Disable pre-commit unused hooks
+        if hooks_unused:
+
+            # Parse pre-commit hooks
+            data_lines = []
+            hook_property = False
+            hook_section = False
+            with open(
+                    configuration_file,
+                    encoding='utf8',
+                    mode='r',
+            ) as f:
+                for line in f.readlines():
                     line_stripped = line.strip()
+
+                    # Parse lines
                     if not line_stripped:
-                        f.write(line)
+                        data_lines.append(line)
+                        hook_property = False
                         hook_section = False
                     elif any(
                             line_stripped == f'{hook_id}{hook}' for hook in hooks_unused):
-                        f.write(line.replace(hook_id, f'# {hook_id}'))
+                        data_lines.append(line)
                         hook_offset = line[0:line.find(hook_id)]
+                        hook_property = False
                         hook_section = True
                     elif line_stripped.startswith(hook_id):
-                        f.write(line)
+                        data_lines.append(line)
+                        hook_property = False
                         hook_section = False
-                    elif hook_section:
-                        f.write(f'{hook_offset}#   {line.lstrip()}')
+                    elif hook_section and line_stripped.startswith(hook_exclude):
+                        data_lines.append(line.replace(hook_exclude, f'# {hook_exclude}'))
+                        hook_property = True
+                    elif hook_property and line.startswith(hook_offset + '  '):
+                        data_lines.append(
+                            f'{hook_offset}  # {line[len(hook_offset) + 2:]}')
                     else:
-                        f.write(line)
+                        data_lines.append(line)
+                        hook_property = False
+
+            # Write pre-commit hooks
+            with open(
+                    configuration_file,
+                    encoding='utf8',
+                    mode='w',
+            ) as f:
+                f.writelines(data_lines)
 
         # Result
         return True