Edit template (#1319)

* add `edit_template()`

* document()

* test `edit_template()`

* update news

* use_template() doesn't work if not pkg

* Use consistent news formatting

* Simplify test

* Don't need to suppress output in tests

* add interactive menu to `edit_template()` when `NULL`

* clean up `edit_template()`

* Mention the ability to choose a file

Co-authored-by: Hadley Wickham <[email protected]>
Co-authored-by: Jenny Bryan <[email protected]>

Author: 3 people

NAMESPACE

@@ -29,6 +29,7 @@ export(edit_r_makevars)
 export(edit_r_profile)
 export(edit_rstudio_prefs)
 export(edit_rstudio_snippets)
+export(edit_template)
 export(gh_token_help)
 export(git_branch_default)
 export(git_credentials)

NEWS.md

@@ -2,6 +2,9 @@
 
 * All functions that require a package now ask you if you'd like to install it.
 
+* Added `edit_template()` for opening and creating files in `inst/templates` 
+  (for use with `use_template()`) (@malcolmbarrett, #1319).
+
 * `use_article()` now creates the file in the `vignettes/articles/` (#548).
 
 * `use_lifecycle()` has been updated for changes in our lifecycle workflow 

R/edit.R

@@ -3,6 +3,8 @@
 #' Opens a file for editing in RStudio, if that is the active environment, or
 #' via [utils::file.edit()] otherwise. If the file does not exist, it is
 #' created. If the parent directory does not exist, it is also created.
+#' `edit_template()` specifically opens templates in `inst/templates` for use
+#' with [use_template()].
 #'
 #' @param path Path to target file.
 #' @param open Whether to open the file for interactive editing.
@@ -35,6 +37,43 @@ edit_file <- function(path, open = rlang::is_interactive()) {
   invisible(path)
 }
 
+#' @param template The target template file. If not specified, existing template
+#'  files are offered for interactive selection.
+#' @export
+#' @rdname edit_file
+edit_template <- function(template = NULL, open = rlang::is_interactive()) {
+  check_is_package("edit_template()")
+
+  if (is.null(template)) {
+    ui_info("No template specified... checking {ui_path('inst/templates')}")
+    template <- choose_template()
+  }
+
+  if (is_empty(template)) {
+    return(invisible())
+  }
+
+  path <- proj_path("inst", "templates", template)
+  edit_file(path, open)
+}
+
+choose_template <- function() {
+  if (!is_interactive()) {
+    return(character())
+  }
+  templates <- path_file(dir_ls(proj_path("inst", "templates"), type = "file"))
+  if (is_empty(templates)) {
+    return(character())
+  }
+
+  choice <- utils::menu(
+    choices = templates,
+    title = "Which template do you want to edit? (0 to exit)"
+  )
+
+  templates[choice]
+}
+
 #' Open configuration files
 #'
 #' * `edit_r_profile()` opens `.Rprofile`

man/edit_file.Rd

@@ -31,6 +31,13 @@ test_that("edit_file() copes with path to existing file", {
   expect_identical(existing, res)
 })
 
+test_that("edit_template() can create a new template", {
+  create_local_package()
+
+  edit_template("new_template")
+  expect_proj_file("inst/templates/new_template")
+})
+
 ## testing edit_XXX("user") only on travis and appveyor, because I don't want to
 ## risk creating user-level files de novo for an actual user, which would
 ## obligate me to some nerve-wracking clean up