Use cli functions

DESCRIPTION

@@ -22,7 +22,7 @@ Depends:
 Imports: 
     bslib (>= 0.3.1),
     callr (>= 3.7.3),
-    cli,
+    cli (>= 3.6.1),
     desc (>= 1.4.0),
     digest,
     downlit (>= 0.4.0),

NEWS.md

@@ -1,5 +1,6 @@
 # pkgdown (development version)
 
+* Use [cli](https://github.com/r-lib/cli) to provide interactive feedback. 
 * Preserve Markdown code blocks with class rmd from roxygen2 docs (@salim-b, #2298).
 * Avoid unwanted linebreaks from parsing `DESCRIPTION` (@salim-b, #2247).
 * Remove redundant entries in the documentation index when multiple explicit `@usage` tags are provided (@klmr, #2302)

R/build-articles.R

@@ -177,7 +177,7 @@ build_articles <- function(pkg = ".",
     return(invisible())
   }
 
-  rule("Building articles")
+  cli::cli_h2("Building articles")
 
   build_articles_index(pkg)
   purrr::walk(
@@ -207,7 +207,7 @@ build_article <- function(name,
   # allow code sharing with building of the index.
   vig <- match(name, pkg$vignettes$name)
   if (is.na(vig)) {
-    stop("Can't find article called ", src_path(name), call. = FALSE)
+    cli::cli_abort("Can't find article {.file {name}}")
   }
 
   input <- pkg$vignettes$file_in[vig]
@@ -368,12 +368,8 @@ data_articles_index <- function(pkg = ".") {
   missing <- setdiff(pkg$vignettes$name, c(listed, pkg$package))
 
   if (length(missing) > 0) {
-    abort(
-      paste0(
-        "Vignettes missing from index: ",
-        paste(missing, collapse = ", ")
-      ),
-      call. = FALSE
+    cli::cli_abort(
+        "Vignette{?s} missing from index: {missing}"
     )
   }
 
@@ -385,7 +381,9 @@ data_articles_index <- function(pkg = ".") {
 
 data_articles_index_section <- function(section, pkg) {
   if (!set_contains(names(section), c("title", "contents"))) {
-    abort("Section must have components `title`, `contents`")
+    cli::cli_abort(
+      "Section must have components {.field title, contents}"
+    )
   }
 
   # Match topics against any aliases
@@ -424,7 +422,6 @@ default_articles_index <- function(pkg = ".") {
     return(NULL)
   }
 
-
   print_yaml(list(
     list(
       title = tr_("All vignettes"),

R/build-favicons.R

@@ -19,20 +19,23 @@ build_favicons <- function(pkg = ".", overwrite = FALSE) {
   rlang::check_installed("openssl")
   pkg <- as_pkgdown(pkg)
 
-  rule("Building favicons")
+  cli::cli_h2("Building favicons")
 
   logo_path <- find_logo(pkg$src_path)
 
   if (is.null(logo_path)) {
-    stop("Can't find package logo PNG or SVG to build favicons.", call. = FALSE)
+    cli::cli_abort("Can't find package logo PNG or SVG to build favicons.")
   }
 
   if (has_favicons(pkg) && !overwrite) {
-    message("Favicons already exist in `pkgdown/`. Set `overwrite = TRUE` to re-create.")
+    cli::cli_inform(c(
+      "Favicons already exist in {.path pkgdown}",
+      "i" = "Set {.var overwrite = TRUE} to re-create."
+    ))
     return(invisible())
   }
 
-  message("Building favicons with realfavicongenerator.net...")
+  cli::cli_inform("Building favicons with {.url https://realfavicongenerator.net} ...")
 
   logo <- readBin(logo_path, what = "raw", n = fs::file_info(logo_path)$size)
 
@@ -66,17 +69,18 @@ build_favicons <- function(pkg = ".", overwrite = FALSE) {
     quiet = TRUE
   )
   if (httr::http_error(resp)) {
-    stop("API request failed.", call. = FALSE)
+    cli::cli_abort("API request failed.")
   }
 
   content <- httr::content(resp)
   result <- content$favicon_generation_result
 
   if (!identical(result$result$status, "success")) {
-    stop(
-      "API request failed. ", "
-      Please submit bug report to <https://github.com/r-lib/pkgdown/issues>",
-      call. = FALSE
+    cli::cli_abort(
+      c(
+        "API request failed.",
+        "i" = "{.href [Please submit a bug report](https://github.com/r-lib/pkgdown/issues)}"
+      )
     )
   }
 
@@ -93,10 +97,10 @@ build_favicons <- function(pkg = ".", overwrite = FALSE) {
     utils::unzip(tmp, exdir = path(pkg$src_path, "pkgdown", "favicon"))
   },
   warning = function(e) {
-    abort("Your logo file couldn't be processed and may be corrupt.", parent = e)
+    cli::cli_abort("Your logo file couldn't be processed and may be corrupt.")
   },
   error = function(e) {
-    abort("Your logo file couldn't be processed and may be corrupt.", parent = e)
+    cli::cli_abort("Your logo file couldn't be processed and may be corrupt.")
   })
 
   invisible()
@@ -107,10 +111,10 @@ build_favicons <- function(pkg = ".", overwrite = FALSE) {
 #' @inheritParams build_favicons
 #' @export
 build_favicon <- function(pkg, overwrite) {
-  message(
-    "`build_favicon()` is deprecated as of pkgdown 1.4.0. ",
-    "Please use `build_favicons()` instead."
-  )
+  cli::cli_warn(c(
+    "{.fun build_favicon} is deprecated as of pkgdown 1.4.0. ",
+    "i" = "Please use {.fun build_favicons} instead."
+  ))
   build_favicons(pkg, overwrite)
 }
 

R/build-github.R

@@ -25,7 +25,7 @@ build_site_github_pages <- function(pkg = ".",
  pkg <- as_pkgdown(pkg, override = list(destination = dest_dir))
 
   if (clean) {
-    rule("Cleaning files from old site", line = 1)
+    cli::cli_h2("Cleaning files from old site")
     clean_site(pkg)
   }
 
@@ -36,7 +36,7 @@ build_site_github_pages <- function(pkg = ".",
 }
 
 build_github_pages <- function(pkg = ".") {
-  rule("Extra files for GitHub pages")
+  cli::cli_h2("Extra files for GitHub pages")
   pkg <- as_pkgdown(pkg)
 
   # Add .nojekyll since site is static HTML

R/build-home-authors.R

@@ -56,12 +56,12 @@ data_home_sidebar_authors <- function(pkg = ".") {
   bullets <- c(
     markdown_text_inline(
       pkg$meta$authors$sidebar$before,
-      pkgdown_field(pkg, c("authors", "sidebar", "before"))
+      pkgdown_field(c("authors", "sidebar", "before"))
     ),
     authors,
     markdown_text_inline(
       pkg$meta$authors$sidebar$after,
-      pkgdown_field(pkg, c("authors", "sidebar", "after"))
+      pkgdown_field(c("authors", "sidebar", "after"))
     )
   )
 
@@ -96,7 +96,7 @@ author_name <- function(x, authors, pkg) {
   if (!is.null(author$html)) {
     name <- markdown_text_inline(
       author$html,
-      pkgdown_field(pkg, c("authors", name, "html"))
+      pkgdown_field(c("authors", name, "html"))
     )
   }
 
@@ -186,8 +186,8 @@ role_lookup <- function(abbr) {
 
   out <- unname(roles[abbr])
   if (any(is.na(out))) {
-    missing <- paste0("'", abbr[is.na(out)], "'", collapse = ", ")
-    warn(paste0("Unknown MARC role abbreviation ", missing))
+    missing <- abbr[is.na(out)]
+    cli::cli_warn("Unknown MARC role abbreviation{?s}: {.field {missing}}")
     out[is.na(out)] <- abbr[is.na(out)]
   }
   out

R/build-home-index.R

@@ -64,13 +64,12 @@ data_home_sidebar <- function(pkg = ".") {
 
   if (length(html_path)) {
     if (!file.exists(html_path)) {
-      abort(
-        sprintf(
-          "Can't find file '%s' specified by %s.",
-          pkg$meta$home$sidebar$html,
-          pkgdown_field(pkg, c("home", "sidebar", "html"))
-        )
-      )
+      rel_html_path <- fs::path_rel(html_path, pkg$src_path)
+      rel_config_path <- pkgdown_config_relpath(pkg)
+      cli::cli_abort(c(
+        "Can't locate {.file {rel_html_path}}",
+        "x" = "{.field {pkgdown_field(c('home', 'sidebar', 'html'))}} in {.file {rel_config_path}} is misconfigured"
+      ))
     }
     return(read_file(html_path))
   }
@@ -215,10 +214,10 @@ check_missing_images <- function(pkg, src_path, dst_path) {
   exists <- fs::file_exists(path(pkg$dst_path, rel_path))
 
   if (any(!exists)) {
-    paths <- encodeString(rel_src[!exists], quote = "'")
-    warn(c(
-      paste0("Missing images in '", src_path, "': ", paste0(paths, collapse = ", ")),
-      i = "pkgdown can only use images in 'man/figures' and 'vignettes'"
+    paths <- rel_src[!exists]
+    cli::cli_warn(c(
+      "Missing images in {.file {src_path}}: {.file {paths}}",
+      "i" = "pkgdown can only use images in {.file man/figures} and {.file vignettes}"
     ))
   }
 }

R/build-home-md.R

@@ -22,7 +22,7 @@ build_home_md <- function(pkg) {
 }
 
 render_md <- function(pkg, filename) {
-  cat_line("Reading ", src_path(path_rel(filename, pkg$src_path)))
+  cli::cli_alert_info("Reading {src_path(path_rel(filename, pkg$src_path))}")
 
   body <- markdown_body(filename, strip_header = TRUE)
   path <- path_ext_set(basename(filename), "html")

R/build-home.R

@@ -31,7 +31,7 @@ build_home <- function(pkg = ".",
                        quiet = TRUE) {
 
   pkg <- section_init(pkg, depth = 0L, override = override)
-  rule("Building home")
+  cli::cli_h2("Building home")
   dir_create(pkg$dst_path)
 
   build_citation_authors(pkg)

R/build-news.R

@@ -78,7 +78,7 @@ build_news <- function(pkg = ".",
   if (!has_news(pkg$src_path))
     return()
 
-  rule("Building news")
+  cli::cli_h2("Building news")
   dir_create(path(pkg$dst_path, "news"))
 
   switch(news_style(pkg$meta),
@@ -151,7 +151,7 @@ data_news <- function(pkg = list()) {
   sections <- xml2::xml_find_all(xml, "./body/div")
   footnotes <- has_class(sections, "footnotes")
   if (any(footnotes)) {
-    warn("Footnotes in NEWS.md are not currently supported")
+    cli::cli_warn("Footnotes in NEWS.md are not currently supported")
   }
   sections <- sections[!footnotes]
 
@@ -160,10 +160,10 @@ data_news <- function(pkg = list()) {
     xml2::xml_name()
   ulevels <- unique(levels)
   if (!identical(ulevels, "h1") && !identical(ulevels, "h2")) {
-    abort(c(
+    cli::cli_abort(c(
       "Invalid NEWS.md: inconsistent use of section headings.",
-      i = "Top-level headings must be either all <h1> or all <h2>.",
-      i = "See ?build_news for more details."
+      "i" = "Top-level headings must be either all <h1> or all <h2>.",
+      "i" = "See {.help pkgdown::build_news} for more details."
     ))
   }
   if (ulevels == "h1") {

R/build-redirects.R

@@ -11,9 +11,9 @@ build_redirects <- function(pkg = ".",
     return(invisible())
   }
 
-  rule("Building redirects")
+  cli::cli_h2("Building redirects")
   if (is.null(pkg$meta$url)) {
-    abort(sprintf("%s required to generate redirects", pkgdown_field(pkg, "url")))
+    cli::cli_abort("{.field {pkgdown_field('url')}} in {.file {pkgdown_config_relpath(pkg)}} required to generate redirects")
   }
 
   purrr::iwalk(
@@ -25,12 +25,8 @@ build_redirects <- function(pkg = ".",
 
 build_redirect <- function(entry, index, pkg) {
   if (!is.character(entry) || length(entry) != 2) {
-    abort(
-      sprintf(
-        "Entry %s in %s must be a character vector of length 2.",
-        index,
-        pkgdown_field(pkg, "redirects")
-      )
+    cli::cli_abort(
+      "Entry {.emph {index}} in {.field {pkgdown_field('redirects')}} must be a character vector of length 2.",
     )
   }
 

R/build-reference-index.R

@@ -69,17 +69,10 @@ check_all_characters <- function(contents, index, pkg) {
   any_null <- any(null)
 
   if (any_null) {
-    abort(
-      c(
-        sprintf(
-          "Item %s in section %s in %s is empty.",
-          toString(which(null)),
-          index,
-          pkgdown_field(pkg, "reference")
-        ),
-        i = "Either delete the empty line or add a function name."
-      )
-    )
+    cli::cli_abort(c(
+      "Item {.field {which(null)}} in section {index} in {.field {pkgdown_field('reference')}} is empty.",
+      i = "Either delete the empty line or add a function name in {.file {pkgdown_config_relpath(pkg)}}."
+    ))
   }
 
   not_char <- !purrr::map_lgl(contents, is.character)
@@ -89,17 +82,10 @@ check_all_characters <- function(contents, index, pkg) {
     return(invisible())
   }
 
-  abort(
-    c(
-      sprintf(
-        "Item %s in section %s in %s must be a character.",
-        toString(which(not_char)),
-        index,
-        pkgdown_field(pkg, "reference")
-      ),
-      i = "You might need to add '' around e.g. - 'N' or - 'off'."
-    )
-  )
+  cli::cli_abort(c(
+    "Item {.field {which(not_char)}} in section {index} in {.field {pkgdown_field('reference')}} must be a character.",
+    i = "You might need to add '' around e.g. - 'N' or - 'off' in {.file {pkgdown_config_relpath(pkg)}}."
+  ))
 
 }
 

R/build-reference.R

@@ -162,11 +162,11 @@ build_reference <- function(pkg = ".",
   pkg <- section_init(pkg, depth = 1L, override = override)
 
   if (!missing(document)) {
-    warning("`document` is deprecated. Please use `devel` instead.", call. = FALSE)
+    cli::cli_warn("{.var document} is deprecated. Please use {.var devel} instead.")
     devel <- document
   }
 
-  rule("Building function reference")
+  cli::cli_h2("Building function reference")
   build_reference_index(pkg)
 
   copy_figures(pkg)
@@ -274,7 +274,7 @@ build_reference_topic <- function(topic,
   if (lazy && !out_of_date(in_path, out_path))
     return(invisible())
 
-  cat_line("Reading ", src_path("man", topic$file_in))
+  cli::cli_alert_info("Reading {src_path(path('man', topic$file_in))}")
 
   data <- withCallingHandlers(
     data_reference_topic(

R/build-search-docs.R

@@ -45,7 +45,7 @@ build_sitemap <- function(pkg = ".") {
   }
 
   xml_path <- path(pkg$dst_path, "sitemap.xml")
-  cat_line("Writing ", dst_path(path_rel(xml_path, pkg$dst_path)))
+  cli::cli_alert_info("Writing {dst_path(path_rel(xml_path, pkg$dst_path))}")
 
   xml2::write_xml(doc, file = xml_path)
 
@@ -86,7 +86,7 @@ url_node <- function(url) {
 build_search <- function(pkg = ".",
                          override = list()) {
   pkg <- section_init(pkg, depth = 1L, override = override)
-  rule("Building search index")
+  cli::cli_alert("Building search index")
   search_index <- build_search_index(pkg)
   jsonlite::write_json(
     search_index,