/lintr

Static Code Analysis for R

Primary LanguageROtherNOASSERTION

lintr

R build status codecov.io CRAN_Status_Badge Join the chat at https://gitter.im/jimhester-lintr/Lobby

lintr provides static code analysis for R. It checks for adherence to a given style, identifying syntax errors and possible semantic issues, then reports them to you so you can take action. Watch lintr in action in the following animation:

lintr is complementary to the styler package which automatically restyles code, eliminating some of the problems that lintr can detect.

Installation

Install the stable version from CRAN:

install.packages("lintr")

Or the development version from GitHub:

devtools::install_github("r-lib/lintr")

Usage

# in a project:
lintr::use_lintr(type = "tidyverse")
usethis::use_github_action("lint-project")
lintr::lint_dir()

# in a package:
lintr::use_lintr(type = "tidyverse")
usethis::use_github_action("lint")
lintr::lint_package()

You can also run lintr during continuous integration or within your IDE or text editor. See vignette("continuous-integration") and vignette("editors") for more details.

Without further configuration, this will run the default linters. See vignette("lintr") to learn how to modify these defaults.