use_template() no longer errors when a user chooses not to overwrite an existing file and instead produces a message (#350)

* a negative user response to overwriting a file produces a message instead of an error. Closes #348

* only modify if open = TRUE and the file is actually created

* modify test_that names to reflect warnings

* use longer form comparison

* skip R 3.1 when testing message for use_readme overwrite

* Tweak docs

Also a test to see if I can push to boshek/master

* Swap an if-else

* These functions have moved

* Use `done()` instead of `message()`

* Add expectations for file or dir in the project

* Finish adjusting to new behaviour or write_over() and use_template()

Author: boshek

NEWS.md

@@ -1,5 +1,7 @@
 # usethis 1.3.0.9000
 
+* `use_template()` no longer errors when a user chooses not to overwrite an existing file and simply exits with confirmation that the file is unchanged (#348, @boshek).
+
 * `proj_sitrep()` is a new function that reports current working directory, the active usethis project, and the active RStudio Project. Call this function if things seem weird and you're not sure what's wrong or how to fix it (#426).
 
 * usethis has a new logo! (#429)

R/ci.R

@@ -22,15 +22,15 @@ NULL
 use_travis <- function(browse = interactive()) {
   check_uses_github()
 
-  use_template(
+  new <- use_template(
     "travis.yml",
     ".travis.yml",
     ignore = TRUE
   )
+  if (!new) return(invisible(FALSE))
 
   travis_activate(browse)
   use_travis_badge()
-
   invisible(TRUE)
 }
 
@@ -81,26 +81,25 @@ use_coverage <- function(type = c("codecov", "coveralls")) {
 
   use_dependency("covr", "Suggests")
 
-  switch(type,
-    codecov = {
-      use_template("codecov.yml", ignore = TRUE)
-      use_codecov_badge()
-      todo("Add to {value('.travis.yml')}:")
-      code_block(
-        "after_success:",
-        "  - Rscript -e 'covr::codecov()'"
-      )
-    },
-
-    coveralls = {
-      todo("Turn on coveralls for this repo at https://coveralls.io/repos/new")
-      use_coveralls_badge()
-      todo("Add to {value('.travis.yml')}:")
-      code_block(
-        "after_success:",
-        "  - Rscript -e 'covr::coveralls()'"
-      )
-    }
+  if (type == "codecov") {
+    new <- use_template("codecov.yml", ignore = TRUE)
+    if (!new) return(invisible(FALSE))
+  }
+
+  if (type == "coveralls") {
+    todo("Turn on coveralls for this repo at https://coveralls.io/repos/new")
+  }
+
+  switch(
+    type,
+    codecov = use_codecov_badge(),
+    coveralls = use_coveralls_badge()
+  )
+
+  todo("Add to {value('.travis.yml')}:")
+  code_block(
+    "after_success:",
+    "  - Rscript -e 'covr::{type}()'"
   )
 
   invisible(TRUE)
@@ -133,7 +132,8 @@ use_coveralls_badge <- function() {
 use_appveyor <- function(browse = interactive()) {
   check_uses_github()
 
-  use_template("appveyor.yml", ignore = TRUE)
+  new <- use_template("appveyor.yml", ignore = TRUE)
+  if (!new) return(invisible(FALSE))
 
   appveyor_activate(browse)
   use_appveyor_badge()

R/code-of-conduct.R

@@ -18,7 +18,7 @@ use_code_of_conduct <- function(path = NULL) {
   }
   save_as <- path_join(c(path, "CODE_OF_CONDUCT.md"))
 
-  use_template(
+  new <- use_template(
     "CODE_OF_CONDUCT.md",
     save_as = save_as,
     ignore = is_package() && is.null(path)
@@ -30,4 +30,6 @@ use_code_of_conduct <- function(path = NULL) {
     "[Contributor Code of Conduct]({save_as}). ",
     "By contributing to this project, you agree to abide by its terms."
   ))
+
+  invisible(new)
 }

R/cran.R

@@ -17,6 +17,4 @@ use_cran_comments <- function(open = interactive()) {
     ignore = TRUE,
     open = open
   )
-
-  invisible(TRUE)
 }

R/pipe.R

@@ -13,7 +13,7 @@ use_pipe <- function() {
   }
 
   use_dependency("magrittr", "Imports")
-  use_template("pipe.R", "R/utils-pipe.R")
-
+  new <- use_template("pipe.R", "R/utils-pipe.R")
   todo("Run {code('devtools::document()')}")
+  invisible(new)
 }

R/readme.R

@@ -27,13 +27,14 @@ use_readme_rmd <- function(open = interactive()) {
   data <- project_data()
   data$Rmd <- TRUE
 
-  use_template(
+  new <- use_template(
     if (is_package()) "package-README" else "project-README",
     "README.Rmd",
     data = data,
     ignore = TRUE,
     open = open
   )
+  if (!new) return(invisible(FALSE))
 
   if (uses_git()) {
     use_git_hook(

R/revdep.R

@@ -18,10 +18,11 @@ use_revdep <- function() {
       "library.noindex", "data.sqlite", "*.html")
   )
 
-  use_template(
+  new <- use_template(
     "revdep-email.yml",
     "revdep/email.yml"
   )
 
   todo("Run checks with {code('revdepcheck::revdep_check(num_workers = 4)')}")
+  invisible(new)
 }

R/rstudio.R

@@ -13,14 +13,14 @@
 #' @export
 use_rstudio <- function() {
   rproj_file <- path_ext_set(project_name(), "Rproj")
-  use_template("template.Rproj", rproj_file)
+  new <- use_template("template.Rproj", rproj_file)
 
   use_git_ignore(".Rproj.user")
   if (is_package()) {
     use_build_ignore(c(rproj_file, ".Rproj.user"))
   }
 
-  invisible(TRUE)
+  invisible(new)
 }
 
 #' Don't save/load user workspace between sessions

R/template.R

@@ -13,7 +13,7 @@
 #' the `data` argument. Internally, this function uses
 #' [whisker::whisker.render()] to combine your template file with your data.
 #'
-#' @param template Path to template file relative to `"templates"` directory
+#' @param template Path to template file relative to `templates/` directory
 #'   within `package`; see details.
 #' @param save_as Name of file to create. Defaults to `template`
 #' @param data A list of data passed to the template.
@@ -45,7 +45,7 @@ use_template <- function(template,
     use_build_ignore(save_as)
   }
 
-  if (open) {
+  if (open && new) {
     edit_file(proj_path(save_as))
   }
 

R/test.R

@@ -20,8 +20,6 @@ use_testthat <- function() {
     "tests/testthat.R",
     data = list(name = project_name())
   )
-
-  invisible(TRUE)
 }
 
 #' @rdname use_testthat
@@ -43,16 +41,15 @@ use_test <- function(name = NULL, open = interactive()) {
     if (open) {
       edit_file(proj_path(path))
     }
-  } else {
-    use_template(
-      "test-example.R",
-      path,
-      data = list(test_name = path_ext_remove(name)),
-      open = open
-    )
+    return(invisible(TRUE))
   }
 
-  invisible(TRUE)
+  use_template(
+    "test-example.R",
+    path,
+    data = list(test_name = path_ext_remove(name)),
+    open = open
+  )
 }
 
 uses_testthat <- function(base_path = proj_get()) {