Use cli in messages

DESCRIPTION

@@ -24,7 +24,6 @@ Depends:
 Imports: 
     cli (>= 3.0.1),
     clipr (>= 0.3.0),
-    crayon,
     curl (>= 2.7),
     desc (>= 1.4.2),
     fs (>= 1.3.0),
@@ -43,7 +42,7 @@ Imports:
     whisker,
     withr (>= 2.3.0),
     yaml
-Suggests: 
+Suggests:
     covr,
     knitr,
     magick,

NEWS.md

@@ -1,5 +1,7 @@
 # usethis (development version)
 
+* usethis now uses cli internally for its messaging. (#956, @olivroy)
+
 # usethis 2.2.2
 
 * Implicit usage of `numeric_version()` via comparison now always provides

R/author.R

@@ -61,11 +61,11 @@ use_author <- function(given = NULL, family = NULL, ..., role = "ctb") {
   aut_fmt <- format(author, style = 'text')
   if (authors_at_r_already) {
     ui_done("
-      Adding to {ui_field('Authors@R')} in DESCRIPTION:
+      Adding to {ui_field('Authors@R')} in DESCRIPTION:\f
       {aut_fmt}")
   } else {
     ui_done("
-      Creating {ui_field('Authors@R')} field in DESCRIPTION and adding:
+      Creating {ui_field('Authors@R')} field in DESCRIPTION and adding:\f
       {aut_fmt}")
   }
   d$add_author(given = given, family = family, role = role, ...)
@@ -84,15 +84,14 @@ challenge_legacy_author_fields <- function(d = proj_desc()) {
     return(invisible())
   }
 
-  ui_oops("
-    Found legacy {ui_field('Author')} and/or {ui_field('Maintainer')} field \\
-    in DESCRIPTION.
-    usethis only supports modification of the {ui_field('Authors@R')} field.")
-  ui_info("
-    We recommend one of these paths forward:
-    * Delete these fields and rebuild with {ui_code('use_author()')}.
-    * Convert to {ui_field('Authors@R')} with {ui_code('desc::desc_coerce_authors_at_r()')},
-      then delete the legacy fields.")
+  ui_oops(c("Found legacy {ui_field('Author')} and/or {ui_field('Maintainer')} field in DESCRIPTION.",
+    "usethis only supports modification of the {ui_field('Authors@R')} field."))
+  ui_info(c(
+    "We recommend one of these paths forward:",
+    "*" = "Delete these fields and rebuild with {.run usethis::use_author()}.",
+    "*" = "Convert to {ui_field('Authors@R')} with {.fn desc::desc_coerce_authors_at_r},
+           \f\u00a0\u00a0 then delete the legacy fields."
+    ))
   if (ui_yeah("Do you want to cancel this operation and sort that out first?")) {
     ui_stop("Cancelling.")
   }
@@ -130,8 +129,8 @@ challenge_default_author <- function(d = proj_desc()) {
 
   if (any(m)) {
     ui_info("
-      {ui_field('Authors@R')} appears to include a placeholder author:
-      {format(default_author, style = 'text')}")
+      {ui_field('Authors@R')} appears to include a placeholder author:\f
+      {format({default_author}, style = 'text')}")
     if(is_interactive() && ui_yeah("Would you like to remove it?")) {
       # TODO: Do I want to suppress this output?
       # Authors removed: First Last, NULL NULL.

R/badge.R

@@ -45,7 +45,7 @@ use_badge <- function(badge_name, href, src) {
   if (is.null(path)) {
     ui_oops("
     Can't find a README for the current project.
-    See {ui_code('usethis::use_readme_rmd()')} for help creating this file.
+    See {.help usethis::use_readme_rmd} for help creating this file.
     Badge link can only be printed to screen.
     ")
     path <- "README"
@@ -59,7 +59,7 @@ use_badge <- function(badge_name, href, src) {
   )
 
   if (changed && path_ext(path) == "Rmd") {
-    ui_todo("Re-knit {ui_path(path)} with {ui_code('devtools::build_readme()')}")
+    ui_todo("Re-knit {ui_path(path)} with {.run devtools::build_readme()}")
   }
   invisible(changed)
 }

R/create.R

@@ -89,7 +89,7 @@ create_project <- function(path,
   } else {
     ui_done("Writing a sentinel file {ui_path('.here')}")
     ui_todo("Build robust paths within your project via {ui_code('here::here()')}")
-    ui_todo("Learn more at <https://here.r-lib.org>")
+    ui_todo("Learn more at {.url https://here.r-lib.org}")
     file_create(proj_path(".here"))
   }
 

R/data.R

@@ -68,7 +68,7 @@ use_data <- function(...,
   check_files_absent(proj_path(paths), overwrite = overwrite)
 
   ui_done("Saving {ui_value(unlist(objs))} to {ui_value(paths)}")
-  if (!internal) ui_todo("Document your data (see {ui_value('https://r-pkgs.org/data.html')})")
+  if (!internal) ui_todo("Document your data (see {.url https://r-pkgs.org/data.html})")
 
   envir <- parent.frame()
   mapply(

R/git-default-branch.R

@@ -529,9 +529,7 @@ challenge_non_default_branch <- function(details = "Are you sure you want to pro
 }
 
 report_fishy_files <- function(old_name = "master", new_name = "main") {
-  ui_todo("
-    Be sure to update files that refer to the default branch by name.
-    Consider searching within your project for {ui_value(old_name)}.")
+  ui_todo("Be sure to update files that refer to the default branch by name. Consider searching within your project for {ui_value(old_name)}.")
   # I don't want failure of a fishy file check to EVER cause
   # git_default_branch_rename() to fail and prevent the call to
   # git_default_branch_rediscover()

R/github-actions.R

@@ -121,7 +121,7 @@ use_github_action <- function(name = NULL,
   }
 
   if (!is.null(readme)) {
-    ui_todo("Learn more at <{readme}>.")
+    ui_todo("Learn more at {.url {readme}}.")
   }
 
   badge <- badge %||% is_check_action(url)
@@ -215,7 +215,7 @@ use_github_actions_badge <- function(name = "R-CMD-check.yaml",
 use_tidy_github_actions <- function(ref = NULL) {
   repo_spec <- target_repo_spec()
 
-  use_github_action("check-full.yaml", ref = ref, badge = TRUE)
+  use_github_action("check-full", ref = ref, badge = TRUE)
 
   use_github_action("pr-commands", ref = ref)
   use_github_action("pkgdown", ref = ref)
@@ -231,6 +231,7 @@ use_tidy_github_actions <- function(ref = NULL) {
       "Remove existing {ui_path('.travis.yml')} and {ui_path('appveyor.yml')}?"
     )) {
       file_delete(old_configs[has_appveyor_travis])
+      # TODO maybe add ui_path("README.Rmd") or ui_path("README.md")?
       ui_todo("Remove old badges from README")
     }
   }

R/github.R

@@ -153,7 +153,7 @@ use_github <- function(organisation = NULL,
   )
   withr::defer(view_url(create$html_url))
 
-  ui_done("Setting remote {ui_value('origin')} to {ui_value(origin_url)}")
+  ui_done("Setting remote {ui_value('origin')} to {.url {origin_url}}")
   use_git_remote("origin", origin_url)
 
   if (is_package()) {

R/helpers.R

@@ -58,7 +58,7 @@ use_dependency <- function(package, type, min_version = NULL) {
     # don't downgrade
     ui_warn(
       "Package {ui_value(package)} is already listed in \\
-       {ui_value(existing_type)} in DESCRIPTION, no change made."
+       {ui_field(existing_type)} in {ui_path('DESCRIPTION')}, no change made."
     )
   } else if (delta == 0 && !is.null(min_version)) {
     # change version
@@ -67,7 +67,7 @@ use_dependency <- function(package, type, min_version = NULL) {
     if (upgrade) {
       ui_done(
         "Increasing {ui_value(package)} version to {ui_value(version)} in \\
-         DESCRIPTION")
+         {ui_path('DESCRIPTION')}")
       desc$set_dep(package, type, version = version)
       desc$write()
       changed <- TRUE
@@ -99,10 +99,10 @@ version_spec <- function(x) {
 view_url <- function(..., open = is_interactive()) {
   url <- paste(..., sep = "/")
   if (open) {
-    ui_done("Opening URL {ui_value(url)}")
+    ui_done("Opening URL {.url {url}}")
     utils::browseURL(url)
   } else {
-    ui_todo("Open URL {ui_value(url)}")
+    ui_todo("Open URL {.url {url}}")
   }
   invisible(url)
 }

R/lifecycle.R

@@ -34,12 +34,15 @@ use_lifecycle <- function() {
   purrr::walk(templ_files, file_copy, dest_dir, overwrite = TRUE)
   ui_done("Copied SVG badges to {ui_path(dest_dir)}")
 
-  ui_todo(c(
-    "Add badges in documentation topics by inserting one of:",
-    "#' `r lifecycle::badge('experimental')`",
-    "#' `r lifecycle::badge('superseded')`",
-    "#' `r lifecycle::badge('deprecated')`"
-  ))
+  ui_todo("Add badges in documentation topics by inserting one of:")
+  if (!is_quiet()) {
+    # to preserve white spaces
+    cli::cli_bullets(c(
+      " " = "#' `r lifecycle::badge('experimental')`",
+      " " = "#' `r lifecycle::badge('superseded')`",
+      " " = "#' `r lifecycle::badge('deprecated')`"
+    ))
+  }
 
   invisible(TRUE)
 }

R/news.R

@@ -50,10 +50,10 @@ use_news_heading <- function(version) {
   if (development_title == news[[1]]) {
     news[[1]] <- title
 
-    ui_done("Replacing development heading in NEWS.md")
+    ui_done("Replacing development heading in {.file NEWS.md}")
     return(write_utf8(news_path, news))
   }
 
-  ui_done("Adding new heading to NEWS.md")
+  ui_done("Adding new heading to {.file NEWS.md}")
   write_utf8(news_path, c(title, "", news))
 }

R/package.R

@@ -169,12 +169,12 @@ suggests_usage_hint <- function(package) {
     code2 <- glue('rlang::check_installed("{package}")')
     ui_todo("
       In your package code, use {ui_code(code1)} or {ui_code(code2)} to test \\
-      if {package} is installed")
+      if {package} is installed.")
     code <- glue("{package}::fun()")
     ui_todo("Then directly refer to functions with {ui_code(code)}")
   } else {
     code <- glue("requireNamespace(\"{package}\", quietly = TRUE)")
-    ui_todo("Use {ui_code(code)} to test if package is installed")
+    ui_todo("Use {ui_code(code)} to test if {package} is installed.")
     code <- glue("{package}::fun()")
     ui_todo("Then directly refer to functions with {ui_code(code)}")
   }

R/pkgdown.R

@@ -106,7 +106,7 @@ use_pkgdown_url <- function(url, tr = NULL) {
   gh <- gh_tr(tr)
   homepage <- gh("GET /repos/{owner}/{repo}")[["homepage"]]
   if (is.null(homepage) || homepage != url) {
-    ui_done("Setting {ui_value(url)} as homepage of GitHub repo \\
+    ui_done("Setting {.url {url}} as homepage of GitHub repo \\
       {ui_value(tr$repo_spec)}")
     gh("PATCH /repos/{owner}/{repo}", homepage = url)
   }

R/pr.R

@@ -401,7 +401,7 @@ pr_push <- function() {
     pr_create()
   } else {
     ui_todo("
-      View PR at {ui_value(pr$pr_html_url)} or call {ui_code('pr_view()')}.")
+      View PR at {.url {pr$pr_html_url}} or call {.run usethis::pr_view()}.")
   }
 
   invisible()

R/release.R

@@ -391,7 +391,7 @@ get_release_news <- function(SHA = gert::git_info(repo = git_repo())$commit,
 
   if (is.null(news)) {
     ui_oops("
-      Can't find {ui_path('NEWS.md')} in the released package source.
+      Can't find {.val NEWS.md} in the released package source.
       usethis consults this file for release notes.
       Call {ui_code('usethis::use_news_md()')} to set this up for the future.")
     if (on_cran) "-- no release notes --" else "Initial release"