https://github.com/r-lib/lintr

Static Code Analysis for R
https://github.com/r-lib/lintr

linter r

Last synced: 2 days ago
JSON representation

Static Code Analysis for R

• Host: GitHub
• URL: https://github.com/r-lib/lintr
• Owner: r-lib
• License: other
• Created: 2014-09-28T02:48:15.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-12-09T03:31:47.000Z (3 days ago)
• Last Synced: 2024-12-09T05:35:27.374Z (3 days ago)
• Topics: linter, r
• Language: R
• Homepage: https://lintr.r-lib.org
• Size: 23 MB
• Stars: 1,205
• Watchers: 21
• Forks: 187
• Open Issues: 312
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: COPYING
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• awesome-ccamel - r-lib/lintr - Static Code Analysis for R (R)
• awesome-starred-test - r-lib/lintr - Static Code Analysis for R (R)
• jimsghstars - r-lib/lintr - Static Code Analysis for R (R)

README

        
# lintr

[![R build status](https://github.com/r-lib/lintr/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/lintr/actions)

[![codecov.io](https://codecov.io/gh/r-lib/lintr/branch/main/graphs/badge.svg)](https://app.codecov.io/gh/r-lib/lintr?branch=main)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/lintr)](https://cran.r-project.org/package=lintr)

[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)

`{lintr}` provides [static code analysis for R](https://en.wikipedia.org/wiki/Static_program_analysis). 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:

![](man/figures/demo.gif "lintr demo")

`{lintr}` is complementary to [the `{styler}` package](https://github.com/r-lib/styler) which automatically restyles code, eliminating some of the problems that `{lintr}` can detect.

## Installation

Install the stable version from CRAN:

```R

install.packages("lintr")

```

Or the development version from GitHub:

```R

# install.packages("remotes")

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

```

## Usage

And then you can create a configuration file and run selected linters:

```R

lintr::use_lintr(type = "tidyverse")

# in a project:

lintr::lint_dir()

# in a package:

lintr::lint_package()

```

To see a list of linters included for each configuration:

```R

# tidyverse (default)

names(lintr::linters_with_defaults())

# full

names(lintr::all_linters())

```

### Setting up GitHub Actions 

`{usethis}` provides helper functions to generate lint workflows for GitHub Actions:

```R

# in a project:

usethis::use_github_action("lint-project")

# in a package:

usethis::use_github_action("lint")

```

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](https://lintr.r-lib.org/reference/default_linters.html). See `vignette("lintr")` to learn how to modify these defaults.

## Code of Conduct

Please note that the lintr project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). By contributing to this project, you agree to abide by its terms.