Description
Check Code Style Painlessly.
Description
Infer the code style (which style rules are followed and which ones are not) from one package and use it to check another. This makes it easier to find and correct the most important problems first.
README.md
adaptalint
adaptalint
is a package to infer the code style from one package and use it to check another. This makes linting much less painful, since you don't need to do as much configuration, and makes it easy to compare your code quality to real examples.
This works by running lintr
on the first package to find all issues, to build up a picture of its style. Then when this style is applied to a second package, issues are ignored if they are common in the first package, since they are assumed to be acceptable.
Installation
You can install adaptalint
from github with:
# install.packages("devtools")
devtools::install_github("maxconway/adaptalint")
Example
# Downloading the source of this package
path <- workdir(clone("https://github.com/maxconway/adaptalint", tempfile()))
# And extracting the style
style_adaptalint <- extract_style(path)
# There are also some included pre-computed styles from popular packages
data("style_purrr")
# Check against this package against another to see how it measures up
a <- lint_with_style(package = path, style = style_purrr)
# Or check it against itself, highlighting only those lint errors that the package judges as important
a <- lint_with_style(package = path, style = style_adaptalint)