Repository files navigation

Pre-commit hooks are tests that run each timeyou attempt to commit. If the tests pass, the commit will be made,otherwise not. A very basic test is to check if the code is parsable,making sure you have not forgotten a comma, brace or quote. You can runhooks locally and/or in the cloud:

• As a check before local commits: This requires installingpre-commit.

• As a CI check withhttps://pre-commit.ci: If you want to enforcepassing hooks on pull requests (and auto-fix trivial problems likestyling) even if the committer does not have a local installation.

The goal of this package is to twofold:

• Provide aset ofhooksthat are useful when your git repo contains R code.

• Provideusethis-likefunctionality for common tasks such as installation and set-up andconfig file modification.

For a more in-depth explanation and even more reasons, seevignette("why-use-hooks").

The following online docs are available:

• latest CRAN release.

• GitHub developmentversion.

• UseR 2022 talk on pre-commit forR

These only cover the functionality added on top of the pre-commitframework by this package. Everything else is covered in the extensiveonline documentation of the pre-commitframework itself, including how to create hooks for actions likegit push orgit checkout, create local hooks etc.