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

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

@@ -70,6 +70,29 @@ changelog:
   rules:
     - if: $CI_LOCAL
 
+hooks:
+  stage: development
+  image: local:silent
+  script:
+    # Refresh configurations
+    - pre-commit-crocodile --configure
+    # Stash local changes
+    - echo ''
+    - echo ' [INFO] Use "s" to split hunks and "y" to remove changes you do not want, "n" otherwise'
+    - echo ''
+    - sleep 2
+    - git stash -p
+    # Stage changes
+    - git add -v ./.cz.yaml ./.pre-commit-config.yaml
+    # Enable hooks
+    - pre-commit-crocodile --enable
+    # Run hooks
+    - pre-commit-crocodile --run
+    # Reset changes
+    - git reset HEAD ./.cz.yaml ./.pre-commit-config.yaml
+  rules:
+    - if: $CI_LOCAL
+
 images:
   stage: development
   image: local:silent
@@ -156,7 +179,7 @@ preview:
     - project="${PWD}"
     - remote=$(git config --get remote.origin.url | sed 's#git@gitlab.com:#https://gitlab.com/#g')
     # Prepare package revision
-    - export DEBUG_REVISION_SHA=$(git rev-parse --short HEAD)
+    - export DEBUG_REVISION_SHA=$(git rev-parse --short origin/develop)
     # Create temporary sources
     - |
       sources=$(mktemp -d)
@@ -222,6 +245,7 @@ serve:
   script:
     # Prepare documentation
     - |
+      mkdir -p ./docs/.cache/
       ls -1 ./.cz.yaml ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
       echo -n "${!}" >./docs/.cache/.serve.pid
       sleep 2
@@ -667,6 +691,7 @@ pages:
     - sh ./docs/prepare.sh
     # Generate documentation
     - mkdocs build --clean --config-file ./mkdocs.yml --verbose
+  after_script:
     # Cleanup documentation
     - rm -rf ./docs/.cache
   artifacts:

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

@@ -1,5 +1,24 @@
 # Changelog
 
+<a name="2.0.2"></a>
+## [2.0.2](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.1...2.0.2) (2024-08-22)
+
+### 📚 Documentation
+
+- **components, hooks:** add file name headers for sources changes ([77cfb9b](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/77cfb9b4dc249e70811afc1161d4fefd170877e4))
+- **prepare:** bind 'preview.svg' image as a webpage asset ([2e214bd](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/2e214bdb63459c4265b035a6d86fe2e0ef69c1ef))
+- **preview:** add 'clear' calls before 'git add' sections ([8dd763c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8dd763c308e2319ea48c771fcb0abebdaa58f591))
+- **preview:** fix SVG preview for version 2.0.1 ([1d34359](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1d34359768b881efd1a6ee3a0ec9a17f9fac17be))
+- **readme:** remove '{ ... }' wrappers for single commands ([dd892d8](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/dd892d8233f304b4b24cf3475f6c24f2a1e1ce5d))
+- **readme:** simplify and cleanup commands documentation ([d2d3b38](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d2d3b38a87780524bcd56a41ca52b8276f633553))
+
+### 🚀 CI
+
+- **gitlab-ci:** create 'hooks' local job for maintenance ([df35dc9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/df35dc992f811dbd35981d59643c7d20b51d20c0))
+- **gitlab-ci:** prepare and remove '.cache' even upon failures ([f56f38e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f56f38e29e33877871ce1cc538e569374e1fa349))
+- **gitlab-ci:** use 'origin/develop' as hooks revision for 'preview' ([9c0c29c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9c0c29c353297c8ec21329ea3dfec3b1187c708a))
+
+
 <a name="2.0.1"></a>
 ## [2.0.1](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.0...2.0.1) (2024-08-21)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.0.1
+Version: 2.0.2
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -64,7 +64,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.1/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
 
 ---
 
@@ -131,10 +131,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -144,46 +141,31 @@ positional arguments:
 ### Install dependencies
 
 ```bash
-{
-  # Install dependencies
-  pre-commit-crocodile --install
-}
+pre-commit-crocodile --install
 ```
 
 ### Enable hooks
 
 ```bash
-{
-  # Enable hooks
-  pre-commit-crocodile --enable
-}
+pre-commit-crocodile --enable
 ```
 
 ### Run hooks
 
 ```bash
-{
-  # Manually run hooks
-  pre-commit-crocodile --run
-}
+pre-commit-crocodile --run
 ```
 
 ### Update hooks
 
 ```bash
-{
-  # Autoupdate hooks
-  pre-commit-crocodile --autoupdate
-}
+pre-commit-crocodile --autoupdate
 ```
 
 ### Disable hooks
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --disable
-}
+pre-commit-crocodile --disable
 ```
 
 ---

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

@@ -32,7 +32,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.1/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
 
 ---
 
@@ -99,10 +99,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -112,46 +109,31 @@ positional arguments:
 ### Install dependencies
 
 ```bash
-{
-  # Install dependencies
-  pre-commit-crocodile --install
-}
+pre-commit-crocodile --install
 ```
 
 ### Enable hooks
 
 ```bash
-{
-  # Enable hooks
-  pre-commit-crocodile --enable
-}
+pre-commit-crocodile --enable
 ```
 
 ### Run hooks
 
 ```bash
-{
-  # Manually run hooks
-  pre-commit-crocodile --run
-}
+pre-commit-crocodile --run
 ```
 
 ### Update hooks
 
 ```bash
-{
-  # Autoupdate hooks
-  pre-commit-crocodile --autoupdate
-}
+pre-commit-crocodile --autoupdate
 ```
 
 ### Disable hooks
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --disable
-}
+pre-commit-crocodile --disable
 ```
 
 ---

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

@@ -25,9 +25,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 - **Run pre-commit checks** on all files
 - **Deny `WIP` commits** on GitLab branches
 
-**Changes to `.gitlab-ci.yml` :**
-
-```yaml
+```yaml title="Sources / .gitlab-ci.yml"
 include:
   - component: gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commits@X.Y.Z # Adapt to latest release tag
     inputs:

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

@@ -18,9 +18,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Using pre-commit-crocodile hooks
 
-**Changes to `.pre-commit-config.yaml` :**
-
-```yaml
+```yaml title="Sources / .pre-commit-config.yaml"
 # pre-commit configurations
 default_install_hook_types:
   - prepare-commit-msg

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

@@ -12,8 +12,14 @@ rm -f "${docs_path}/.cache/*.md"
 mkdir -p "${docs_path}/.cache/"
 cp -rfv "${docs_path}/"*.md "${docs_path}/.cache/"
 
+# Export assets
+rm -rf "${docs_path}/.cache/assets/images"
+mkdir -p "${docs_path}/.cache/assets/images/"
+cp -f "${root_path}/docs/preview.svg" "${docs_path}/.cache/assets/images/"
+
 # Export usage
 cp -f "${root_path}/README.md" "${docs_path}/.cache/index.md"
+sed -i "s#\(\[.*\]\)(.*/docs/#\1(assets/images/#g" "${docs_path}/.cache/index.md"
 
 # Export commits
 {

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.0.2}/docs/preview.py

@@ -45,6 +45,11 @@ Executor('pre-commit-crocodile --run',
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add hooks changes
 Executor('git add -v ./.cz.yaml ./.pre-commit-config.yaml',
          delay_init=0.1, delay_prompt=1.0).\
@@ -57,6 +62,11 @@ Executor('git commit -m "chore(pre-commit): import \'pre-commit-crocodile\' conf
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add first changes
 Executor('git add -p ./docs/',
          delay_init=0.1, delay_press=0.2, delay_prompt=1.0).\
@@ -108,6 +118,11 @@ Executor('git show',
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add second changes
 Executor('git add -p ./src/',
          delay_init=0.1, delay_press=0.2, delay_prompt=1.0).\