Add create_quarto_project()

DESCRIPTION

@@ -50,6 +50,7 @@ Suggests:
     knitr,
     magick,
     pkgload (>= 1.3.2.1),
+    quarto,
     rmarkdown,
     roxygen2 (>= 7.1.2),
     spelling (>= 1.2),

NAMESPACE

@@ -19,6 +19,7 @@ export(create_from_github)
 export(create_github_token)
 export(create_package)
 export(create_project)
+export(create_quarto_project)
 export(create_tidy_package)
 export(edit_file)
 export(edit_git_config)

NEWS.md

@@ -10,10 +10,15 @@
   is not specified (#2117, @salim-b).
 
 * usethis's criteria for recognizing a project have expanded to include (#2133):
-  - a `.vscode/` directory, which Positron or VS Code might create
+  - a `.vscode/settings.json` file, which Positron or VS Code might create
   - a `_quarto.yml` file, typical of a Quarto project
   - an `renv.lock` file, which renv creates
 
+* `create_quarto_project()` is a new experimental function that combines basic
+  usage of `quarto::quarto_create_project()` with some of the niceties of
+  usethis's `create_*()` functions, such as opening the newly created project in
+  your IDE (#1891, @focardozom).
+
 # usethis 3.1.0
 
 * `use_vignette()` and `use_article()` support Quarto. The `name` of the new

R/create.R

@@ -2,12 +2,17 @@
 #'
 #' @description
 #' These functions create an R project:
-#'   * `create_package()` creates an R package
+#'   * `create_package()` creates an R package.
 #'   * `create_project()` creates a non-package project, i.e. a data analysis
-#'   project
+#'     project.
+#'   * `r lifecycle::badge("experimental")` `create_quarto_project()` creates a
+#'     Quarto project. It is a simplified convenience wrapper around
+#'     `quarto::quarto_create_project()`, which you should call directly for
+#'     more advanced usage.
 #'
-#' Both functions can be called on an existing project; you will be asked before
-#' any existing files are changed.
+#' These functions work best when creating a project *de novo*, but
+#' `create_package()` and `create_project()` can be called in an existing
+#' project; you will be asked before any existing files are changed.
 #'
 #' @inheritParams use_description
 #' @param fields A named list of fields to add to `DESCRIPTION`, potentially
@@ -19,17 +24,22 @@
 #' @param rstudio If `TRUE`, calls [use_rstudio()] to make the new package or
 #'   project into an [RStudio
 #'   Project](https://r-pkgs.org/workflow101.html#sec-workflow101-rstudio-projects).
-#'    If `FALSE` and a non-package project, a sentinel `.here` file is placed so
-#'   that the directory can be recognized as a project by the
-#'   [here](https://here.r-lib.org) or
-#'   [rprojroot](https://rprojroot.r-lib.org) packages.
+#'
+#'   If `FALSE`, the goal is to ensure that the directory can be recognized as
+#'   a project by, for example, the [here](https://here.r-lib.org) package. If
+#'   the project is neither an R package nor a Quarto project, a sentinel
+#'   `.here` file is placed to mark the project root.
 #' @param open If `TRUE`, [activates][proj_activate()] the new project:
 #'
 #'   * If using RStudio desktop, the project is opened in a new session.
 #'   * If using Positron, the project is opened in a new window.
 #'   * If on RStudio server, the current RStudio project is activated.
 #'   * Otherwise, the working directory and active project is changed in the
 #'     current R session.
+#' @param type The type of Quarto project to create. See
+#'   `?quarto::quarto_create_project` for the most up-to-date list, but
+#'   `"website"`, `"blog"`, `"book"`, and `"manuscript"` are common choices.
+#'
 #' @returns Path to the newly created project or package, invisibly.
 #' @seealso [create_tidy_package()] is a convenience function that extends
 #'   `create_package()` by immediately applying as many of the tidyverse
@@ -114,6 +124,46 @@ create_project <- function(
   invisible(proj_get())
 }
 
+#' @rdname create_package
+#' @export
+create_quarto_project <- function(
+  path,
+  type = "default",
+  rstudio = rstudioapi::isAvailable(),
+  open = rlang::is_interactive()
+) {
+  check_installed("quarto")
+
+  path <- user_path_prep(path)
+  parent_dir <- path_dir(path)
+  check_path_is_directory(parent_dir)
+
+  name <- path_file(path_abs(path))
+  challenge_nested_project(parent_dir, name)
+  challenge_home_directory(path)
+
+  create_directory(path)
+  local_project(path, force = TRUE)
+
+  res <- quarto::quarto_create_project(
+    name = name,
+    dir = parent_dir,
+    type = type,
+    no_prompt = TRUE,
+    quiet = getOption("usethis.quiet", default = FALSE)
+  )
+
+  if (open) {
+    if (proj_activate(proj_get())) {
+      # working directory/active project already set; clear the scheduled
+      # restoration of the original project
+      withr::deferred_clear()
+    }
+  }
+
+  invisible(proj_get())
+}
+
 #' Create a project from a GitHub repo
 #'
 #' @description

tests/testthat/helper.R

@@ -22,18 +22,28 @@ create_local_package <- function(
 }
 
 create_local_project <- function(
+  # it is convenient if `dir` produces a project name that would be allowed for
+  # a CRAN package, even for a generic project test fixture
   dir = file_temp(pattern = "testproj"),
   env = parent.frame(),
   rstudio = FALSE
 ) {
   create_local_thing(dir, env, rstudio, "project")
 }
 
+create_local_quarto_project <- function(
+  dir = file_temp(pattern = "test-quarto-proj"),
+  env = parent.frame(),
+  rstudio = FALSE
+) {
+  create_local_thing(dir, env, rstudio, "quarto_project")
+}
+
 create_local_thing <- function(
   dir = file_temp(pattern = pattern),
   env = parent.frame(),
   rstudio = FALSE,
-  thing = c("package", "project")
+  thing = c("package", "project", "quarto_project")
 ) {
   thing <- match.arg(thing)
   if (fs::dir_exists(dir)) {
@@ -45,7 +55,7 @@ create_local_thing <- function(
 
   withr::defer(
     {
-      ui_bullets(c("Deleting temporary project: {.path {dir}}"))
+      ui_bullets(c("v" = "Deleting temporary project: {.path {dir}}"))
       fs::dir_delete(dir)
     },
     envir = env
@@ -65,7 +75,12 @@ create_local_thing <- function(
         open = FALSE,
         check_name = FALSE
       ),
-      project = create_project(dir, rstudio = rstudio, open = FALSE)
+      project = create_project(dir, rstudio = rstudio, open = FALSE),
+      quarto_project = create_quarto_project(
+        dir,
+        rstudio = rstudio,
+        open = FALSE
+      )
     )
   )
 
@@ -74,7 +89,9 @@ create_local_thing <- function(
 
   withr::defer(
     {
-      ui_bullets(c("Restoring original working directory: {.path {old_wd}}"))
+      ui_bullets(c(
+        "v" = "Restoring original working directory: {.path {old_wd}}"
+      ))
       setwd(old_wd)
     },
     envir = env

tests/testthat/test-create.R

@@ -148,3 +148,11 @@ test_that("we discourage project creation in home directory", {
     expect_usethis_error(create_project(path_home_r()), "create anyway")
   }
 })
+
+test_that("create_quarto_project() works for basic usage", {
+  skip_if_not_installed("quarto")
+
+  dir <- create_local_quarto_project()
+  expect_proj_file("_quarto.yml")
+  expect_true(possibly_in_proj(dir))
+})