Merge pull request #325 from pwildenhain/add-parsable-rmd

- Add  Rmarkdown files to parsable-R hook (#325).

Author: lorenzwalthert

.gitignore

@@ -2,6 +2,7 @@
 .Rhistory
 .Rproj.user
 .Ruserdata
+.Rprofile
 docs/
 inst/doc
 scratch/

.pre-commit-hooks.yaml

@@ -33,7 +33,7 @@
     description: check if a .R file is parsable
     entry: Rscript inst/hooks/exported/parsable-R.R
     language: r
-    files: '\.[rR]$'
+    files: '\.[rR](md)?$'
     minimum_pre_commit_version: "2.13.0"
 -   id: readme-rmd-rendered
     name: readme-rmd-rendered

inst/hooks/exported/parsable-R.R

@@ -2,6 +2,16 @@
 files <- commandArgs(trailing = TRUE)
 
 out <- lapply(files, function(path) {
+  is_rmd <- grepl("\\.[rR]md$", path)
+  if (is_rmd) {
+    path <- knitr::purl(
+      input = path,
+      output = tempfile(fileext = ".R"),
+      quiet = TRUE,
+      documentation = FALSE
+    )
+  }
+
   tryCatch(
     parse(path),
     error = function(x) stop("File ", path, " is not parsable", call. = FALSE)

inst/pre-commit-hooks.yaml

@@ -33,7 +33,7 @@
     description: check if a .R file is parsable
     entry: Rscript inst/hooks/exported/parsable-R.R
     language: r
-    files: '\.[rR]$'
+    files: '\.[rR](md)?$'
     minimum_pre_commit_version: "2.13.0"
 -   id: readme-rmd-rendered
     name: readme-rmd-rendered

tests/testthat/in/parsable-R-fail.Rmd

@@ -0,0 +1,8 @@
+---
+title: "Parsable Rmd Fail"
+output: rmarkdown::html_document
+---
+
+```{r}
+1 1j1j öj1 
+```

tests/testthat/in/parsable-R-success.Rmd

@@ -0,0 +1,8 @@
+---
+title: "Parsable Rmd Success"
+output: rmarkdown::html_document
+---
+
+```{r}
+call()
+```

tests/testthat/test-hooks.R

@@ -120,9 +120,15 @@ run_test("parsable-R",
   error_msg = NULL
 )
 
+run_test("parsable-R",
+  suffix = "-success.Rmd",
+  error_msg = NULL
+)
+
 # failure
 run_test("parsable-R", suffix = "-fail.R", error_msg = "not parsable")
 
+run_test("parsable-R", suffix = "-fail.Rmd", error_msg = "not parsable")
 
 ### . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
 ### spell-check                                                             ####

vignettes/available-hooks.Rmd

@@ -117,8 +117,9 @@ This hook does not modify files.
 
 ## `parsable-R`
 
-Checks if your `.R` files are "valid" R code by checking if running `parse()` on
-them returns an error.
+Checks if your `.R` and `.Rmd` files are "valid" R code by checking if running 
+`parse()` on them (or their `knitr::purl()`ed output for `.Rmd`) returns an 
+error.
 
 This hook does not modify files.