Don't check readme.Rmd

NEWS.md

@@ -2,6 +2,7 @@
 
 * `style-files` hook fails more informatively if required package is not listed
   in `additional_dependencies:` (#333).
+* `deps-in-desc` always excludes `README.md` (#336).
 * Document timeout and other problems with pre-commit.ci (#335).
 
 # precommit v0.2.0

inst/hooks/exported/deps-in-desc.R

@@ -17,6 +17,10 @@ pre_installed <- c(
 
 arguments <- docopt::docopt(doc)
 deps_in_desc <- function(file, arguments) {
+  if (basename(file) == "README.Rmd") {
+    # is .Rbuildignored, dependencies irrelevant
+    return()
+  }
   if (grepl("(\\.Rmd|\\.Rnw|\\.rmd|\\.rnw)$", file)) {
     file <- knitr::purl(file, output = tempfile())
   }

tests/testthat/in/README.Rmd

@@ -3,3 +3,10 @@ output: github_document
 ---
 
 # This is a readme
+
+```{r}
+knitr::opts_chunk$set(
+  fig.path = "man/figures/",
+  eval = FALSE
+)
+```

tests/testthat/test-hooks.R

@@ -208,6 +208,14 @@ run_test("deps-in-desc",
   artifacts = c("DESCRIPTION" = test_path("in/DESCRIPTION"))
 )
 
+# README.Rmd is excluded
+run_test("deps-in-desc",
+  "README.Rmd",
+  suffix = "", error_msg = NULL,
+  artifacts = c("DESCRIPTION" = test_path("in/DESCRIPTION-no-deps.dcf"))
+)
+
+
 
 # Rnw
 run_test("deps-in-desc",

vignettes/available-hooks.Rmd

@@ -208,7 +208,8 @@ specified in `DESCRIPTION`.
 ## `deps-in-desc`
 
 Checks if packages used with the `pkgname::fun()` syntax are listed in your
-DESCRIPTION file. Flag `allow_private_imports` lets the user specify that
+DESCRIPTION file. Note that `README.Rmd` is never checked. Flag 
+`allow_private_imports` lets the user specify that
 private imports into the package namespace are tolerable, e.g. `somepkg:::x()`.
 Flag not set by default, i.e. the hook will fail if such a call is found.
 
@@ -217,9 +218,6 @@ Flag not set by default, i.e. the hook will fail if such a call is found.
   args: [--allow_private_imports] 
 ```
 
-Note that for Rmd or Rnw documents, we use `knitr::purl()` to get the R code and
-code chunk headers cannot contain code that has dependencies outside the header, 
-see also [yihui/knitr#1938](https://github.com/yihui/knitr/issues/1938).
 
 This hook does not modify the file `DESCRIPTION` because the user should decide
 for each package if it should go to `Imports:` or `Suggests:`, which can be done