Use cli errors

r-lib · Oct 31, 2023 · 7034774 · 7034774
1 parent b617333
commit 7034774
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 17 deletions.
diff --git a/R/debug.R b/R/debug.R
@@ -10,7 +10,7 @@ debug_levels <- c(
 get_debug_level <- function() {
   lvl <- tolower(Sys.getenv("ASCIICAST_DEBUG_LEVEL", "fatal"))
   if (!lvl %in% names(debug_levels)) {
-    stop(cli::format_error(c(
+    throw(cli::format_error(c(
       "Invalid asciicast debug level in {.env ASCIICAST_DEBUG_LEVEL env
        var: {.code lvl}.",
       i = "It must be one of {.code {names(debug_levels)}}."

diff --git a/R/frames.R b/R/frames.R
@@ -26,7 +26,9 @@ load_frames <- function(cast, height = NA, width = NA) {
 
   ct <- load_svg_term()
   ldjs <- system.file("load-cast.js", package = "asciicast")
-  if (ldjs == "") stop("Internal error, cannot find 'load-cast.js'")
+  if (ldjs == "") {
+    throw(cli::format_error("Internal error, cannot find {.file load-cast.js}."))
+  }
   ct$source(ldjs)
 
   ct$assign("json", json)

diff --git a/R/gif.R b/R/gif.R
@@ -36,7 +36,7 @@ write_gif <- function(cast, path, show = NULL, cols = NULL,
                       optimize = TRUE) {
   with_cli_process("Finding phantom.js", {
     phexe <- find_phantom()
-    if (is.null(phexe)) stop("No phantom.js, exiting.")
+    if (is.null(phexe)) throw(cli::format_error("No phantom.js, exiting."))
   })
 
   frames <- load_frames(cast)

diff --git a/R/install-phantomjs.R b/R/install-phantomjs.R
@@ -73,10 +73,9 @@ install_phantomjs <- function(version = "2.1.1",
   }
   unlink(c(zipdir, zipfile), recursive = TRUE)
   if (!success) {
-    stop(
-      "Unable to install PhantomJS to any of these dirs: ",
-      paste(dirs, collapse = ", ")
-    )
+    throw(cli::format_error(c(
+      "Unable to install PhantomJS to {?/any of} {?this/these} dir{?s}: {.or {.path {dirs}}}."
+    )))
   }
   if (!quiet) {
     message("phantomjs has been installed to ", normalizePath(destdir))

diff --git a/R/knitr.R b/R/knitr.R
@@ -100,7 +100,7 @@ eng_asciicast <- function(options) {
 
   proc <- .GlobalEnv$.knitr_asciicast_process
   if (!is.null(proc) && !proc$is_alive()) {
-    stop("asciicast subprocess crashed")
+    throw(cli::format_error("asciicast subprocess crashed"))
   }
   cast <- record(
     cast_file,
@@ -150,7 +150,7 @@ eng_asciicastcpp11 <- function(options) {
 
     proc <- .GlobalEnv$.knitr_asciicast_process
     if (!is.null(proc) && !proc$is_alive()) {
-      stop("asciicast subprocess crashed") # nocov
+      throw(cli::format_error("asciicast subprocess crashed")) # nocov
     }
 
     cast <- record(cast_file, process = proc)

diff --git a/R/merge.R b/R/merge.R
@@ -65,7 +65,7 @@ merge_casts <- function(...) {
   casts <- lapply(list(...), handle_merge_cast)
   types <- map_chr(casts, "[[", "type")
   if (!"cast" %in% types) {
-    stop("You need to include at least one cast in `merge_cast()`.")
+    throw(cli::format_error("You need to include at least one cast in {.fn merge_casts}."))
   }
   wconf <- which(types == "cast")[[1]]
   new_cast <- structure(

diff --git a/R/svg.R b/R/svg.R
@@ -101,11 +101,10 @@ is_svg_supported <- function() {
 
 check_svg_support <- function() {
   if (!is_svg_supported()) {
-    stop(
-      "Writing SVG files needs a more recent Node library, see the ",
-      "documentation of the V8 package, e.g. ",
-      "https://github.com/jeroen/v8#readme"
-    )
+    throw(cli::format_error(c(
+      "Writing SVG files needs a more recent Node library.",
+      i = "See the documentation of the V8 package: {.url https://github.com/jeroen/v8#readme}."
+    )))
   }
 }
 
@@ -438,7 +437,7 @@ play_svg <- function(path) {
   } else {
     tmpsvg <- tempfile("asciicast", fileext = ".svg")
     if (!file.copy(path, tmpsvg)) {
-      stop(cli::format_error(c(
+      throw(cli::format_error(c(
         "Cannot copy {.path {path}} to {.path {tmpsvg}}."
       )))
     }

diff --git a/R/write-json.R b/R/write-json.R
@@ -1,5 +1,10 @@
 as_json <- function(cast) {
-  stopifnot(inherits(cast, "asciicast"))
+  if (!inherits(cast, "asciicast")) {
+    throw(cli::format_error(c(
+      "{.var cast} must be an {.cls asciicast}, object.",
+      i = "It is a {.type {cast}}."
+    )))
+  }
   con <- textConnection(NULL, "w", local = TRUE)
   on.exit(close(con), add = TRUE)
   write_json_con(cast, con)