Switch from pre-commit to Hatch scripts

[br3ndonland]

Description

Pre-commit runs Git hooks. It can run on different Git events like pre-push and can also easily run on CI (continuous integration) platforms like GitHub Actions. These pre-commit hooks are often related to code quality and help ensure code quality checks are continuously enforced.

While it is helpful for continuously running code quality checks, pre-commit has some downsides.

• pre-commit requires separate dependency versions and configuration in its own file .pre-commit-config.yaml, even when those dependencies are already configured in a Python requirements file like pyproject.toml (84b25bc).
• pre-commit requires separate file paths because it identifies files with Python regular expressions ("regexes") instead of globs like many other tools, and disregards file paths present in other configuration files. Translation between globs and regexes can be complicated and files can be unexpectedly excluded as a result.
• pre-commit commands sometimes have different behavior than the commands would have normally.
  • pre-commit hook ignores isort config pre-commit/pre-commit#1495
  • Difference between running mypy directly vs with pre-commit run -a pre-commit/pre-commit#1580
  • Mypy run in pre-commit ignores configuration excludes pre-commit/pre-commit#2967
  • Don't Error When No Files to Check as Pre-commit Hook streetsidesoftware/cspell-cli#52
  • Introduction of mutable latest tag broke pre-commit auto-updates streetsidesoftware/cspell-cli#170
• pre-commit issues are often not explained or fixed.
  • pre-commit/mirrors-mypy#83 (note that issues were disabled on this repo)
  • pre-commit/mirrors-prettier#29 (note that issues were disabled on this repo)
  • check-added-large-files IndexError in filter_lfs_files pre-commit/pre-commit-hooks#810
  • forbid-submodules hook fails pre-commit/pre-commit-hooks#835
  • Allow pyproject.toml to define pre-commit config pre-commit/pre-commit#2578
  • pyproject.toml (PEP 518) support PyCQA/flake8#234

Hatch scripts can replace pre-commit.

Changes

• Add Hatch scripts to replace pre-commit commands
  • check:
    • Black
    • Flake8
    • isort
    • Mypy
    • Prettier
    • CSpell
  • format:
    • Black
    • isort
    • Prettier
• Replace other pre-commit hooks where possible
  • Replace mixed-line-ending by adding * text=auto eol=lf to a .gitattributes file
• Update GitHub Actions workflows to run Hatch scripts
• Update docs for Hatch scripts
• Remove pre-commit from pyproject.toml
• Remove .pre-commit-config.yaml

Related

• Hatch docs: config - environments - scripts
• Pre-commit

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
inboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 13, 2023 0:04am

[ofek]

I find your writeups incredibly informative, thanks again!