Add a vignettes argument to check

It is too esoteric for people to remember they need to disable building
vignettes for R CMD build as well as for R CMD check, so we now have a
vignette argument in check() that can be used to do both.

Fixes #2165

NEWS.md

@@ -1,5 +1,6 @@
 # devtools (development version)
 
+* `check()` gains a `vignettes` argument, to more easily disable checks for vignettes (#2165).
 * `check_win_*()` function now resets the email to the original email after execution (@muschellij2, #2152).
 * `check()` now sets `NOT_CRAN=true` by default, as was originally intended
   (#2135).

R/check.R

@@ -47,6 +47,8 @@
 #'   compatibility. `args = "--output=/foo/bar"` can be used to change the
 #'   check directory.
 #' @param ... Additional arguments passed on to [pkgbuild::build()].
+#' @param vignettes If `FALSE`, do not build or check vignettes, equivalent to
+#'   using `args = '--ignore-vignettes' and `build_args = '--no-build-vignettes'.
 #' @param cleanup Deprecated.
 #' @seealso [release()] if you want to send the checked package to
 #'   CRAN.
@@ -66,6 +68,7 @@ check <- function(pkg = ".",
                   quiet = FALSE,
                   check_dir = tempdir(),
                   cleanup = TRUE,
+                  vignettes = TRUE,
                   error_on = c("never", "error", "warning", "note")) {
   pkg <- as.package(pkg)
   withr::local_options(list(warn = 1))
@@ -100,13 +103,18 @@ check <- function(pkg = ".",
 
   check_dots_used(action = getOption("devtools.ellipsis_action", rlang::warn))
 
+  if (identical(vignettes, FALSE)) {
+    args <- union(args, "--ignore-vignettes")
+  }
+
   withr::with_envvar(pkgbuild::compiler_flags(FALSE), action = "prefix", {
     built_path <- pkgbuild::build(
       pkg$path,
       tempdir(),
       args = build_args,
       quiet = quiet,
       manual = manual,
+      vignettes = vignettes,
       ...
     )
     on.exit(unlink(built_path), add = TRUE)