Use {cli} for formatting condition messages

DESCRIPTION

@@ -24,6 +24,7 @@ Depends:
     R (>= 3.6)
 Imports:
     backports (>= 1.1.7),
+    cli,
     codetools,
     cyclocomp,
     digest,
@@ -36,7 +37,6 @@ Imports:
     xmlparsedata (>= 1.0.5)
 Suggests:
     bookdown,
-    cli,
     httr (>= 1.2.1),
     jsonlite,
     patrick (>= 0.2.0),

R/addins.R

@@ -1,11 +1,11 @@
 # nocov start
 addin_lint <- function() {
   if (!requireNamespace("rstudioapi", quietly = TRUE)) {
-    stop("'rstudioapi' is required for add-ins.", call. = FALSE)
+    cli::cli_abort("{.pkg rstudioapi} is required for add-ins.")
   }
   filename <- rstudioapi::getSourceEditorContext()
   if (filename$path == "") {
-    return("Current source has no path. Please save before continue")
+    return("Current source has no path. Please save before continue.")
   }
 
   config_file <- (get("find_config", asNamespace("lintr")))(filename$path)
@@ -16,7 +16,7 @@ addin_lint <- function() {
     config_linters <- config[["linters"]]
   }
   linters <- if (length(config_linters) == 0L) {
-    message("No configuration found. Using default linters.")
+    cli::cli_inform("No configuration found. Using default linters.")
     default_linters
   } else {
     eval(parse(text = config_linters))
@@ -27,12 +27,14 @@ addin_lint <- function() {
 
 addin_lint_package <- function() {
   if (!requireNamespace("rstudioapi", quietly = TRUE)) {
-    stop("'rstudioapi' is required for add-ins.", call. = FALSE)
+    cli::cli_abort("{.pkg rstudioapi} is required for add-ins.")
   }
   project <- rstudioapi::getActiveProject()
   project_path <- if (is.null(project)) getwd() else project
 
-  if (is.null(project)) message("No project found, passing current directory")
+  if (is.null(project)) {
+    cli::cli_inform("No project found, passing current directory")
+  }
 
   lintr::lint_package(project_path)
 }

R/backport_linter.R

@@ -90,7 +90,7 @@ normalize_r_version <- function(r_version) {
     version_names <- c("devel", "release", paste0("oldrel-", seq_len(length(minor_versions) - 2L)))
     if (!r_version %in% version_names) {
       # This can only trip if e.g. oldrel-99 is requested
-      stop("`r_version` must be a version number or one of ", toString(sQuote(version_names)), call. = FALSE)
+      cli::cli_abort("{.var r_version} must be a version number or one of {toString(sQuote(version_names))}")
     }
     requested_version <- minor_versions[match(r_version, table = version_names)]
     available_patches <- all_versions[startsWith(all_versions, requested_version)]
@@ -102,13 +102,10 @@ normalize_r_version <- function(r_version) {
   } else if (is.character(r_version)) {
     r_version <- R_system_version(r_version, strict = TRUE)
   } else if (!inherits(r_version, "R_system_version")) {
-    stop("`r_version` must be a R version number, returned by R_system_version(), or a string.", call. = FALSE)
+    cli::cli_abort("{.var r_version} must be an R version number, returned by {.fun R_system_version}, or a string.")
   }
   if (r_version < "3.0.0") {
-    warning(
-      "It is not recommended to depend on an R version older than 3.0.0. Resetting 'r_version' to 3.0.0.",
-      call. = FALSE
-    )
+    cli::cli_warn("Depending on an R version older than 3.0.0 is not recommended. Resetting {.var r_version} to 3.0.0.")
     r_version <- R_system_version("3.0.0")
   }
   r_version

tests/testthat/_snaps/backport_linter.md

@@ -0,0 +1,8 @@
+# backport_linter produces error when R version misspecified
+
+    Code
+      lint(text = "numToBits(2)", linters = backport_linter(420L))
+    Condition
+      Error in `normalize_r_version()`:
+      ! `r_version` must be an R version number, returned by `R_system_version()`, or a string.
+

tests/testthat/_snaps/settings.md

@@ -0,0 +1,10 @@
+# read_config_file() bubbles up warnings helpfully, without erroring (#2253)
+
+    Code
+      lint_dir()
+    Condition
+      Warning:
+      Warning encountered while loading config:
+        Warning from config setting 'linters' in 'NULL':
+          Depending on an R version older than 3.0.0 is not recommended. Resetting `r_version` to 3.0.0.
+

tests/testthat/test-backport_linter.R

@@ -1,8 +1,7 @@
 test_that("backport_linter produces error when R version misspecified", {
-  expect_error(
+  expect_snapshot(
     lint(text = "numToBits(2)", linters = backport_linter(420L)),
-    "`r_version` must be a R version number, returned by R_system_version(), or a string.",
-    fixed = TRUE
+    error = TRUE
   )
 })
 

tests/testthat/test-settings.R

@@ -271,7 +271,7 @@ test_that("read_config_file() bubbles up warnings helpfully, without erroring (#
   withr::local_dir(withr::local_tempdir())
 
   writeLines("a <- 1", "aaa.R")
-  expect_warning(lint_dir(), "Warning from config setting 'linters'.*Resetting 'r_version' to 3.0.0")
+  expect_snapshot(lint_dir())
 })
 
 test_that("perl-only regular expressions are accepted in config", {