`use_lintr` adds .lintr to .Rbuildignore #2396

MEO265 · 2023-12-05T18:41:46Z

I know that a PR (#1895) already exists, but it doesn't seem to be moving forward anymore.

Please give me your opinion on whether information should be output or additional parameters should be added.

MEO265 · 2023-12-05T18:43:09Z

Here you can see how base R handles the .Rbuildignore:
https://github.com/wch/r-source/blob/1d4f7aa1dac427ea2213d1f7cd7b5c16e896af22/src/library/tools/R/build.R#L85-L87

AshesITR

Is there a test that can be added?

R/use_lintr.R

MEO265 · 2023-12-06T06:18:03Z

Is there a test that can be added?

Surely. I'll take care of that too. Just wanted to hear beforehand whether additional functionality would be desired. In order not to have to adapt the tests again and again.

R/use_lintr.R

codecov-commenter · 2023-12-07T17:14:45Z

Codecov Report

❌ Patch coverage is 91.30435% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 99.25%. Comparing base (1939058) to head (6bc6009).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
R/use_lintr.R	91.30%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2396      +/-   ##
==========================================
- Coverage   99.28%   99.25%   -0.03%     
==========================================
  Files         129      129              
  Lines        7266     7289      +23     
==========================================
+ Hits         7214     7235      +21     
- Misses         52       54       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

R/use_lintr.R

It runs locally on Windows, which surprises me

Some OS can only normalize a path if the associated file or folder exists

MEO265 · 2023-12-08T11:11:50Z

The code is a bit more complex than initially expected, but it should work now

AshesITR · 2023-12-08T21:21:19Z

R/use_lintr.R

+
+  if (file.exists(file.path(path, "DESCRIPTION"))) {
+    # Some OS can only normalize a path if the associated file or folder exists, so the path needs to be re-normalized
+    tryCatch({


I don't understand this part.
What do these systems return with normalizePath("foo", mustWork = FALSE) if foo doesn't exist?

AshesITR · 2023-12-08T21:23:02Z

R/use_lintr.R

+      pkg_path <- normalizePath(path, mustWork = TRUE, winslash = "/")
+      config_file <- normalizePath(file.path(path, lintr_option("linter_file")), mustWork = TRUE, winslash = "/")
+    }, error = function(e) {
+      stop("No entry could be added to the .Rbuildignore.", call. = FALSE)


This sounds like a warning is in order. The main side effect was caused at this point anyway.

AshesITR · 2023-12-08T21:24:51Z

R/use_lintr.R

+      # Skip a extra character for the leading `/`
+      rel_path <- substring(config_file, first = nchar(pkg_path) + 2L, last = nchar(config_file))
+      ignore_path <- file.path(pkg_path, ".Rbuildignore")
+      if (!file.exists(ignore_path)) file.create(ignore_path)


This branch can be a writeLines(..., ignore_path) with immediate return.

AshesITR · 2023-12-08T21:26:18Z

R/use_lintr.R

+      ignore <- tryCatch({
+        trimws(readLines(ignore_path))
+      }, warning = function(e) {
+        cat(file = ignore_path, "\n", append = TRUE)


Why are you silently fixing the missing terminal newline here?

AshesITR · 2023-12-08T21:27:58Z

R/use_lintr.R

+      already_ignored <-
+        any(vapply(ignore, FUN = grepl, x = rel_path, perl = TRUE, ignore.case = TRUE, FUN.VALUE = logical(1L)))
+      if (!already_ignored) {
+        cat(file = ignore_path, rex::rex(start, rel_path, end), sep = "\n", append = TRUE)


IINM the sep= is ignored because you only pass one entry into cat.

AshesITR · 2023-12-08T21:30:21Z

tests/testthat/test-use_lintr.R

+
+  expect_message({
+    lintr_file <- use_lintr(path = tmp, type = "full")
+  }, regexp = "Adding .* to .Rbuildignore")


Nit: the . in front of Rbuildignore matches any character.

AshesITR · 2023-12-08T21:30:53Z

NEWS.md

 * `unreachable_code_linter()` has an argument `allow_comment_regex` for customizing which "terminal" comments to exclude (#2327, @MichaelChirico). `# nolint end` comments are always excluded, as are {covr} exclusions (e.g. `# nocov end`) by default.
 * `format()` and `print()` methods for `lint` and `lints` classes get a new option `width` to control the printing width of lint messages (#1884, @MichaelChirico). The default is controlled by a new option `lintr.format_width`; if unset, no wrapping occurs (matching earlier behavior).

+


Superfluous change

AshesITR · 2023-12-08T21:31:47Z

R/use_lintr.R

 #' Use lintr in your project
 #'
-#' Create a minimal lintr config file as a starting point for customization
+#' Create a minimal lintr config file as a starting point for customization and add it to the .Rbuildignore


It should be add it to .Rbuildignore, without a "the". Same in other places.

MichaelChirico · 2025-02-13T21:11:02Z

With the new release, it would be good to get this up to date & ready to merge. Note that one important change is we've switched to using {cli} for signalling conditions.

Let us know if you need any help & thanks!

AshesITR · 2025-08-25T09:22:37Z

Closing (#2926 was merged)
Thank you for the initial effort!

feat: use_lintradds .lintr to .Rbuildignore

5d0f734

AshesITR reviewed Dec 5, 2023

View reviewed changes

R/use_lintr.R Outdated Show resolved Hide resolved

R/use_lintr.R Outdated Show resolved Hide resolved

R/use_lintr.R Outdated Show resolved Hide resolved

R/use_lintr.R Outdated Show resolved Hide resolved

MEO265 commented Dec 6, 2023

View reviewed changes

R/use_lintr.R Outdated Show resolved Hide resolved

MEO265 added 5 commits December 6, 2023 19:20

mnt: Fix linted code

fdb2307

mnt: Use rex for regex escaping

ee7c47c

feat: Only add to .Rbuildignore if package

7f538d0

feat: Handle .Rbuildignore w/o final new line

fb9e003

doc: Add to NEWS

8f9bb6f

fix: Accidentally deleted .lintr while testing

81c7761

AshesITR reviewed Dec 7, 2023

View reviewed changes

R/use_lintr.R Outdated Show resolved Hide resolved

MEO265 added 3 commits December 8, 2023 07:31

fix: Handle DESCRIPTION correctly

09a888a

test: Add new tests

25ada69

fix: Handle missing final new line

06f031a

MEO265 marked this pull request as ready for review December 8, 2023 06:45

Merge branch 'main' into feature/ignore_.lintr

dec9a9d

MEO265 marked this pull request as draft December 8, 2023 07:02

MEO265 added 8 commits December 8, 2023 08:02

Merge branch 'main' into feature/ignore_.lintr

c54980d

test: More robust tests

6cb1b49

debug: Test sub-functions in test

24624b9

debug: Test sub-functions in test II

302782e

debug: Test sub-functions in test III

bd56690

debug: Test sub-functions in test IV

1226e0c

It runs locally on Windows, which surprises me

debug: Test sub-functions in test V

88acd40

Some OS can only normalize a path if the associated file or folder exists

fix: Re-normalize path after creating files

9e9611b

MEO265 marked this pull request as ready for review December 8, 2023 11:11

MEO265 changed the title ~~feat: use_lintradds .lintr to .Rbuildignore~~ use_lintr adds .lintr to .Rbuildignore Dec 8, 2023

AshesITR reviewed Dec 8, 2023

View reviewed changes

Merge branch 'main' into feature/ignore_.lintr

6bc6009

Bisaloo mentioned this pull request Aug 18, 2025

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

Merged

AshesITR closed this Aug 25, 2025

		* `unreachable_code_linter()` has an argument `allow_comment_regex` for customizing which "terminal" comments to exclude (#2327, @MichaelChirico). `# nolint end` comments are always excluded, as are {covr} exclusions (e.g. `# nocov end`) by default.
		* `format()` and `print()` methods for `lint` and `lints` classes get a new option `width` to control the printing width of lint messages (#1884, @MichaelChirico). The default is controlled by a new option `lintr.format_width`; if unset, no wrapping occurs (matching earlier behavior).

use_lintr adds .lintr to .Rbuildignore #2396

use_lintr adds .lintr to .Rbuildignore #2396

Uh oh!

Conversation

MEO265 commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MEO265 commented Dec 5, 2023

Uh oh!

AshesITR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MEO265 commented Dec 6, 2023

Uh oh!

Uh oh!

codecov-commenter commented Dec 7, 2023 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

MEO265 commented Dec 8, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MichaelChirico commented Feb 13, 2025

Uh oh!

AshesITR commented Aug 25, 2025

Uh oh!

Uh oh!

`use_lintr` adds .lintr to .Rbuildignore #2396

`use_lintr` adds .lintr to .Rbuildignore #2396

MEO265 commented Dec 5, 2023 •

edited

Loading

codecov-commenter commented Dec 7, 2023 •

edited by codecov bot

Loading