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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
|
# usethis theme ----------------------------------------------------------------
usethis_theme <- function() {
list(
# add a "todo" bullet, which is intended to be seen as an unchecked checkbox
".bullets .bullet-_" = list(
"text-exdent" = 2,
before = function(x) paste0(cli::col_red(cli::symbol$checkbox_off), " ")
),
# historically, usethis has used yellow for this
".bullets .bullet-i" = list(
"text-exdent" = 2,
before = function(x) paste0(cli::col_yellow(cli::symbol$info), " ")
),
# we have enough color going on already, don't add color to `*` bullets
".bullets .bullet-*" = list(
"text-exdent" = 2,
before = function(x) paste0(cli::symbol$bullet, " ")
),
# apply quotes to `.field` if we can't style it with color
span.field = list(transform = single_quote_if_no_color)
)
}
single_quote_if_no_color <- function(x) quote_if_no_color(x, "'")
quote_if_no_color <- function(x, quote = "'") {
# copied from googledrive
# TODO: if a better way appears in cli, use it
# @gabor says: "if you want to have before and after for the no-color case
# only, we can have a selector for that, such as:
# span.field::no-color
# (but, at the time I write this, cli does not support this yet)
if (cli::num_ansi_colors() > 1) {
x
} else {
paste0(quote, x, quote)
}
}
# silence -----------------------------------------------------------------
#' Suppress usethis's messaging
#'
#' Execute a bit of code without usethis's normal messaging.
#'
#' @param code Code to execute with usual UI output silenced.
#'
#' @returns Whatever `code` returns.
#' @export
#' @examples
#' # compare the messaging you see from this:
#' browse_github("usethis")
#' # vs. this:
#' ui_silence(
#' browse_github("usethis")
#' )
ui_silence <- function(code) {
withr::with_options(list(usethis.quiet = TRUE), code)
}
is_quiet <- function() {
isTRUE(getOption("usethis.quiet", default = FALSE))
}
# bullets, helpers, and friends ------------------------------------------------
ui_bullets <- function(text, .envir = parent.frame()) {
if (is_quiet()) {
return(invisible())
}
cli::cli_div(theme = usethis_theme())
cli::cli_bullets(text, .envir = .envir)
}
ui_path_impl <- function(x, base = NULL) {
is_directory <- is_dir(x) | grepl("/$", x)
if (is.null(base)) {
x <- proj_rel_path(x)
} else if (!identical(base, NA)) {
x <- path_rel(x, base)
}
# rationalize trailing slashes
x <- path_tidy(x)
x[is_directory] <- paste0(x[is_directory], "/")
unclass(x)
}
# shorter form for compactness, because this is typical usage:
# ui_bullets("blah blah {.path {pth(some_path)}}")
pth <- ui_path_impl
ui_code_snippet <- function(x,
copy = rlang::is_interactive(),
language = c("R", ""),
interpolate = TRUE,
.envir = parent.frame()) {
language <- arg_match(language)
indent <- function(x, first = " ", indent = first) {
x <- gsub("\n", paste0("\n", indent), x)
paste0(first, x)
}
x <- glue_collapse(x, "\n")
if (interpolate) {
x <- glue(x, .envir = .envir)
# what about literal `{` or `}`?
# use `interpolate = FALSE`, if appropriate
# double them, i.e. `{{` or `}}`
# open issue/PR about adding `.open` and `.close`
}
if (!is_quiet()) {
# the inclusion of `.envir = .envir` leads to test failure
# I'm consulting with Gabor on this
# leaving it out seems fine for my use case
# cli::cli_code(indent(x), language = language, .envir = .envir)
cli::cli_code(indent(x), language = language)
}
if (copy && clipr::clipr_available()) {
x_no_ansi <- cli::ansi_strip(x)
clipr::write_clip(x_no_ansi)
style_subtle <- cli::combine_ansi_styles(
cli::make_ansi_style("grey"),
cli::style_italic
)
ui_bullets(c(" " = style_subtle("[Copied to clipboard]")))
}
invisible(x)
}
# inspired by gargle::gargle_map_cli() and gargle::bulletize()
usethis_map_cli <- function(x, ...) UseMethod("usethis_map_cli")
#' @export
usethis_map_cli.default <- function(x, ...) {
ui_abort(c(
"x" = "Don't know how to {.fun usethis_map_cli} an object of class
{.obj_type_friendly {x}}."
))
}
#' @export
usethis_map_cli.NULL <- function(x, ...) NULL
#' @export
usethis_map_cli.character <- function(x,
template = "{.val <<x>>}",
.open = "<<", .close = ">>",
...) {
as.character(glue(template, .open = .open, .close = .close))
}
ui_pre_glue <- function(..., .envir = parent.frame()) {
glue(..., .open = "<<", .close = ">>", .envir = .envir)
}
bulletize <- function(x, bullet = "*", n_show = 5, n_fudge = 2) {
n <- length(x)
n_show_actual <- compute_n_show(n, n_show, n_fudge)
out <- utils::head(x, n_show_actual)
n_not_shown <- n - n_show_actual
out <- set_names(out, rep_along(out, bullet))
if (n_not_shown == 0) {
out
} else {
c(out, " " = glue("{cli::symbol$ellipsis} and {n_not_shown} more"))
}
}
# I don't want to do "... and x more" if x is silly, i.e. 1 or 2
compute_n_show <- function(n, n_show_nominal = 5, n_fudge = 2) {
if (n > n_show_nominal && n - n_show_nominal > n_fudge) {
n_show_nominal
} else {
n
}
}
kv_line <- function(key, value, .envir = parent.frame()) {
cli::cli_div(theme = usethis_theme())
key_fmt <- cli::format_inline(key, .envir = .envir)
# this must happen first, before `value` has been forced
value_fmt <- cli::format_inline("{.val {value}}")
# but we might actually want something other than value_fmt
if (is.null(value)) {
value <- ui_special()
}
if (inherits(value, "AsIs")) {
value_fmt <- cli::format_inline(value, .envir = .envir)
}
ui_bullets(c("*" = "{key_fmt}: {value_fmt}"))
}
ui_special <- function(x = "unset") {
force(x)
I(glue("{cli::col_grey('<[x]>')}", .open = "[", .close = "]"))
}
# errors -----------------------------------------------------------------------
ui_abort <- function(message, ..., class = NULL, .envir = parent.frame()) {
cli::cli_div(theme = usethis_theme())
nms <- names2(message)
default_nms <- rep_along(message, "i")
default_nms[1] <- "x"
nms <- ifelse(nzchar(nms), nms, default_nms)
names(message) <- nms
cli::cli_abort(
message,
class = c(class, "usethis_error"),
.envir = .envir,
...
)
}
# questions --------------------------------------------------------------------
ui_yep <- function(x,
yes = c("Yes", "Definitely", "For sure", "Yup", "Yeah", "I agree", "Absolutely"),
no = c("No way", "Not now", "Negative", "No", "Nope", "Absolutely not"),
n_yes = 1, n_no = 2, shuffle = TRUE,
.envir = parent.frame()) {
if (!is_interactive()) {
ui_abort(c(
"User input required, but session is not interactive.",
"Query: {.val {x}}"
))
}
n_yes <- min(n_yes, length(yes))
n_no <- min(n_no, length(no))
qs <- c(sample(yes, n_yes), sample(no, n_no))
if (shuffle) {
qs <- sample(qs)
}
cli::cli_inform(x, .envir = .envir)
out <- utils::menu(qs)
out != 0L && qs[[out]] %in% yes
}
ui_nah <- function(x,
yes = c("Yes", "Definitely", "For sure", "Yup", "Yeah", "I agree", "Absolutely"),
no = c("No way", "Not now", "Negative", "No", "Nope", "Absolutely not"),
n_yes = 1, n_no = 2, shuffle = TRUE,
.envir = parent.frame()) {
# TODO(jennybc): is this correct in the case of no selection / cancelling?
!ui_yep(
x = x, yes = yes, no = no,
n_yes = n_yes, n_no = n_no,
shuffle = shuffle,
.envir = .envir
)
}
|