Add CLI wrapper for extensions : list, remove, update

NAMESPACE

@@ -5,14 +5,17 @@ export(quarto_add_extension)
 export(quarto_binary_sitrep)
 export(quarto_create_project)
 export(quarto_inspect)
+export(quarto_list_extensions)
 export(quarto_path)
 export(quarto_preview)
 export(quarto_preview_stop)
 export(quarto_publish_app)
 export(quarto_publish_doc)
 export(quarto_publish_site)
+export(quarto_remove_extension)
 export(quarto_render)
 export(quarto_serve)
+export(quarto_update_extension)
 export(quarto_use_template)
 export(quarto_version)
 import(rlang)
@@ -28,4 +31,5 @@ importFrom(rstudioapi,isAvailable)
 importFrom(rstudioapi,viewer)
 importFrom(tools,vignetteEngine)
 importFrom(utils,browseURL)
+importFrom(utils,read.table)
 importFrom(yaml,write_yaml)

R/list.R

@@ -0,0 +1,33 @@
+#' List Installed Quarto extensions
+#'
+#' List Quarto Extensions in this folder or project by running `quarto list`
+#'
+#' @inheritParams quarto_render
+#'
+#' @examples
+#' \dontrun{
+#' # List Quarto Extensions in this folder or project
+#' quarto_list_extensions()
+#' }
+#'
+#' @importFrom rlang is_interactive
+#' @importFrom cli cli_abort
+#' @importFrom utils read.table
+#' @export
+quarto_list_extensions <- function(quiet = FALSE, quarto_args = NULL){
+  quarto_bin <- find_quarto()
+
+  args <- c("extensions", if (quiet) cli_arg_quiet(), quarto_args)
+  x <- quarto_list(args, quarto_bin = quarto_bin, echo = TRUE)
+  # Clean the stderr output to remove extra spaces and ensure consistent formatting
+  stderr_cleaned <- gsub("\\s+$", "", x$stderr)
+  if (grepl("No extensions are installed", stderr_cleaned)) {
+    invisible()
+  } else{
+    invisible(utils::read.table(text = stderr_cleaned, header = TRUE, fill = TRUE, sep = "", stringsAsFactors = FALSE))
+  }
+}
+
+quarto_list <- function(args = character(), ...){
+  quarto_run_what("list", args = args, ...)
+}

R/remove.R

@@ -0,0 +1,48 @@
+#' Remove a Quarto extensions
+#'
+#' 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 no_prompt Do not prompt to confirm approval to download external extension.
+#'
+#' @examples
+#' \dontrun{
+#' # Remove an already installed extension
+#' quarto_remove_extension("quarto-ext/fontawesome")
+#' }
+#' @importFrom rlang is_interactive
+#' @importFrom cli cli_abort
+#' @export
+quarto_remove_extension <- function(extension = NULL, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL) {
+  rlang::check_required(extension)
+
+  quarto_bin <- find_quarto()
+
+  # This will ask for approval or stop installation
+  approval <- check_removal_approval(no_prompt, extension, "https://quarto.org/docs/extensions/managing.html")
+
+  if (approval) {
+    args <- c(extension, "--no-prompt", if (quiet) cli_arg_quiet(), quarto_args)
+    quarto_remove(args, quarto_bin = quarto_bin, echo = TRUE)
+  }
+
+  invisible()
+}
+
+quarto_remove <- function(args = character(), ...) {
+  quarto_run_what("remove", args = args, ...)
+}

R/update.R

@@ -0,0 +1,52 @@
+#' Update a Quarto extensions
+#'
+#' Update an extension to this folder or project by running `quarto update`
+#'
+#' # 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 update, either an archive or a GitHub
+#'   repository as described in the documentation
+#'   <https://quarto.org/docs/extensions/managing.html>.
+#'
+#' @param no_prompt Do not prompt to confirm approval to download external extension.
+#'
+#' @examples
+#' \dontrun{
+#' # Update a template and set up a draft document from a GitHub repository
+#' quarto_update_extension("quarto-ext/fontawesome")
+#'
+#' # 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, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL) {
+  rlang::check_required(extension)
+
+  quarto_bin <- find_quarto()
+
+  # This will ask for approval or stop installation
+  approval <- check_extension_approval(no_prompt, "Quarto extensions", "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)
+  }
+
+  invisible()
+}
+
+quarto_update <- function(args = character(), ...) {
+  quarto_run_what("update", args = args, ...)
+}

R/utils-prompt.R

@@ -1,7 +1,7 @@
 check_extension_approval <- function(no_prompt = FALSE, what = "Something", see_more_at = NULL) {
   if (no_prompt) return(TRUE)
 
-  if (!rlang::is_interactive()) {
+  if (!is_interactive()) {
     cli::cli_abort(c(
       "{ what } requires explicit approval.",
       ">" = "Set {.arg no_prompt = TRUE} if you agree.",
@@ -19,5 +19,33 @@ check_extension_approval <- function(no_prompt = FALSE, what = "Something", see_
       cli::cli_inform("{what} not installed.")
       return(invisible(FALSE))
     }
+    return(invisible(TRUE))
   }
 }
+
+check_removal_approval <- function(no_prompt = FALSE, what = "Something", see_more_at = NULL) {
+  if (no_prompt) return(TRUE)
+
+  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))
+  }
+}
+
+# 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(...)
+}

tests/testthat/test-list.R

@@ -0,0 +1,13 @@
+test_that("Listing extensions", {
+  skip_if_no_quarto()
+  skip_if_offline("github.com")
+  qmd <- local_qmd_file(c("content"))
+  withr::local_dir(dirname(qmd))
+  expect_null(quarto_list_extensions())
+  quarto_add_extension("quarto-ext/fontawesome", no_prompt = TRUE, quiet = TRUE)
+  expect_true(dir.exists("_extensions/quarto-ext/fontawesome"))
+  expect_equal(nrow(quarto_list_extensions()), 1)
+  quarto_add_extension("quarto-ext/lightbox", no_prompt = TRUE, quiet = TRUE)
+  expect_true(dir.exists("_extensions/quarto-ext/lightbox"))
+  expect_equal(nrow(quarto_list_extensions()), 2)
+})

tests/testthat/test-remove.R

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

tests/testthat/test-update.R

@@ -0,0 +1,11 @@
+test_that("Updating an extension", {
+  skip_if_no_quarto()
+  skip_if_offline("github.com")
+  qmd <- local_qmd_file(c("content"))
+  withr::local_dir(dirname(qmd))
+  expect_error(quarto_add_extension("quarto-ext/fontawesome@v0.0.1"), "explicit approval")
+  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"))
+})