Make minor updates and tweaks to pre-commit setup#1384
Conversation
Setting `default_install_hook_types` makes it possible to tell people to simply run `pre-commit install` for installation, instead of having to supply the stage arguments.
These are based on experience with our other projects.
This makes it tailored for pytest tests.
This changes the message style so that they (hopefully) read more naturally.
Takes too long.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the pre-commit configuration (.pre-commit-config.yaml) and documentation (CONTRIBUTING.md) to simplify installation, refine hook names, and add new validation checks. Key changes include configuring default_install_hook_types so that a simple pre-commit install sets up all hooks, updating hook descriptions to be declarative, and adding new hooks like config-file-validator and validate-pyproject. Feedback on these changes highlights portability issues on Windows: specifically, using a local python hook with a bash script entry for shellcheck and overriding the check-jsonschema entry points with bash -c will both fail on Windows environments. The reviewer suggests using the official shellcheck-py hook and removing the unnecessary bash -c overrides to maintain cross-platform compatibility.
Gemini Code Assist had a good suggestion in review.
Put the two shell script checks together.
Gemini Code Assist correctly pointed out that the explicit bash command line is unnecessary.
arettig
left a comment
arettig
left a comment
There was a problem hiding this comment.
Looks good. Tested locally and I can confirm the new pre-commit setup installs and runs correctly. One minor nit/question below.
2 participants
This makes some minor updates and tweaks to
.pre-commit-config.yaml:Define the hook stages that should be installed, which simplifies the installation instructions to just
pre-commit installwithout having to list 3 separate stagesUse hadolint-py for the Docker hook instead of the previous hook; this one lets pre-commit automatically install a Python-wrapped installation of the hadolint program and saves the user from having to install hadolint manually.
Add
config-file-validatorhook.Remove the Markdown link checker hook because it took too long to run.
Add more common patterns to
exclude.Fix up some hooks
Update version hashes to latest versions as needed.
Change the style of the descriptions printed by pre-commit, to (hopefully) make them more natural.