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

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.1}/.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.1}/.gitlab-ci.yml

@@ -222,7 +222,7 @@ serve:
   script:
     # Prepare documentation
     - |
-      ls -1 ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
+      ls -1 ./.cz.yaml ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
       echo -n "${!}" >./docs/.cache/.serve.pid
       sleep 2
     # Generate documentation

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

@@ -1,5 +1,25 @@
 # Changelog
 
+<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.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.0.0
+Version: 2.0.1
 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.1/docs/preview.svg)
 
 ---
 

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.1}/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.1/docs/preview.svg)
 
 ---
 

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.1}/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.1}/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.1}/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/).
 
 ---
 

{pre_commit_crocodile-2.0.0 → pre_commit_crocodile-2.0.1}/docs/hooks.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.1}/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.0 → pre_commit_crocodile-2.0.1}/docs/prepare.sh

@@ -12,9 +12,8 @@ rm -f "${docs_path}/.cache/*.md"
 mkdir -p "${docs_path}/.cache/"
 cp -rfv "${docs_path}/"*.md "${docs_path}/.cache/"
 
-# Export index
+# Export usage
 cp -f "${root_path}/README.md" "${docs_path}/.cache/index.md"
-sed -i '/Documentation:/{ N; d; }' "${docs_path}/.cache/index.md"
 
 # Export commits
 {
@@ -24,10 +23,16 @@ sed -i '/Documentation:/{ N; d; }' "${docs_path}/.cache/index.md"
   cz info | sed \
     -e '1{ /^$/d }' \
     -e '/^</,$ { /^</ { s/^/```powershell\n/ }; ${ s/^/```/ } }' \
-    -e 's/^\([A-Za-z0-9 ]\{1,\}\): /**\1:** /g' \
-    -e "s/ '\([A-Za-z0-9:!]\{1,\}\)' / \`\1\` /g" \
-    -e "s/ \([A-Za-z0-9]\{1,\}\):\([ ,]\)/ \`\1:\`\2/g" \
-    -e 's/^\([^#]\{1,\}\)$/\1  /g'
+    -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 ''
@@ -38,34 +43,6 @@ sed -i '/Documentation:/{ N; d; }' "${docs_path}/.cache/index.md"
   echo '```'
 } >>"${docs_path}/.cache/commits.md"
 
-# Export configurations/commitizen
-{
-  echo ''
-  echo '---'
-  echo ''
-  echo '## Commitizen configurations'
-  echo ''
-  echo '**Sources / .cz.yaml:**'
-  echo ''
-  echo '```yaml'
-  cat "${root_path}/.cz.yaml"
-  echo '```'
-} >>"${docs_path}/.cache/commitizen.md"
-
-# Export configurations/pre-commit
-{
-  echo ''
-  echo '---'
-  echo ''
-  echo '## Commitizen configurations'
-  echo ''
-  echo '**Sources / .pre-commit-config.yaml:**'
-  echo ''
-  echo '```yaml'
-  cat "${root_path}/.pre-commit-config.yaml"
-  echo '```'
-} >>"${docs_path}/.cache/pre-commit.md"
-
 # Export about/changelog
 mkdir -p "${docs_path}/.cache/about/"
 cp -f "${root_path}/CHANGELOG.md" "${docs_path}/.cache/about/changelog.md"