Tweak update wrapper

Author: cderv

NAMESPACE

@@ -12,7 +12,7 @@ export(quarto_preview_stop)
 export(quarto_publish_app)
 export(quarto_publish_doc)
 export(quarto_publish_site)
-export(quarto_remove_extensions)
+export(quarto_remove_extension)
 export(quarto_render)
 export(quarto_serve)
 export(quarto_update_extension)

NEWS.md

@@ -2,7 +2,8 @@
 
 - Add several new wrapper function: 
   - `quarto_list_extensions()` to list installed extensions using `quarto list extensions`
-  - `quarto_remove_extensions()` to remove an installed extension using `quarto remove extensions`
+  - `quarto_remove_extension()` to remove an installed extension using `quarto remove extensions`
+  - `quarto_update_extension()` to update an installed extension using `quarto update extensions`
 
 - `quarto_preview()` gains a `quiet` argument to suppress any output from R or Quarto CLI (thanks, @cwickham, #232.)
 

R/remove.R

@@ -16,10 +16,10 @@
 #' @examples
 #' \dontrun{
 #' # Remove an already installed extension
-#' quarto_remove_extensions("quarto-ext/fontawesome")
+#' quarto_remove_extension("quarto-ext/fontawesome")
 #' }
 #' @export
-quarto_remove_extensions <- function(
+quarto_remove_extension <- function(
   extension = NULL,
   no_prompt = FALSE,
   quiet = FALSE,

R/update.R

@@ -13,11 +13,13 @@
 #'
 #' @inheritParams quarto_render
 #'
-#' @param extension The extension to update, either an archive or a GitHub
-#'   repository as described in the documentation
-#'   <https://quarto.org/docs/extensions/managing.html>.
+#' @param extension The extension to update, either by its name (i.e ` quarto update extension <gh-org>/<gh-repo>`), an archive (` quarto update extension <path-to-zip>`) or a url (`quarto update extension <url>`).
 #'
-#' @param no_prompt Do not prompt to confirm approval to download external extension.
+#' @param no_prompt Do not prompt to confirm approval to download external extension. Setting `no_prompt = FALSE` means [Extension Trust](#extension-trust) is accepted.
+#'
+#' @seealso [quarto_add_extension()], [quarto_remove_extension()], and [Quarto website](https://quarto.org/docs/extensions/managing.html).
+#'
+#' @return Returns invisibly `TRUE` if the extension was updated, `FALSE` otherwise.
 #'
 #' @examples
 #' \dontrun{
@@ -27,9 +29,6 @@
 #' # Update a template and set up a draft document from a ZIP archive
 #' quarto_update_extension("https://github.com/quarto-ext/fontawesome/archive/refs/heads/main.zip")
 #' }
-#'
-#' @importFrom rlang is_interactive
-#' @importFrom cli cli_abort
 #' @export
 quarto_update_extension <- function(
   extension = NULL,
@@ -44,16 +43,20 @@ quarto_update_extension <- function(
   # This will ask for approval or stop installation
   approval <- check_extension_approval(
     no_prompt,
-    "Quarto extensions",
+    "Quarto extension",
     "https://quarto.org/docs/extensions/managing.html"
   )
 
-  if (approval) {
-    args <- c(extension, "--no-prompt", if (quiet) cli_arg_quiet(), quarto_args)
-    quarto_update(args, quarto_bin = quarto_bin, echo = TRUE)
+  if (!approval) {
+    return(invisible(FALSE))
   }
 
-  invisible()
+  args <- c(extension, "--no-prompt", if (quiet) cli_arg_quiet(), quarto_args)
+  quarto_update(args, quarto_bin = quarto_bin, echo = TRUE)
+  if (!quiet) {
+    cli::cli_inform("Extension {.code {extension}} updated.")
+  }
+  invisible(TRUE)
 }
 
 quarto_update <- function(args = character(), ...) {

man/quarto_remove_extensions.Rd renamed to man/quarto_remove_extension.Rd

@@ -3,6 +3,7 @@ test_that("Installing an extension", {
   skip_if_offline("github.com")
   qmd <- local_qmd_file(c("content"))
   withr::local_dir(dirname(qmd))
+  rlang::local_interactive(FALSE)
   expect_error(
     quarto_add_extension("quarto-ext/fontawesome"),
     "explicit approval"

man/quarto_update_extension.Rd

@@ -3,18 +3,21 @@ test_that("Updating an extension", {
   skip_if_offline("github.com")
   qmd <- local_qmd_file(c("content"))
   withr::local_dir(dirname(qmd))
-  expect_error(
-    quarto_add_extension("quarto-ext/[email protected]"),
-    "explicit approval"
+  quarto_add_extension(
+    "quarto-ext/[email protected]",
+    no_prompt = TRUE,
+    quiet = TRUE
   )
+  expect_equal(quarto_list_extensions()$Version, "0.0.1")
   quarto_update_extension(
     "quarto-ext/fontawesome",
     no_prompt = TRUE,
     quiet = TRUE
   )
   expect_true(dir.exists("_extensions/quarto-ext/fontawesome"))
-  current_version <- yaml::read_yaml(
-    "_extensions/quarto-ext/fontawesome/_extension.yml"
-  )$version
-  expect_false(identical(current_version, "v0.0.1"))
+  expect_true(
+    as.numeric_version(current_version <- quarto_list_extensions()$Version) >
+      "0.0.1"
+  )
+  expect_false(identical(current_version, "0.0.1"))
 })