Merge pull request #305 from lorenzwalthert/styler-permanent-cache

- expose cache root arg (#305).

Author: lorenzwalthert

.github/workflows/hook-dependencies-upate.yml

@@ -76,3 +76,5 @@ jobs:
             This PR updates the hook dependencies in `renv.lock`, auto-generated by [create-pull-request][1]. Close and re-open this to trigger `on: pull_request` events to circumvent [limitation of GitHub actions](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork).
 
             [1]: https://github.com/peter-evans/create-pull-request
+            
+            

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     rev: v0.1.3.9133
     hooks: 
     -   id: style-files
-        args: [--style_pkg=styler, --style_fun=tidyverse_style]
+        args: [--style_pkg=styler, --style_fun=tidyverse_style, --cache_root=styler-perm]
         exclude: > 
           (?x)^(
           tests/testthat/in/.*\.R|

NEWS.md

@@ -9,6 +9,9 @@ used packages, roxygen snippet generation and more. In addition:
 * rename default branch to *main* (#307).
 
 
+* `style-files` hook gains an argument `--cache-root` that is passed to 
+  `options(styler.cache_root = ...)` (#305).
+
 # precommit v0.1.3.9012
 
 This is a pre-release for `v0.2.0` and imposes a minimal version requirement 

inst/hooks/exported/style-files.R

@@ -1,12 +1,13 @@
 #!/usr/bin/env Rscript
 'style files.
 Usage:
-  style_files [--style_pkg=<style_guide_pkg>] [--style_fun=<style_guide_fun>] [--no-warn-cache] <files>...
+  style_files [--style_pkg=<style_guide_pkg>] [--style_fun=<style_guide_fun>] [--cache-root=<cache_root_>] [--no-warn-cache] <files>...
 
 Options:
   --style_pkg=<style_guide_pkg>  Package where the style guide is stored [default: "styler"].
   --style_fun=<style_guide_fun>  The styling function in style_pkg [default: "tidyverse_style"].
   --no-warn-cache  Suppress the warning about a missing permanent cache.
+  --cache-root=<cache_root_> Passed to `options("styler.cache_root")` [default: "styler-perm"].
 ' -> doc
 
 if (packageVersion("precommit") < "0.1.3.9010") {
@@ -24,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")
+  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)
@@ -45,6 +46,8 @@ if (packageVersion("styler") < "1.3.2") {
 } else {
   precommit::may_require_permanent_cache(arguments$no_warn_cache)
 }
+options('styler.cache_root' = arguments$cache_root)
+print(c('cache root set to ', arguments$cache_root))
 
 style <- eval(parse(text = paste(arguments$style_pkg, "::", arguments$style_fun)))
 tryCatch(

renv.lock

@@ -401,10 +401,15 @@
     },
     "styler": {
       "Package": "styler",
-      "Version": "1.5.1",
-      "Source": "Repository",
-      "Repository": "CRAN",
-      "Hash": "eb62a56987abe8fa9d1de47eef53a790"
+      "Version": "1.6.2.9000",
+      "Source": "GitHub",
+      "RemoteType": "github",
+      "RemoteHost": "api.github.com",
+      "RemoteRepo": "styler",
+      "RemoteUsername": "r-lib",
+      "RemoteRef": "HEAD",
+      "RemoteSha": "55d0920fcaafa0217f625b9dec491621556e76f6",
+      "Hash": "0b44de206a40a24c8065b1ebe72be129"
     },
     "sys": {
       "Package": "sys",

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`).