API changes
style_transformers
that allows to specify a style guide like this: --'style_transformers=tidyverse_style(scope = "spaces")'
, which gives the user the flexibility to also specify arguments of the style guide. The argument --style_fun
is deprecated and will be removed in a future release. (#183).use_precommit()
should now work as expected (#185).Minor changes
precommit::uninstall_precommit()
now correctly removes ^\\.pre-commit-config.yaml$
from .Rbuildignore
and does not show a prompt (#199).Initial CRAN release. See https://lorenzwalthert.github.io/precommit/.
Major Changes
use_precommit()
gains new install_hooks = TRUE
parameter. Now all hook environments defined in yaml config are by default installed in advance. (#163)Breaking Changes
uninstall_precommit()
’s scope
argument value "global"
was renamed to "user"
.Major Changes
.pre-commit-config-config.yaml
for the spell check hook for easy manipulation. Also, additional patterns were excluded such as .sh
(#157).Minor Changes
DESCRIPTION
now links the pkgdown website in addition to the GitHub repo (#155)..Renviron
, .Rrofile
, .RData
, .feather
and .Rds
is now also excluded from the spell checking hook.Breaking Changes
A major API review was conducted to make the package ready for a CRAN submission in #152:
path_root
renamed to root
.root
now always defaults to here::here()
for consistency.config_source
was renamed to config_source
in use_precommit_config()
and use_precommit()
.use_precommit_config
’s argument force
gains a default value for consistency with use_config()
.use_precommit_config
’s argument verbose
now is in the same position as in use_config()
.Additional breaking changes are:
r-precommit
instead of r-reticulate
to avoid conflicts with other packages commonly installed in r-reticulate
(#147).spell-check
does no longer take the hook argument ignore-files
since this was inconsistent with the pre-commit framework. To exclude additional files, specify the exclude:
key in your .pre-commit-config.yaml
file. If you like to keep excluding the default files, make sure you include the default regex (#153).git diff --cached
contains roxygen comments (#151).Test release process.
use_precommit()
gains new argument config_source
to copy an existing config file into the repo at initialization. The argument defaults to options('precommit.config_source')
to make it easy for users to use their preferred hooks in every repo they initialize (#111).r-precommit
env if not existent before installing into it (#114)..pre-commit-config.yaml
includes hook to check files have a EOF blank line (#126).path_pre_commit_exec()
in favor of path_precommit_exec()
and adapt internals to replace pre_commit
with precommit
(#130).BREAKING: If you used precommit < 0.0.0.9017 (and if you choose a different installation strategy than precommit::install_precommit()), you can link your existing executable by setting the R option
precommit.executable` to the path where you stored the pre-commit executable.
Adding tools to work with hooks: install_precommit()
, use_precommit()
, uninstall_precommit()
, open_config()
and open_wordlist()
using conda environments on all platforms.
Make repo a fully R CMD CHECK compliant R package (includes moving hooks to inst/bin
from bin
.)
renamed repo from pre-commit-hooks to precommit.
added pkgdown website, restructured README.