TL;DR Pre-commit hooks are an essential tool for maintaining high code quality in software development, especially for R and Python projects. These hooks automatically run checks before each git commit, ensuring code standards are met and common issues are caught early.
Pre-commit Hooks for R and Python Projects
Pre-commit hooks run checks before code is committed. For R and Python projects, they are a practical way to catch formatting, linting, dependency and security issues early, before they reach a pull request.
The Power of Pre-commit Hooks
Pre-commit hooks are scripts that automatically run tasks such as code formatting, linting, and security checks before a commit is finalized in Git. By identifying issues early in the development cycle, these hooks save time that would otherwise be spent on manual reviews and corrections. They enforce consistent code style, enhance security, and elevate overall code quality.
Introducing Pre-commit.ci - GitHub
Alongside the pre-commit framework, there’s a powerful CI system designed specifically for these hooks: pre-commit.ci. This tool automatically runs all your pre-commit hooks on every GitHub pull request, which not only speeds up your checks but also ensures that errors are caught promptly before merging. Importantly, pre-commit.ci is always free for open-source repositories, providing essential support to the open-source community.
Setting Up Pre-commit Hooks for R
For R projects:
- Install the precommit package from CRAN using install.packages("precommit"). - Initiate precommit in your project using precommit::use_precommit(). For example the run creates a decent template of .pre-commit-config.yaml file.
- Configure your hooks in the .pre-commit-config.yaml file, including hooks like lintr or styler.
- Install the hooks with pre-commit install.
- Run hooks manually (optional): While pre-commit hooks automatically run on each commit, you can manually trigger them using bash pre-commit run --all-files . This can be done anytime to ensure all files are checked, though it’s usually not required since hooks will automatically activate with commits.
Setting Up Pre-commit Hooks for Python
To set up pre-commit hooks in a Python project, you’ll need to:
- Install Pre-commit using bash pip install pre-commit.
- Configure your hooks in a .pre-commit-config.yaml file. Please check out an example.
- Install the hooks with pre-commit install.
- Run hooks manually (optional): While pre-commit hooks automatically run on each commit, you can manually trigger them using bash pre-commit run --all-files. This command is useful for checking all files, especially before a major commit or merge, although it’s typically not necessary as the hooks trigger automatically.
The Impact of Pre-commit Hooks
Using pre-commit hooks in R and Python projects moves routine checks out of code review. That leaves reviewers more time for design, correctness and edge cases.
Conclusion
Pre-commit hooks are a small setup cost that pays back quickly. They keep basic quality checks consistent and reduce avoidable review noise.