also add stylerignore markers to more_specs

Author: lorenzwalthert

NEWS.md

@@ -1,5 +1,6 @@
-* New R option `styler.ignore_alignment` controls if alignment should be 
+* new R option `styler.ignore_alignment` controls if alignment should be 
   detected (and preserved) or not (#932).
+* the cache is also invalidated on changing the stylerignore markers (#932).
 
 # styler 1.7.0
 

R/utils-cache.R

@@ -209,6 +209,8 @@ cache_more_specs <- function(include_roxygen_examples,
   list(
     include_roxygen_examples = include_roxygen_examples,
     base_indention = base_indention,
-    ignore_alignment = getOption("styler.ignore_alignment", FALSE)
+    ignore_alignment = getOption("styler.ignore_alignment", FALSE),
+    ignore_start = getOption("styler.ignore_start", .default_ignore_start),
+    ignore_stop = getOption("styler.ignore_start", .default_ignore_stop)
   )
 }

R/zzz.R

@@ -1,3 +1,6 @@
+.default_ignore_start <- "styler: off"
+.default_ignore_stop <- "styler: on"
+
 .onLoad <- function(libname, pkgname) {
   op <- options()
   op.styler <- list(
@@ -6,8 +9,8 @@
     styler.cache_name = styler_version,
     styler.colored_print.vertical = TRUE,
     styler.ignore_alignment = FALSE,
-    styler.ignore_start = "styler: off",
-    styler.ignore_stop = "styler: on",
+    styler.ignore_start = .default_ignore_start,
+    styler.ignore_stop = .default_ignore_stop,
     styler.quiet = FALSE,
     styler.test_dir_writable = TRUE
   )

tests/testthat/test-cache-interaction-more-specs.R

@@ -21,7 +21,7 @@ test_that("ignore_alignment is respected in caching", {
     as.character(without_detection),
     as.character(text_without_alignment)
   )
-  cache_info(format = "tabular")$size == 2
+  expect_equal(cache_info(format = "tabular")$n, 2)
 })
 
 test_that("cache is deactivated at end of caching related testthat file", {

tests/testthat/test-interaction-caching-stylerignore.R

@@ -168,6 +168,25 @@ test_that("indention preserved in stylerignore when caching activated", {
   )
 })
 
+test_that("changing ignore markers invalidates cache", {
+  opts <- list(
+    list(styler.ignore_stop = "noqua: stop", n = 1),
+    list(styler.ignore_start = "noqua: start", n = 3)
+  )
+  purrr::walk(opts, function(opt) {
+    local_test_setup(cache = TRUE)
+    text7 <- c(
+      "# styler: off",
+      "1 + 1",
+      "# styler: on"
+    )
+    style_text(text7)
+    rlang::exec(withr::local_options, !!!opt[-length(opt)])
+    style_text(text7)
+    expect_equal(cache_info(format = "tabular")$n, opt[["n"]])
+  })
+})
+
 test_that("cache is deactivated at end of caching related testthat file", {
   expect_false(cache_is_activated())
 })