Add ability to keep markdown files when building vignettes

Fixes r-lib#1726

NEWS.md

@@ -1,5 +1,7 @@
 # devtools 1.13.3.9000
 
+* `build_vignette()` gains a `keep_md` option to allow keeping the intermediate markdown output (#1726)
+
 * Bioconductor support now provided by the BiocManager CRAN package instead of
   BiocInstaller (#1833).
 

R/vignette-r.r

@@ -16,7 +16,7 @@
 #  A copy of the GNU General Public License is available at
 #  http://www.r-project.org/Licenses/
 
-copy_vignettes <- function(pkg) {
+copy_vignettes <- function(pkg, keep_md) {
   pkg <- as.package(pkg)
 
   usethis_use_directory(pkg, "doc", ignore = TRUE)
@@ -27,7 +27,12 @@ copy_vignettes <- function(pkg) {
   vigns <- tools::pkgVignettes(dir = pkg$path, output = TRUE, source = TRUE)
   if (length(vigns$docs) == 0) return(invisible())
 
-  out_mv <- c(vigns$outputs, unique(unlist(vigns$sources, use.names = FALSE)))
+  md_outputs <- character()
+  if (isTRUE(keep_md)) {
+    md_outputs <- list.files(path = vigns$dir, pattern = "[.]md$", full.names = TRUE)
+  }
+
+  out_mv <- c(md_outputs, vigns$outputs, unique(unlist(vigns$sources, use.names = FALSE)))
   out_cp <- vigns$docs
 
   message("Moving ", paste(basename(out_mv), collapse = ", "), " to doc/")

R/vignettes.r

@@ -16,6 +16,10 @@
 #'   if you need to debug.
 #' @param install If \code{TRUE}, install the package before building
 #'   vignettes.
+#' @param keep_md If \code{TRUE}, move md intermediates as well as rendered
+#'   outputs. Most useful when using the `keep_md` YAML option for Rmarkdown
+#'   outputs. See
+#'   \link{https://bookdown.org/yihui/rmarkdown/html-document.html#keeping-markdown}.
 #' @inheritParams tools::buildVignettes
 #' @inheritParams install_deps
 #' @keywords programming
@@ -26,9 +30,10 @@
 build_vignettes <- function(pkg = ".",
                             dependencies = "VignetteBuilder",
                             clean = TRUE,
-                            upgrade = FALSE,
+                            upgrade = TRUE,
                             quiet = TRUE,
-                            install = TRUE
+                            install = TRUE,
+                            keep_md = TRUE
                             ) {
   pkg <- as.package(pkg)
   vigns <- tools::pkgVignettes(dir = pkg$path)
@@ -41,7 +46,7 @@ build_vignettes <- function(pkg = ".",
   if (isTRUE(install)) {
     build <- function(pkg_path, clean, quiet) {
       withr::with_temp_libpaths(action = "prefix", {
-        devtools::install(pkg_path, upgrade_dependencies = FALSE, reload = FALSE, quiet = quiet)
+        devtools::install(pkg_path, upgrade_dependencies = upgrade, reload = FALSE, quiet = quiet)
         tools::buildVignettes(dir = pkg_path, clean = clean, tangle = TRUE, quiet = quiet)
                             })
     }
@@ -61,7 +66,7 @@ build_vignettes <- function(pkg = ".",
   # files as well
   vigns <- tools::pkgVignettes(dir = pkg$path, source = TRUE, output = TRUE)
 
-  copy_vignettes(pkg)
+  copy_vignettes(pkg, keep_md)
 
   create_vignette_index(pkg, vigns)
 

vignettes/dependencies.Rmd

@@ -2,7 +2,9 @@
 title: "Devtools dependencies"
 author: "Jim Hester, Hadley Wickham"
 date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
+output:
+  rmarkdown::html_vignette:
+    keep_md: true
 vignette: >
   %\VignetteIndexEntry{Devtools dependencies}
   %\VignetteEngine{knitr::rmarkdown}