1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
#' Signal an error, warning or message with a cli formatted
#' message
#'
#' These functions let you create error, warning or diagnostic
#' messages with cli formatting, including inline styling,
#' pluralization and glue substitutions.
#'
#' @details
#'
#' ```{asciicast cli-abort}
#' n <- "boo"
#' cli_abort(c(
#' "{.var n} must be a numeric vector",
#' "x" = "You've supplied a {.cls {class(n)}} vector."
#' ))
#' ```
#'
#' ```{asciicast cli-abort-2}
#' len <- 26
#' idx <- 100
#' cli_abort(c(
#' "Must index an existing element:",
#' "i" = "There {?is/are} {len} element{?s}.",
#' "x" = "You've tried to subset element {idx}."
#' ))
#' ```
#'
#' @param message It is formatted via a call to [cli_bullets()].
#' @param ... Passed to [rlang::abort()], [rlang::warn()] or
#' [rlang::inform()].
#' @param .envir Environment to evaluate the glue expressions in.
#' @inheritParams rlang::abort
#'
#' @seealso These functions support [inline markup][inline-markup].
#' @family functions supporting inline markup
#' @export
cli_abort <- function(message,
...,
call = .envir,
.envir = parent.frame(),
.frame = .envir) {
message[] <- vcapply(message, format_inline, .envir = .envir)
rlang::abort(
message,
...,
call = call,
use_cli_format = TRUE,
.frame = .frame
)
}
#' @rdname cli_abort
#' @export
cli_warn <- function(message, ..., .envir = parent.frame()) {
rlang::warn(
format_warning(message, .envir = .envir),
...
)
}
#' @rdname cli_abort
#' @export
cli_inform <- function(message, ..., .envir = parent.frame()) {
rlang::inform(
format_message(message, .envir = .envir),
...
)
}
|
