pre-commit

What

pre-commit is a wrapper for git hook scripts that are useful for identifying simple issues before submission to code review. Git hooks are run on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements and integrate with a variety of third-party tooling.

Why

Eliminates the effort of initializing and managing git hooks locally. pre-commit also integrates with a large range of (hooks)[https://pre-commit.com/hooks.html] enabling a consistent developer experience.

How

A .pre-commit-config.yaml config file is configured with common and useful hoooks. This is available at the root of your repository. Each time you make a commit the pre-commit hooks run. If a hook supports applying auto-fixes (e.g: hook trailing-whitespace support fixing trailing whitespaces), it will proceed to fix it. Any detected failures will abort the commit.

Tip

See supported hooks here.

CI setup

Summary

No configuration required.

All hooks in .pre-commit-config.yaml will be executed via the pre-commit Github workflow in .github/workflows/pre-commit.yml.

Local setup

pip install -u pre-commit

For more installtion options see here.

Install the hooks configured in .pre-commit-config.yaml:

pre-commit install

Running against all files instead of only stages files:

pre-commit run --all-files

FAQ

1. Do I have to run pre-commit install everytime I clone a repository?

   Yes. However, you can automatically enable pre-commit to run when you clone a repository via this link.