Suggests: cli

[JanMarvin]

If anybody would want to work on this, I would be willing to accept a PR that adds cli as an optional package that if loaded, or otherwise available, will improve our printing.

Why don't I do it myself? Well, designing user interfaces obviously isn't my strong suit (the current default output is a bit ... random at best). What I absolutely want to avoid is a hard dependency. In the absence of cli the package should work just as is.

library(cli)
print_workbook_summary <- function(wb, file_path = NULL) {
  
  if (!is.null(file_path))
    wb <- openxlsx2::wb_load(file_path)
  
  # Extract details
  sheets <- wb$get_sheet_names()
  write_order <- wb$sheetOrder
  
  cli_h1("Workbook Details")
  
  if (!is.null(wb$path)) {
    cli_text("{.bold File Path:} {wb$path}")
  }
  
  cli_text("{.bold Total Worksheets:} {length(sheets)}")
  
  cli_h3("{.bold Worksheet Names:}")
  cli_ul(sheets)
  
  cli_h3("{.bold Write Order:}")
  cli_ul(as.character(write_order))
  
  cli_alert_success("Workbook loaded and summarized.")
}

fl <- system.file("extdata", "openxlsx2_example.xlsx", package = "openxlsx2")
wb <- openxlsx2::wb_load(file = fl)

## without cli
wb
#> A Workbook object.
#>  
#> Worksheets:
#>  Sheets: Sheet1, Sheet2 
#>  Write order: 1, 2

## with cli
print_workbook_summary(wb, file_path = fl)
#> 
#> ── Workbook Details ────────────────────────────────────────────────────────────
#> File Path:
#> /home/jmg/R/x86_64-pc-linux-gnu-library/4.4/openxlsx2/extdata/openxlsx2_example.xlsx
#> Total Worksheets: 2
#> 
#> ── Worksheet Names:
#> • Sheet1
#> • Sheet2
#> 
#> ── Write Order:
#> • 1
#> • 2
#> ✔ Workbook loaded and summarized.

[JanMarvin]

Something like this should work:

diff --git a/R/class-workbook.R b/R/class-workbook.R
index 40f61409..fd197aa1 100644
--- a/R/class-workbook.R
+++ b/R/class-workbook.R
@@ -6855,28 +6855,44 @@ wbWorkbook <- R6::R6Class(
       nImages <- length(self$media)
       nCharts <- length(self$charts)
 
-      showText <- "A Workbook object.\n"
+      out <- list(
+        title = "A Workbook object.\n",
+        sheets = self$get_sheet_names(),
+        order = self$sheetOrder
+      )
+
+      if (!isNamespaceLoaded("cli")) {
 
-      ## worksheets
-      if (nSheets > 0) {
-        showText <- c(showText, "\nWorksheets:\n")
-        sheetTxt <- sprintf("Sheets: %s", paste(exSheets, collapse = ", "))
+        cat(out$title)
 
-        showText <- c(showText, sheetTxt, "\n")
+        ## worksheets
+        if (nSheets > 0) {
+          cat("\nWorksheets:\n")
+          cat(sprintf("Sheets: %s", paste(out$sheets, collapse = ", ")))
+          cat("\n")
+        } else {
+          cat("\nWorksheets:\n", "No worksheets attached\n")
+        }
+        if (nSheets > 0) {
+          cat(
+            sprintf("Write order: %s", stringi::stri_join(out$order, sep = " ", collapse = ", "))
+          )
+        }
       } else {
-        showText <-
-          c(showText, "\nWorksheets:\n", "No worksheets attached\n")
-      }
 
-      if (nSheets > 0) {
-        showText <-
-          c(showText, sprintf(
-            "Write order: %s",
-            stringi::stri_join(self$sheetOrder, sep = " ", collapse = ", ")
-          ))
-      }
+        cli::cli_h1(out$title)
+        cli::cli_h3("{.bold Worksheets:}")
+        if (nSheets > 0) {
+          cli::cli_ul(out$sheets)
+        } else {
+          cli::cli_alert_danger("No worksheets attached")
+        }
+        if (nSheets > 0) {
+          cli::cli_h3("{.bold Order:}")
+          cli::cli_ul(as.character(out$sheets))
+        }
 
-      cat(unlist(showText))
+      }
       invisible(self)
     },
 

Needs a change to a test, because cli is always loaded when checking a package (at least in Rstudio).

[JanMarvin]

This will create the following:

fl <- system.file("extdata", "openxlsx2_example.xlsx", package = "openxlsx2")
wb <- openxlsx2::wb_load(file = fl)

library(cli)
wb
#> 
#> ── A Workbook object. ──────────────────────────────────────────────────────────
#> 
#> ── Worksheets:
#> • Sheet1
#> • Sheet2
#> 
#> ── Order:
#> • Sheet1
#> • Sheet2

unloadNamespace("cli")
wb
#> A Workbook object.
#> 
#> Worksheets:
#> Sheets: Sheet1, Sheet2
#> Write order: 1, 2