Doc improvements - Githubissues

lorenzwalthert / precommit

pre-commit hooks for R projects

https://lorenzwalthert.github.io/precommit/

GNU General Public License v3.0

252 stars 48 forks source link

Doc improvements #370

Closed lorenzwalthert closed 2 years ago

lorenzwalthert commented 2 years ago

pre-commit vs other tools for formatting etc: https://github.com/r-lib/actions/pull/460#discussion_r785804269.
Other advantages pre-commit: No history convolution
unified config with other checks/hooks
isolated env (your local and remote styler version could differ)
less maintenance and less convolution of git history
not bound to GitHub, will be supported on other git clients.
Can use pre-commit without local installation -> pre-commit.ci only.

lorenzwalthert commented 2 years ago

ran locally before on CI (i.e. on git commit).
autofixes problems like styling.
not just styling, any hook can be easily implemented.
hooks from {precommit} are documented and extensively tested.
building on the shoulders of giants (pre-commit.com) and abstract away a lot of logic not specific to R hooks.

But of course it's not as flexible as Building your own GitHub actions from scratch, eg when it comes to controlling the environment, system libraries etc.