make styler-perm the default

Author: lorenzwalthert

inst/hooks/exported/style-files.R

@@ -25,8 +25,8 @@ library(styler)
 args <- commandArgs(trailingOnly = TRUE)
 non_file_args <- args[!grepl("^[^-][^-]", args)]
 keys <- setdiff(
-  gsub("(^--[0-9A-Za-z_]+).*", "\\1", non_file_args),
-  c("--style_pkg", "--style_fun", "--no-warn-cache", "--cache-root")
+  gsub("(^--[0-9A-Za-z_-]+).*", "\\1", non_file_args),
+  c("--style_pkg", "--style_fun", "--cache-root", "--no-warn-cache")
 )
 if (length(keys) > 0) {
   bare_keys <- gsub("^--", "", keys)

tests/testthat/test-hooks.R

@@ -8,29 +8,34 @@ run_test("use-tidy-description", "DESCRIPTION", suffix = "")
 ### style-files                                                             ####
 
 # success
-run_test("style-files", suffix = "-success.R")
+run_test("style-files", 
+         suffix = "-success.R", cmd_args = c('--cache-root=styler')
+)
 # fail
-run_test("style-files", suffix = "-fail-changed.R", error_msg = NA)
+run_test("style-files",
+         suffix = "-fail-changed.R", cmd_args = c('--cache-root=styler'), 
+         error_msg = NA)
 
-run_test("style-files", suffix = "-fail-parse.R", error_msg = "unexpected")
+run_test("style-files", suffix = "-fail-parse.R", cmd_args = c('--cache-root=styler'), 
+         error_msg = "unexpected")
 
 # success with cmd args
 run_test("style-files",
   file_name = "style-files-cmd",
   suffix = "-success.R",
-  cmd_args = c("--style_pkg=styler", "--style_fun=tidyverse_style")
+  cmd_args = c("--style_pkg=styler", "--style_fun=tidyverse_style", '--cache-root=styler')
 )
 
 run_test("style-files",
   file_name = "style-files-cmd",
   suffix = "-success.R",
-  cmd_args = c("--scope=spaces")
+  cmd_args = c("--scope=spaces", '--cache-root=styler')
 )
 
 run_test("style-files",
   file_name = "style-files-cmd",
   suffix = "-success.R",
-  cmd_args = c('--scope="I(\'spaces\')"')
+  cmd_args = c('--scope="I(\'spaces\')"', '--cache-root=styler')
 )
 
 run_test("style-files",
@@ -39,7 +44,8 @@ run_test("style-files",
   cmd_args = c(
     '--scope="I(\'spaces\')"',
     "--base_indention=0",
-    "--include_roxygen_examples=TRUE"
+    "--include_roxygen_examples=TRUE", 
+    '--cache-root=styler'
   )
 )
 
@@ -50,35 +56,38 @@ run_test("style-files",
     '--scope="I(\'spaces\')"',
     "--base_indention=0",
     "--include_roxygen_examples=TRUE",
-    '--reindention="specify_reindention(\'#\')"'
+    '--reindention="specify_reindention(\'#\')"', 
+    '--cache-root=styler'
   )
 )
 
 run_test("style-files",
   file_name = "style-files",
   suffix = "-base-indention-success.R",
-  cmd_args = c("--base_indention=4")
+  cmd_args = c("--base_indention=4", '--cache-root=styler') 
 )
 
 run_test("style-files",
   file_name = "style-files",
   suffix = "-roxygen-success.R",
-  cmd_args = c("--include_roxygen_examples=FALSE")
+  cmd_args = c("--include_roxygen_examples=FALSE", '--cache-root=styler')
 )
 
 # fail with cmd args
 run_test("style-files",
   file_name = "style-files-cmd",
   suffix = "-success.R",
   error_msg = "scope must be one",
-  cmd_args = c("--scope=space")
+  cmd_args = c("--scope=space", '--cache-root=styler')
 )
 
 run_test("style-files",
   file_name = "style-files-cmd",
   suffix = "-fail.R",
   error_msg = NA,
-  cmd_args = c("--style_pkg=styler", "--style_fun=tidyverse_style")
+  cmd_args = c(
+    "--style_pkg=styler", "--style_fun=tidyverse_style", '--cache-root=styler'
+  )
 )
 
 ### . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..

tests/testthat/test-zzz.R

@@ -0,0 +1,7 @@
+test_that("tests don't write to styler-perm", {
+  skip_on_cran()
+  expect_false(fs::file_exists(
+      fs::path(R.cache::getCacheRootPath(), "styler-perm")
+    )
+  )
+})

vignettes/available-hooks.Rmd

@@ -86,6 +86,25 @@ In addition, the hook takes the following arguments that are not passed to
 * If no permanent `{R.cache}` cache exists, the hook emits a warning which you 
   can silence with `--no-warn-cache`.
 
+```
+  id: style-files
+  args: [--no-warn-cache]
+```
+
+  
+* Argument `cache_root` is passed to `options()` to set `"styler.cache_root"`.
+  Default value: `"styler-perm"`. The argument 
+  determines the sub-directory under the {R.cache} cache directory that {styler}
+  uses. If you want {styler} to auto-clean up caches older than 6 days, set this
+  to `styler`. For more information, see 
+  `help("caching", package = "styler")`.
+
+```
+  id: style-files
+  args: [--cache-root=styler]
+```
+
+
 This hook modifies files unless you specify `--dry=fail` (requires 
 `{styler} > 1.3.2`).