also recognize lintr ignore markers

Author: lorenzwalthert

NEWS.md

@@ -1,6 +1,10 @@
 # styler 1.6.2.9000 (Development version)
 
 
+* multiple stylerignore patterns can be specified at once and lintr markers 
+  `# nolint`, `# nolint start` and `# nolint end` are now by default recognized
+  in addition to `# styler: off` and `# styler: on` (#849).
+
 # styler 1.6.2
 
 * clean up cache files older than one week (#842).

R/nest.R

@@ -159,20 +159,24 @@ find_pos_id_to_keep <- function(pd) {
 #' [detected by styler](https://styler.r-lib.org/articles/detect-alignment.html),
 #' making stylerignore redundant. See a few illustrative examples below.
 #' @details
-#' Styling is on by default when you run styler.
+#' Styling is on for all lines by default when you run styler.
 #'
 #' - To mark the start of a sequence where you want to turn styling off, use
-#'   `# styler: off`.
+#'   `# styler: off`. For styler version > 1.6.2, `# nolint` and `#nolint start`
+#'   also works by default.
 #' - To mark the end of this sequence, put `# styler: on` in your code. After
-#'   that line, styler will again format your code.
+#'   that line, styler will again format your code. For styler version > 1.6.2,
+#'   `#nolint end` also works by default.
 #' - To ignore an inline statement (i.e. just one line), place `# styler: off`
 #'   at the end of the line. Note that inline statements cannot contain other
 #'   comments apart from the marker, i.e. a line like
-#'   `1 # comment # styler: off` won't be ignored.
+#'   `1 # comment # styler: off` won't be ignored. For styler version > 1.6.2,
+#'   `# nolint` and `#nolint start` also works.
 #'
 #' To use something else as start and stop markers, set the R options
 #' `styler.ignore_start` and
-#' `styler.ignore_stop` using [options()]. If you want these
+#' `styler.ignore_stop` using [options()]. For styler version > 1.6.2, the
+#' option supports character vectors longer than one. If you want these
 #' settings to persist over multiple R sessions, consider setting them in your
 #' R profile, e.g. with `usethis::edit_rprofile()`.
 #' @name stylerignore

R/stylerignore.R

@@ -48,13 +48,13 @@ env_add_stylerignore <- function(pd_flat) {
 #'
 #' See examples in [stylerignore]. Note that you should reuse the stylerignore
 #' column to compute switch points or similar and not a plain
-#' `pd$text == option_read("styler.ignore_start")` because that will fail to
+#' `pd$text %in% option_read("styler.ignore_start")` because that will fail to
 #' give correct switch points in the case stylerignore sequences are invalid.
 #' @param pd_flat A parse table.
 #' @keywords internal
 add_stylerignore <- function(pd_flat) {
   parse_text <- trimws(pd_flat$text)
-  start_candidate <- parse_text == option_read("styler.ignore_start")
+  start_candidate <- parse_text %in% option_read("styler.ignore_start")
   pd_flat$stylerignore <- rep(FALSE, length(start_candidate))
   env_current$any_stylerignore <- any(start_candidate)
   if (!env_current$any_stylerignore) {
@@ -64,7 +64,7 @@ add_stylerignore <- function(pd_flat) {
   pd_flat_lat_line1 <- lag(pd_flat$line2, default = 0)
   on_same_line <- pd_flat$line1 == pd_flat_lat_line1
   cumsum_start <- cumsum(start_candidate & !on_same_line)
-  cumsum_stop <- cumsum(parse_text == option_read("styler.ignore_stop"))
+  cumsum_stop <- cumsum(parse_text %in% option_read("styler.ignore_stop"))
   pd_flat$indicator_off <- cumsum_start + cumsum_stop
   is_invalid <- cumsum_start - cumsum_stop < 0 | cumsum_start - cumsum_stop > 1
   if (any(is_invalid)) {
@@ -105,7 +105,7 @@ apply_stylerignore <- function(flattened_pd) {
   colnames_required_apply_stylerignore <- c(
     "pos_id_", "lag_newlines", "lag_spaces", "text", "first_pos_id_in_segment"
   )
-  # cannot rely on flattened_pd$text == option_read("styler.ignore_start")
+  # cannot rely on flattened_pd$text %in% option_read("styler.ignore_start")
   # because if the marker logic is not correct (twice off in a row), we'll
   # get it wrong.
   to_ignore <- flattened_pd$stylerignore == TRUE

R/zzz.R

@@ -5,8 +5,8 @@
     styler.addins_style_transformer = "styler::tidyverse_style()",
     styler.cache_name = styler_version,
     styler.colored_print.vertical = TRUE,
-    styler.ignore_start = "# styler: off",
-    styler.ignore_stop = "# styler: on",
+    styler.ignore_start = c("# styler: off", "# nolint", "nolint start"),
+    styler.ignore_stop = c("# styler: on", "# nolint end"),
     styler.quiet = FALSE,
     styler.test_dir_writable = TRUE
   )

inst/WORDLIST

@@ -103,6 +103,7 @@ LF
 LIBS
 lifecycle
 Ligges
+lintr
 linux
 lorenz
 lorenzwalthert

man/add_stylerignore.Rd

@@ -77,6 +77,63 @@ test_that("works with other markers", {
   )
 })
 
+test_that("works with multiple markers", {
+  expect_equal(
+    withr::with_options(
+      list(
+        styler.ignore_start = c("# startignore", "#lintstart"),
+        styler.ignore_stop = "# xxx"
+      ),
+      {
+        style_text(c(
+          "1+1",
+          "#lintstart",
+          "1+1",
+          "# xxx",
+          "1+1"
+        )) %>%
+          as.character()
+      }
+    ),
+    c("1 + 1", "#lintstart", "1+1", "# xxx", "1 + 1")
+  )
+})
+
+test_that("works with multiple markers", {
+  expect_equal(
+    withr::with_options(
+      list(
+        styler.ignore_start = "# startignore",
+        styler.ignore_stop = c("# xxx", "# lintstop")
+      ),
+      {
+        style_text(c(
+          "1+1",
+          "# startignore",
+          "1+1",
+          "# lintstop",
+          "1+1"
+        )) %>%
+          as.character()
+      }
+    ),
+    c("1 + 1", "# startignore", "1+1", "# lintstop", "1 + 1")
+  )
+})
+
+test_that("works for multiple markers inline", {
+  withr::local_options(styler.ignore_start = "# noeq", )
+  expect_equal(
+    style_text(c(
+      "1+1",
+      "1+1# noeq",
+      "1+1"
+    )) %>%
+      as.character(),
+    c("1 + 1", "1+1# noeq", "1 + 1")
+  )
+})
+
 test_that("works with other markers", {
   expect_warning(
     withr::with_options(