pre-commit-crocodile 2.0.0

Git hooks intended for developers using pre-commit

pre-commit-crocodile

Git hooks intended for developers using pre-commit.

Documentation: https://radiandevcore.gitlab.io/tools/pre-commit-crocodile

---

Features

pre-commit-crocodile uses the following features:

• CLI - pre-commit: Automated Git hooks before commits and upon pushes
• CLI - commitizen: Commits tools and validation based upon conventional commits
• Hooks - pre-commit-hooks: Common pre-commit hooks useful for developers
• Hooks - prepare-commit-msg: Prepare commit message automatically based on changes

---

Preview

---

Usage

usage: pre-commit-crocodile [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL]
                            [-l | -i | -c | -e | -d | -a | -r] [--]

pre-commit-crocodile: Git hooks intended for developers using pre-commit

internal arguments:
  -h, --help           # Show this help message
  --version            # Show the current version
  --no-color           # Disable colors outputs with 'NO_COLOR=1'
                       # (or default settings: [themes] > no_color)
  --update-check       # Check for newer package updates
  --settings           # Show the current settings path and contents
  --set GROUP KEY VAL  # Set settings specific 'VAL' value to [GROUP] > KEY
                       # or unset by using 'UNSET' as 'VAL'

modes arguments:
  -l, --list           # List Git hooks installed in sources
  -i, --install        # Install dependencies for pre-commit hooks
  -c, --configure      # Update sources with hooks configurations
  -e, --enable         # Enable pre-commit hooks
  -d, --disable        # Disable pre-commit hooks
  -a, --autoupdate     # Autoupdate pre-commit hooks
  -r, --run            # Run pre-commit hooks

positional arguments:
  --                   # Positional arguments separator (recommended)

---

Installation

{
  # Option 1: If using pipx
  if type pipx >/dev/null 2>&1; then
    pipx ensurepath
    pipx install pre-commit-crocodile
    pipx upgrade pre-commit-crocodile

  # Option 2: If using pip
  else
    sudo pip3 install pre-commit-crocodile
  fi
}

---

Projects without configurations |

Import configurations

{
  # Disable hooks
  pre-commit-crocodile --configure
}

---

Projects with configurations |

Install dependencies

{
  # Install dependencies
  pre-commit-crocodile --install
}

Enable hooks

{
  # Enable hooks
  pre-commit-crocodile --enable
}

Run hooks

{
  # Manually run hooks
  pre-commit-crocodile --run
}

Update hooks

{
  # Autoupdate hooks
  pre-commit-crocodile --autoupdate
}

Disable hooks

{
  # Disable hooks
  pre-commit-crocodile --disable
}

---

Dependencies

• colored: Terminal colors and styles
• commitizen: Simple commit conventions for internet citizens
• pre-commit: A framework for managing and maintaining pre-commit hooks
• pre-commit-crocodile: Git hooks intended for developers using pre-commit
• setuptools: Build and manage Python packages
• update-checker: Check for package updates on PyPI

---

References

• .gitlab-ci.yml: GitLab CI/CD Pipeline Configuration Reference
• conventionalcommits: Conventional Commits specification for commit messages
• gcil: Launch .gitlab-ci.yml jobs locally
• git-cliff: CHANGELOG generator
• gitlab-release: Utility for publishing on GitLab
• mypy: Optional static typing for Python
• pexpect-executor: Automate interactive CLI tools actions
• PyPI: The Python Package Index
• termtosvg: Record terminal sessions as SVG animations
• twine: Utility for publishing on PyPI