tweak quarto_list_extensions()

Author: cderv

NAMESPACE

@@ -41,5 +41,4 @@ importFrom(rstudioapi,isAvailable)
 importFrom(rstudioapi,viewer)
 importFrom(tools,vignetteEngine)
 importFrom(utils,browseURL)
-importFrom(utils,read.table)
 importFrom(yaml,write_yaml)

NEWS.md

@@ -1,5 +1,8 @@
 # quarto (development version)
 
+- Add several new wrapper function: 
+  - `quarto_list_extensions()` to list installed extensions using `quarto list extensions`
+
 - `quarto_preview()` gains a `quiet` argument to suppress any output from R or Quarto CLI (thanks, @cwickham, #232.)
 
 - Add some helpers function `theme_brand_*` and `theme_colors_*` to help theme with dark and light brand using some common graph and table packages (thanks,  @gordonwoodhull, [#234](https://github.com/quarto-dev/quarto-r/issues/234)).

R/list.R

@@ -2,35 +2,33 @@
 #'
 #' List Quarto Extensions in this folder or project by running `quarto list`
 #'
-#' @inheritParams quarto_render
+#' @return A data frame with the installed extensions or NULL (invisibly) if no extensions are installed.
 #'
 #' @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_list_extensions <- function() {
   quarto_bin <- find_quarto()
 
-  args <- c("extensions", if (quiet) cli_arg_quiet(), quarto_args)
-  x <- quarto_list(args, quarto_bin = quarto_bin, echo = TRUE)
+  # quarto list extensions --quiet will return nothing so we need to prevent that.
+  args <- c("extensions")
+  x <- quarto_list(args, quarto_bin = quarto_bin, echo = FALSE)
   # 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(
+    utils::read.table(
       text = stderr_cleaned,
       header = TRUE,
       fill = TRUE,
       sep = "",
       stringsAsFactors = FALSE
-    ))
+    )
   }
 }
 

man/quarto_list_extensions.Rd

@@ -0,0 +1,17 @@
+# Listing extensions
+
+    Code
+      quarto_list_extensions()
+    Output
+                            Id Version Contributes
+      1 quarto-ext/fontawesome   1.2.0  shortcodes
+
+---
+
+    Code
+      quarto_list_extensions()
+    Output
+                            Id Version Contributes
+      1 quarto-ext/fontawesome   1.2.0  shortcodes
+      2    quarto-ext/lightbox   0.1.9     filters
+

tests/testthat/_snaps/list.md

@@ -1,13 +1,15 @@
 test_that("Listing extensions", {
+  # don't try to install extensions on CRAN
+  skip_on_cran()
   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)
+  expect_snapshot(quarto_list_extensions())
   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)
+  expect_snapshot(quarto_list_extensions())
 })