tweak quarto_remove_extensions

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_extension)
+export(quarto_remove_extensions)
 export(quarto_render)
 export(quarto_serve)
 export(quarto_update_extension)

NEWS.md

@@ -2,6 +2,7 @@
 
 - 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_preview()` gains a `quiet` argument to suppress any output from R or Quarto CLI (thanks, @cwickham, #232.)
 

R/remove.R

@@ -2,39 +2,39 @@
 #'
 #' Remove an extension in this folder or project by running `quarto remove`
 #'
-#' # Extension Trust
-#'
-#' Quarto extensions may execute code when documents are rendered. Therefore, if
-#' you do not trust the author of an extension, we recommend that you do not
-#' install or use the extension.
-#' By default `no_prompt = FALSE` which means that
-#' the function will ask for explicit approval when used interactively, or
-#' disallow installation.
-#'
 #' @inheritParams quarto_render
 #'
-#' @param extension The extension to remove, either an archive or a GitHub
-#'   repository as described in the documentation
-#'   <https://quarto.org/docs/extensions/managing.html>.
+#' @param extension The extension name to remove, as in `quarto remove <extension-name>`.
 #'
 #' @param no_prompt Do not prompt to confirm approval to download external extension.
 #'
+#'
+#' @return Returns invisibly `TRUE` if the extension was removed, `FALSE` otherwise.
+#'
+#' @seealso `quarto_add_extension()` and [Quarto Website](https://quarto.org/docs/extensions/managing.html).
+#'
 #' @examples
 #' \dontrun{
 #' # Remove an already installed extension
-#' quarto_remove_extension("quarto-ext/fontawesome")
+#' quarto_remove_extensions("quarto-ext/fontawesome")
 #' }
-#' @importFrom rlang is_interactive
-#' @importFrom cli cli_abort
 #' @export
-quarto_remove_extension <- function(
+quarto_remove_extensions <- function(
   extension = NULL,
   no_prompt = FALSE,
   quiet = FALSE,
   quarto_args = NULL
 ) {
   rlang::check_required(extension)
 
+  installed_extensions <- quarto_list_extensions()
+  if (is.null(installed_extensions)) {
+    if (!quiet) {
+      cli::cli_alert_warning("No extensions installed.")
+    }
+    return(invisible(FALSE))
+  }
+
   quarto_bin <- find_quarto()
 
   # This will ask for approval or stop installation
@@ -46,10 +46,15 @@ quarto_remove_extension <- function(
 
   if (approval) {
     args <- c(extension, "--no-prompt", if (quiet) cli_arg_quiet(), quarto_args)
-    quarto_remove(args, quarto_bin = quarto_bin, echo = TRUE)
+    quarto_remove(args, quarto_bin = quarto_bin, echo = FALSE)
+    if (!quiet) {
+      cli::cli_alert_success(
+        "Extension {.code {extension}} successfully removed."
+      )
+    }
   }
 
-  invisible()
+  invisible(TRUE)
 }
 
 quarto_remove <- function(args = character(), ...) {

R/utils-prompt.R

@@ -1,7 +1,9 @@
-check_extension_approval <- function(
+check_approval <- function(
   no_prompt = FALSE,
   what = "Something",
-  see_more_at = NULL
+  see_more_at = NULL,
+  prompt_message = NULL,
+  interactive_info = NULL # could use `{ what }` as used in `cli_inform()`
 ) {
   if (no_prompt) return(TRUE)
 
@@ -14,54 +16,57 @@ check_extension_approval <- function(
       }
     ))
   } else {
-    cli::cli_inform(c(
-      "{what} may execute code when documents are rendered. ",
-      "*" = "If you do not trust the author(s) of this {what}, we recommend that you do not install or use this {what}."
-    ))
-    prompt_value <- tolower(readline(sprintf(
-      "Do you trust the authors of this %s (Y/n)? ",
-      what
-    )))
-    if (!prompt_value %in% "y") {
-      cli::cli_inform("{what} not installed.")
-      return(invisible(FALSE))
-    } else {
-      return(invisible(TRUE))
+    if (!is.null(interactive_info)) {
+      cli::cli_inform(interactive_info)
+    }
+    prompt_value <- tolower(readline(prompt_message))
+    if (!prompt_value %in% c("", "y")) {
+      cli::cli_inform(paste0(what, " not installed."))
     }
-    return(invisible(TRUE))
+    return(invisible(FALSE))
   }
+  return(invisible(TRUE))
 }
 
-check_removal_approval <- function(
+check_extension_approval <- function(
   no_prompt = FALSE,
   what = "Something",
   see_more_at = NULL
 ) {
-  if (no_prompt) return(TRUE)
+  interactive_info <- c(
+    "{what} may execute code when documents are rendered. ",
+    "*" = "If you do not trust the author(s) of this {what}, we recommend that you do not install or use this {what}."
+  )
 
-  if (!is_interactive()) {
-    cli::cli_abort(c(
-      "{ what } requires explicit approval.",
-      ">" = "Set {.arg no_prompt = TRUE} if you agree.",
-      if (!is.null(see_more_at)) {
-        c(i = "See more at {.url {see_more_at}}")
-      }
-    ))
-  } else {
-    prompt_value <- tolower(readline(sprintf(
-      "? Are you sure you'd like to remove %s (Y/n)? ",
-      what
-    )))
-    if (!prompt_value %in% "y") {
-      return(invisible(FALSE))
-    }
-    return(invisible(TRUE))
-  }
+  prompt_message <- sprintf(
+    "Do you trust the authors of this %s (Y/n)? ",
+    what
+  )
+
+  check_approval(
+    no_prompt = no_prompt,
+    what = what,
+    see_more_at = see_more_at,
+    prompt_message = prompt_message,
+    interactive_info = interactive_info
+  )
 }
 
-# Add binding to base R function for testthat mocking
-readline <- NULL
-# Add binding to function from other package for mocking later on
-is_interactive <- function(...) {
-  rlang::is_interactive(...)
+check_removal_approval <- function(
+  no_prompt = FALSE,
+  what = "Something",
+  see_more_at = NULL
+) {
+  prompt_message <- sprintf(
+    "Are you sure you'd like to remove %s (Y/n)? ",
+    what
+  )
+
+  check_approval(
+    no_prompt = no_prompt,
+    what = what,
+    see_more_at = see_more_at,
+    prompt_message = prompt_message,
+    interactive_info = NULL
+  )
 }

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

@@ -0,0 +1,14 @@
+# Removing an extension
+
+    Code
+      expect_false(quarto_remove_extension("quarto-ext/fontawesome", no_prompt = TRUE))
+    Message
+      ! No extensions installed.
+
+---
+
+    Code
+      expect_true(quarto_remove_extension("quarto-ext/fontawesome", no_prompt = TRUE))
+    Message
+      v Extension `quarto-ext/fontawesome` successfully removed.
+

tests/testthat/_snaps/remove.md

@@ -3,17 +3,15 @@ test_that("Removing an extension", {
   skip_if_offline("github.com")
   qmd <- local_qmd_file(c("content"))
   withr::local_dir(dirname(qmd))
-  expect_null(quarto_remove_extension(
+  expect_snapshot(expect_false(quarto_remove_extension(
     "quarto-ext/fontawesome",
-    no_prompt = TRUE,
-    quiet = TRUE
-  ))
+    no_prompt = TRUE
+  )))
   quarto_add_extension("quarto-ext/fontawesome", no_prompt = TRUE, quiet = TRUE)
   expect_true(dir.exists("_extensions/quarto-ext/fontawesome"))
-  quarto_remove_extension(
+  expect_snapshot(expect_true(quarto_remove_extension(
     "quarto-ext/fontawesome",
-    no_prompt = TRUE,
-    quiet = TRUE
-  )
-  expect_true(!dir.exists("_extensions/quarto-ext/fontawesome"))
+    no_prompt = TRUE
+  )))
+  expect_false(dir.exists("_extensions"))
 })