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

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.2}/.cz.yaml

@@ -36,36 +36,36 @@ commitizen:
 
       ## Conventional Commits - Customized specification
 
-      The commit contains the following structural elements, to communicate
-      intent to the consumers of your library:
+      The commit contains the following structural elements:
 
       ### Commit type
 
-      fix: a commit of the type fix patches a bug in your codebase
-      (this correlates with PATCH in semantic versioning).
-
-      feat: a commit of the type feat introduces a new feature to the codebase
-      (this correlates with MINOR in semantic versioning).
-
-      Others: commit types other than fix: and feat: are allowed,
-      like chore:, docs:, style:, refactor:, perf:, test:, and others.
-
-      We also recommend improvement for commits that improve a current
-      implementation without adding a new feature or fixing a bug.
-
-      For temporary commits, start with 'wip' or 'WIP' to ignore commit validation.
+      - fix: Bug or issues fixes
+      - feat: New or extended feature
+      - chore: Changes to non-production code
+      - docs: Documentation only changes
+      - style: Cosmetic changes only (white-space, formatting, etc)
+      - refactor: Code changes that neither fix a bug nor add a feature
+      - perf: Code change that improve performance
+      - security: Changes resolve security related issues
+      - test: Adding missing or correcting existing tests
+      - build: Changes to the build system or dependencies (example: makefile, pip, docker)
+      - ci: Changes to CI configuration files and scripts (example: gitlab-ci)
+      - improvement: Changes that improve sources without any impact
+      - wip: Temporary commits meant for local developments and rebases
 
       ### Commit scope
 
       A scope has to be provided to a commit’s type, to provide additional contextual information,
       such as the changed file, the containing folder or a globally modified feature,
-      and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
+      and is contained within parenthesis, e.g. feat(parser): add ability to parse arrays.
 
       ### Commit breaking changes
 
       BREAKING CHANGE: A commit with '!' before the ':' or that has the text BREAKING CHANGE:
       at the beginning of its optional body or footer section introduces a breaking API change
       (correlating with MAJOR in semantic versioning).
+
       A BREAKING CHANGE can be part of commits of any type.
 
       ### Commit syntax
@@ -122,7 +122,7 @@ commitizen:
             name: 'test: Adding missing or correcting existing tests'
             key: t
           - value: build
-            name: 'build: Changes to the build system or dependencies _(example: makefile, pip, docker)'
+            name: 'build: Changes to the build system or dependencies (example: makefile, pip, docker)'
             key: b
           - value: ci
             name: 'ci: Changes to CI configuration files and scripts (example: gitlab-ci)'

{pre_commit_crocodile-2.0.0 → 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,7 +245,8 @@ serve:
   script:
     # Prepare documentation
     - |
-      ls -1 ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
+      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
     # Generate documentation
@@ -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.0 → pre_commit_crocodile-2.0.2}/CHANGELOG.md

@@ -1,5 +1,44 @@
 # 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)
+
+### ✨ Features
+
+- **commitizen:** refactor commits documentation and improve markdown ([10d1da9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/10d1da9cf8e6a957a63ab820b4aa36235130db37))
+
+### 📚 Documentation
+
+- **docs:** add 'commitizen' to the project main description ([effba2f](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/effba2fa32ad96e3373332fc143240eab36308c6))
+- **docs:** embed files directly using 'mkdocs' syntax '--8<-- "..."' ([a51755e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/a51755e1db63ea04d23d2f77af53f053687707fa))
+- **docs:** improve headers with links for configurations files ([565c92f](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/565c92f6151201c3bde104619f8c9f36442092ad))
+- **preview:** refresh SVG preview for version 2.0.1 ([50621dc](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/50621dc1eb74c6382d9865f02e4819f83b6a3b26))
+- **readme:** add 'Package' link in the 'README' documentation ([6238b85](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/6238b85d63fac17cd658c89c7af92def065f6a43))
+
+### 🚀 CI
+
+- **gitlab-ci:** watch for '.cz.yaml' in 'serve' job ([e1f8319](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e1f8319c6cb4b5530f9bd24bc08f4bf4e54216d6))
+
+
 <a name="2.0.0"></a>
 ## [2.0.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/1.1.0...2.0.0) (2024-08-21)
 

{pre_commit_crocodile-2.0.0/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.0
+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
@@ -44,9 +44,10 @@ Requires-Dist: update_checker>=0.18.0
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
 
-**Documentation:** <https://radiandevcore.gitlab.io/tools/pre-commit-crocodile>
+**Documentation:** <https://radiandevcore.gitlab.io/tools/pre-commit-crocodile>  
+**Package:** <https://pypi.org/project/pre-commit-crocodile/>
 
 ---
 
@@ -63,7 +64,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/).
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
 
 ---
 
@@ -130,10 +131,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -143,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.0 → pre_commit_crocodile-2.0.2}/README.md

@@ -12,9 +12,10 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
 
-**Documentation:** <https://radiandevcore.gitlab.io/tools/pre-commit-crocodile>
+**Documentation:** <https://radiandevcore.gitlab.io/tools/pre-commit-crocodile>  
+**Package:** <https://pypi.org/project/pre-commit-crocodile/>
 
 ---
 
@@ -31,7 +32,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/).
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.0/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.2/docs/preview.svg)
 
 ---
 
@@ -98,10 +99,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -111,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.0 → pre_commit_crocodile-2.0.2}/docs/commitizen.md

@@ -12,4 +12,12 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
+
+---
+
+## Configurations for [commitizen](https://commitizen-tools.github.io/commitizen/)
+
+```yaml title="Sources / .cz.yaml"
+--8<-- ".cz.yaml"
+```

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.2}/docs/commits.md

@@ -12,7 +12,7 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
 
 ---
 

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

@@ -12,7 +12,7 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
 
 ---
 
@@ -25,9 +25,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/).
 - **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.0 → pre_commit_crocodile-2.0.2}/docs/hooks.md

@@ -12,15 +12,13 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
 
 ---
 
 ## 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.0 → pre_commit_crocodile-2.0.2}/docs/pre-commit.md

@@ -12,4 +12,12 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
 [![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/).
+Git hooks intended for developers using [pre-commit](https://pre-commit.com/) and [commitizen](https://commitizen-tools.github.io/commitizen/).
+
+---
+
+## Configurations for [pre-commit](https://pre-commit.com/)
+
+```yaml title="Sources / .pre-commit-config.yaml"
+--8<-- ".pre-commit-config.yaml"
+```

pre_commit_crocodile-2.0.2/docs/prepare.sh

@@ -0,0 +1,68 @@
+#!/bin/sh
+
+# Configurations
+set -e
+
+# Variables
+docs_path=$(cd "$(dirname "${BASH_SOURCE:-${0}}")" && pwd -P)
+root_path="${docs_path%/*}"
+
+# Prepare cache
+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
+{
+  echo ''
+  echo '---'
+  echo ''
+  cz info | sed \
+    -e '1{ /^$/d }' \
+    -e '/^</,$ { /^</ { s/^/```powershell\n/ }; ${ s/^/```/ } }' \
+    -e 's/^\(- \)\{0,1\}\([a-z0-9 ]\{1,\}\): /\1**`\2`:** /g' \
+    -e '/^- /s/ \([Bb]uild\|[Bb]ug[s]*\|[Cc]osmetic\|CI\|[Dd]ocumentation\|[Ff]eature[s]*\|[Ff]ixe[s]*\|[Ii]mprove\|[Ii]ssue[s]*\|[Ll]ocal\|[Nn]either\|[Nn]on-production\|[Pp]erformance\|[Ss]ecurity\|[Tt]emporary\|[Tt]est[s]*\)/ **\1**/g' \
+    -e 's/\(A scope\|changed file\|modified feature\|within parenthesis\)/**\1**/g' \
+    -e 's/\(e.g.\) \([^.]*\)/\1 `\2`/g' \
+    -e 's/\(example:\) \([^)]*\)/**\1** `\2`/g' \
+    -e "s/\(BREAKING CHANGE[:]*\)/**\`\1\`**/g" \
+    -e 's/\(conventional commits\|semantic versioning\)/**\1**/g' \
+    -e "s/ '\([A-Za-z0-9:!]\{1,\}\)' / **\`\1\`** /g" \
+    -e 's/^\([^#]\{1,\}\)$/\1  /g' \
+    -e '/^[^#\[<]\{1\}[^`]\{1,\}/s/^/\&nbsp;\&nbsp;\&nbsp;\&nbsp; /g'
+  echo ''
+  echo '---'
+  echo ''
+  echo '## Commit example'
+  echo ''
+  echo '```ruby'
+  cz example
+  echo '```'
+} >>"${docs_path}/.cache/commits.md"
+
+# Export about/changelog
+mkdir -p "${docs_path}/.cache/about/"
+cp -f "${root_path}/CHANGELOG.md" "${docs_path}/.cache/about/changelog.md"
+
+# Export about/license
+{
+  echo '# License'
+  echo ''
+  echo '---'
+  echo ''
+  cat "${root_path}/LICENSE"
+} >"${docs_path}/.cache/about/license.md"
+
+# Show cache
+echo ' '
+ls -laR "${docs_path}/.cache/"
+echo ' '

{pre_commit_crocodile-2.0.0 → 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).\