Add .lintr to .Rbuildignore in use_lintr() (#2926)

Author: Bisaloo

DESCRIPTION

@@ -35,6 +35,7 @@ Imports:
     rex,
     stats,
     utils,
+    xfun,
     xml2 (>= 1.0.0),
     xmlparsedata (>= 1.0.5)
 Suggests:
@@ -51,7 +52,7 @@ Suggests:
     withr (>= 2.5.0)
 Enhances:
     data.table
-VignetteBuilder: 
+VignetteBuilder:
     knitr
 Config/Needs/website: tidyverse/tidytemplate
 Config/Needs/development: pkgload, testthat, patrick

NEWS.md

@@ -48,6 +48,7 @@
 * `object_usage_linter()` lints missing packages that may cause false positives (#2872, @AshesITR)
 * New argument `include_s4_slots` for the `xml_find_function_calls()` entry in the `get_source_expressions()` to govern whether calls of the form `s4Obj@fun()` are included in the result (#2820, @MichaelChirico).
 * `sprintf_linter()` lints `sprintf()` and `gettextf()` calls when a constant string is passed to `fmt` (#2894, @Bisaloo).
+* `use_lintr()` adds the created `.lintr` file to the `.Rbuildignore` if run in a package (#2926, initial work by @MEO265, finalized by @Bisaloo).
 
 ### New linters
 

R/use_lintr.R

@@ -42,5 +42,32 @@ use_lintr <- function(path = ".", type = c("tidyverse", "full")) {
     )
   )
   write.dcf(the_config, config_file, width = Inf)
+
+  pkg_path <- find_package(path)
+
+  if (is.null(pkg_path)) {
+    return(invisible(config_file))
+  }
+
+  rbuildignore_path <- file.path(pkg_path, ".Rbuildignore")
+  rel_path <- xfun::relative_path(config_file, pkg_path)
+  escaped_config_path <- rex::rex(start, rel_path, end)
+
+  if (!file.exists(rbuildignore_path)) {
+    writeLines(escaped_config_path, rbuildignore_path)
+    cli_inform("Added {.val {escaped_config_path}} to {.code .Rbuildignore}.")
+    return(invisible(config_file))
+  }
+
+  ignored <- readLines(rbuildignore_path, warn = FALSE)
+
+  if (escaped_config_path %in% ignored) {
+    cli_inform("Configuration file {.val {escaped_config_path}} is already ignored in {.code .Rbuildignore}.")
+    return(invisible(config_file))
+  }
+
+  writeLines(c(ignored, escaped_config_path), rbuildignore_path)
+  cli_inform("Added {.val {escaped_config_path}} to {.code .Rbuildignore}.")
+
   invisible(config_file)
 }

tests/testthat/test-use_lintr.R

@@ -36,3 +36,57 @@ test_that("use_lintr with type = full also works", {
   lints <- lint_dir(tmp)
   expect_length(lints, 0L)
 })
+
+test_that("No .Rbuildignore is created of packages", {
+  tmp <- withr::local_tempdir()
+
+  lintr_file <- use_lintr(path = tmp, type = "full")
+  expect_false(file.exists(file.path(tmp, ".Rbuildignore")))
+})
+
+test_that("No .Rbuildignore is filled outside of packages", {
+  tmp <- withr::local_tempdir()
+  ignore_path <- file.path(tmp, ".Rbuildignore")
+  file.create(ignore_path)
+
+  lintr_file <- use_lintr(path = tmp, type = "full")
+  expect_identical(readLines(ignore_path), character())
+})
+
+test_that("No .Rbuildignore is filled if pattern already present", {
+  tmp <- withr::local_tempdir()
+  writeLines(
+    "Package: test",
+    file.path(tmp, "DESCRIPTION")
+  )
+  ignore_path <- file.path(tmp, ".Rbuildignore")
+  ignore <- c("^fu$", "^\\.lintr$", "^bar$")
+  writeLines(
+    ignore,
+    ignore_path
+  )
+
+  lintr_file <- use_lintr(path = tmp, type = "full")
+  expect_identical(readLines(ignore_path), ignore)
+})
+
+test_that("use_lintr creates the correct regex", {
+  tmp <- withr::local_tempdir()
+  writeLines(
+    "Package: test",
+    file.path(tmp, "DESCRIPTION")
+  )
+  ignore_path <- file.path(tmp, ".Rbuildignore")
+  writeLines(
+    c("^fu$", "^bar$"),
+    ignore_path
+  )
+
+  expect_message(
+    {
+      lintr_file <- use_lintr(path = tmp, type = "full")
+    },
+    regexp = rex::rex("Added ^\\.lintr$ to `.Rbuildignore`")
+  )
+  expect_identical(readLines(ignore_path), c("^fu$", "^bar$", "^\\.lintr$"))
+})