}}\preformatted{\{.style [link text](url)\}
}\if{html}{\out{
}}
\subsection{Vectorization}{
Note that it is not possible to add link text to a vector of URLs. E.g.
this will create a list of three URLs, all clickable:
\if{html}{\out{}}\preformatted{urls <- paste0("https://httpbin.org/status/", c(200, 403, 404))
cli::cli_text("Some httpbin URLs: \{.url \{urls\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> Some httpbin URLs: <https://httpbin.org/status/200>, #> <https://httpbin.org/status/403>, and #> <https://httpbin.org/status/404>.
}}\preformatted{cli_text(
"See the cli homepage at \{.url https://cli.r-lib.org\} for details."
)
}\if{html}{\out{
}}\if{html}{\out{
#> See the cli homepage at <https://cli.r-lib.org> for details.
}}\preformatted{cli_text(
"See the \{.href [cli homepage](https://cli.r-lib.org)\} for details."
)
}\if{html}{\out{
}}\if{html}{\out{
#> See the cli homepage for details.
}}\preformatted{local(\{
withr::local_options(cli.hyperlink = FALSE)
cli_text(
"See the cli homepage at \{.url https://cli.r-lib.org\} for details."
)
cli_text(
"See the \{.href [cli homepage](https://cli.r-lib.org)\} for details."
)
\})
}\if{html}{\out{
}}\if{html}{\out{
#> See the cli homepage at <https://cli.r-lib.org> for details. #> See the cli homepage (<https://cli.r-lib.org>) for details.
}}\preformatted{weirdurl <- utils::URLencode("https://example.com/has some spaces")
cli_text("See more at \{.url \{weirdurl\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> See more at <https://example.com/has%20some%20spaces>.
}}\preformatted{cli_text("... edit your \{.file ~/.Rprofile\} file.\}")
}\if{html}{\out{
}}\if{html}{\out{
#> ... edit your ~/.Rprofile file.\}
}}\preformatted{prof <- path.expand("~/.Rprofile")
cli_text("... edit your \{.href [R profile](file://\{prof\})\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... edit your R profile.
}}\preformatted{cli_text("... see line 5 in \{.file ~/.Rprofile:5\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... see line 5 in ~/.Rprofile:5.
}}\preformatted{local(\{
withr::local_options(cli.hyperlink = FALSE)
prof <- path.expand("~/.Rprofile")
cli_text("... edit your \{.href [R profile](file://\{prof\})\}.")
\})
}\if{html}{\out{
}}\if{html}{\out{
#> ... edit your R profile (<file:///Users/gaborcsardi/.Rprofile>).
}}\preformatted{cli::cli_text("... see \{.fun stats::lm\} to learn more.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... see `stats::lm()` to learn more.
}}\preformatted{cli::cli_text("... see \{.help [\{.fun lm\}](stats::lm)\} to learn more.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... see `lm()` to learn more.
}}\preformatted{local(\{
withr::local_options(cli.hyperlink = FALSE)
cli::cli_text("... see \{.help [\{.fun lm\}](stats::lm)\} to learn more.")
\})
}\if{html}{\out{
}}\if{html}{\out{
#> ... see `lm()` (`?stats::lm()`) to learn more.
}}\preformatted{cli::cli_text("... the tibble options at \{.topic tibble::tibble_options\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... the tibble options at tibble::tibble_options.
}}\preformatted{cli::cli_text("... see the \{.vignette tibble::types\} vignette.")
}\if{html}{\out{
}}\if{html}{\out{
#> ... see the tibble::types vignette.
}}\preformatted{cli::cli_text("Run \{.run testthat::snapshot_review()\} to review")
}\if{html}{\out{
}}\if{html}{\out{
#> Run testthat::snapshot_review() to review
}}\preformatted{cli::cli_text(
"Run \{.run [snapshot_review()](testthat::snapshot_review())\} to review"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Run snapshot_review() to review
}}\preformatted{v <- cli_vec(
c("foo", "bar", "foobar"),
style = list("vec-sep" = " & ", "vec-last" = " & ")
)
cli_text("My list: \{v\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> My list: foo & bar & foobar.
}}\preformatted{x <- cli_vec(names(mtcars), list("vec-trunc" = 3))
cli_text("Column names: \{x\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> Column names: mpg, cyl, disp, …, gear, and carb.
}}\preformatted{library(cli)
nfile <- 0; cli_text("Found \{nfile\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 0 files.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{nfile <- 1; cli_text("Found \{nfile\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 1 file.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{nfile <- 2; cli_text("Found \{nfile\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 2 files.
}\if{html}{\out{
}}
Here the value of \code{nfile} is used to decide whether the singular or
plural form of \code{file} is used. This is the most common case for English
messages.
}
\subsection{Irregular plurals}{
If the plural form is more difficult than a simple \code{s} suffix, then the
singular and plural forms can be given, separated with a forward slash:
\if{html}{\out{}}\preformatted{ndir <- 1; cli_text("Found \{ndir\} director\{?y/ies\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 1 directory.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{ndir <- 5; cli_text("Found \{ndir\} director\{?y/ies\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 5 directories.
}\if{html}{\out{
}}
}
\subsection{Use \code{"no"} instead of zero}{
For readability, it is better to use the \code{no()} helper function to
include a count in a message. \code{no()} prints the word \code{"no"} if the count
is zero, and prints the numeric count otherwise:
\if{html}{\out{}}\preformatted{nfile <- 0; cli_text("Found \{no(nfile)\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found no files.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{nfile <- 1; cli_text("Found \{no(nfile)\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 1 file.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{nfile <- 2; cli_text("Found \{no(nfile)\} file\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 2 files.
}\if{html}{\out{
}}
}
\subsection{Use the length of character vectors}{
With the auto-collapsing feature of cli it is easy to include a list of
objects in a message. When cli interprets a character vector as a
pluralization quantity, it takes the length of the vector:
\if{html}{\out{}}\preformatted{pkgs <- "pkg1"
cli_text("Will remove the \{.pkg \{pkgs\}\} package\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Will remove the pkg1 package.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{pkgs <- c("pkg1", "pkg2", "pkg3")
cli_text("Will remove the \{.pkg \{pkgs\}\} package\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Will remove the pkg1, pkg2, and pkg3 packages.
}\if{html}{\out{
}}
Note that the length is only used for non-numeric vectors (when
\code{is.numeric(x)} return \code{FALSE}). If you want to use the length of a
numeric vector, convert it to character via \code{as.character()}.
You can combine collapsed vectors with \code{"no"}, like this:
\if{html}{\out{}}\preformatted{pkgs <- character()
cli_text("Will remove \{?no/the/the\} \{.pkg \{pkgs\}\} package\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Will remove no packages.
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{pkgs <- c("pkg1", "pkg2", "pkg3")
cli_text("Will remove \{?no/the/the\} \{.pkg \{pkgs\}\} package\{?s\}.")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Will remove the pkg1, pkg2, and pkg3 packages.
}\if{html}{\out{
}}
When the pluralization markup contains three alternatives, like above,
the first one is used for zero, the second for one, and the third one
for larger quantities.
}
\subsection{Choosing the right quantity}{
When the text contains multiple glue \code{{}} substitutions, the one right
before the pluralization markup is used. For example:
\if{html}{\out{}}\preformatted{nfiles <- 3; ndirs <- 1
cli_text("Found \{nfiles\} file\{?s\} and \{ndirs\} director\{?y/ies\}")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> Found 3 files and 1 directory
}\if{html}{\out{
}}
This is sometimes not the the correct one. You can explicitly specify
the correct quantity using the \code{qty()} function. This sets that quantity
without printing anything:
\if{html}{\out{}}\preformatted{nupd <- 3; ntotal <- 10
cli_text("\{nupd\}/\{ntotal\} \{qty(nupd)\} file\{?s\} \{?needs/need\} updates")
}\if{html}{\out{
}}
\if{html}{\out{}}\preformatted{#> 3/10 files need updates
}\if{html}{\out{
}}
Note that if the message only contains a single \code{{}} substitution, then
this may appear before or after the pluralization markup. If the message
contains multiple \code{{}} substitutions \emph{after} pluralization markup, an
error is thrown.
Similarly, if the message contains no \code{{}} substitutions at all, but has
pluralization markup, an error is thrown.
}
}
\section{Rules}{
The exact rules of cli pluralization. There are two sets of rules. The
first set specifies how a quantity is associated with a \verb{\{?\}}
pluralization markup. The second set describes how the \verb{\{?\}} is parsed
and interpreted.
\subsection{Quantities}{
\enumerate{
\item \code{{}} substitutions define quantities. If the value of a \code{{}}
substitution is numeric (when \code{is.numeric(x)} holds), then it has to
have length one to define a quantity. This is only enforced if the
\code{{}} substitution is used for pluralization. The quantity is defined
as the value of \code{{}} then, rounded with \code{as.integer()}. If the value
of \code{{}} is not numeric, then its quantity is defined as its length.
\item If a message has \verb{\{?\}} markup but no \code{{}} substitution, an error is
thrown.
\item If a message has exactly one \code{{}} substitution, its value is used as
the pluralization quantity for all \verb{\{?\}} markup in the message.
\item If a message has multiple \code{{}} substitutions, then for each \verb{\{?\}}
markup cli uses the quantity of the \code{{}} substitution that precedes
it.
\item If a message has multiple \code{{}} substitutions and has pluralization
markup without a preceding \code{{}} substitution, an error is thrown.
}
}
\subsection{Pluralization markup}{
\enumerate{
\item Pluralization markup starts with \verb{\{?} and ends with \verb{\}}. It may not
contain \verb{\{} and \verb{\}} characters, so it may not contain \code{{}}
substitutions either.
\item Alternative words or suffixes are separated by \code{/}.
\item If there is a single alternative, then \emph{nothing} is used if
\code{quantity == 1} and this single alternative is used if
\code{quantity != 1}.
\item If there are two alternatives, the first one is used for
\code{quantity == 1}, the second one for \code{quantity != 1} (including
`\code{quantity == 0}).
\item If there are three alternatives, the first one is used for
\code{quantity == 0}, the second one for \code{quantity == 1}, and the third
one otherwise.
}
}
}
\seealso{
Other pluralization:
\code{\link{no}()},
\code{\link{pluralize}()}
}
\concept{pluralization}
cli/man/num_ansi_colors.Rd 0000644 0001762 0000144 00000013204 14521175065 015263 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/num-ansi-colors.R
\name{num_ansi_colors}
\alias{num_ansi_colors}
\alias{detect_tty_colors}
\title{Detect the number of ANSI colors to use}
\usage{
num_ansi_colors(stream = "auto")
detect_tty_colors()
}
\arguments{
\item{stream}{The stream that will be used for output, an R connection
object. It can also be a string, one of \code{"auto"}, \code{"message"},
\code{"stdout"}, \code{"stderr"}. \code{"auto"} will select \code{stdout()} if the session is
interactive and there are no sinks, otherwise it will select \code{stderr()}.}
}
\value{
Integer, the number of ANSI colors the current R session
supports for \code{stream}.
}
\description{
Certain Unix and Windows terminals, and also certain R GUIs, e.g.
RStudio, support styling terminal output using special control
sequences (ANSI sequences).
\code{num_ansi_colors()} detects if the current R session supports ANSI
sequences, and if it does how many colors are supported.
}
\details{
The detection mechanism is quite involved and it is designed to work
out of the box on most systems. If it does not work on your system,
please report a bug. Setting options and environment variables to turn
on ANSI support is error prone, because they are inherited in other
environments, e.g. knitr, that might not have ANSI support.
If you want to \emph{turn off} ANSI colors, set the \code{NO_COLOR} environment
variable to a non-empty value.
The exact detection mechanism is as follows:
\enumerate{
\item If the \code{cli.num_colors} options is set, that is returned.
\item If the \code{R_CLI_NUM_COLORS} environment variable is set to a
non-empty value, then it is used.
\item If the \code{crayon.enabled} option is set to \code{FALSE}, 1L is returned.
(This is for compatibility with code that uses the crayon package.)
\item If the \code{crayon.enabled} option is set to \code{TRUE} and the
\code{crayon.colors} option is not set, then the value of the
\code{cli.default_num_colors} option, or if it is unset, then 8L is
returned.
\item If the \code{crayon.enabled} option is set to \code{TRUE} and the
\code{crayon.colors} option is also set, then the latter is returned.
(This is for compatibility with code that uses the crayon package.)
\item If the \code{NO_COLOR} environment variable is set, then 1L is returned.
\item If we are in knitr, then 1L is returned, to turn off colors in
\code{.Rmd} chunks.
\item If \code{stream} is \code{"auto"} (the default) and there is an active
sink (either for \code{"output"} or \code{"message"}), then we return 1L.
(In theory we would only need to check the stream that will be
be actually used, but there is no easy way to tell that.)
\item If \code{stream} is not \code{"auto"}, but it is \code{stderr()} and there is an
active sink for it, then 1L is returned.
(If a sink is active for "output", then R changes the \code{stdout()}
stream, so this check is not needed.)
\item If the \code{cli.default_num_colors} option is set, then we use that.
\item If R is running inside RGui on Windows, or R.app on macOS, then we
return 1L.
\item If R is running inside RStudio, with color support, then the
appropriate number of colors is returned, usually 256L.
\item If R is running on Windows, inside an Emacs version that is recent
enough to support ANSI colors, then the value of the
\code{cli.default_num_colors} option, or if unset 8L is returned.
(On Windows, Emacs has \code{isatty(stdout()) == FALSE}, so we need to
check for this here before dealing with terminals.)
\item If \code{stream} is not the standard output or standard error in a
terminal, then 1L is returned.
\item Otherwise we use and cache the result of the terminal color
detection (see below).
}
The terminal color detection algorithm:
\enumerate{
\item If the \code{COLORTERM} environment variable is set to \code{truecolor} or
\verb{24bit}, then we return 16 million colors.
\item If the \code{COLORTERM} environment variable is set to anything else,
then we return the value of the \code{cli.num_default_colors} option,
8L if unset.
\item If R is running on Unix, inside an Emacs version that is recent
enough to support ANSI colors, then the value of the
\code{cli.default_num_colors} option is returned, or 8L if unset.
\item If we are on Windows in an RStudio terminal, then apparently
we only have eight colors, but the \code{cli.default_num_colors} option
can be used to override this.
\item If we are in a recent enough Windows 10 terminal, then there
is either true color (from build 14931) or 256 color (from
build 10586) support. You can also use the \code{cli.default_num_colors}
option to override these.
\item If we are on Windows, under ConEmu or cmder, or ANSICON is loaded,
then the value of \code{cli.default_num_colors}, or 8L if unset, is
returned.
\item Otherwise if we are on Windows, return 1L.
\item Otherwise we are on Unix and try to run \verb{tput colors} to determine
the number of colors. If this succeeds, we return its return value.
If the \code{TERM} environment variable is \code{xterm} and \code{tput}
returned 8L, we return 256L, because xterm compatible terminals
tend to support 256 colors
(\url{https://github.com/r-lib/crayon/issues/17})
You can override this with the \code{cli.default_num_colors} option.
\item If \code{TERM} is set to \code{dumb}, we return 1L.
\item If \code{TERM} starts with \code{screen}, \code{xterm}, or \code{vt100}, we return 8L.
\item If \code{TERM} contains \code{color}, \code{ansi}, \code{cygwin} or \code{linux}, we return 8L.
\item Otherwise we return 1L.
}
}
\examples{
num_ansi_colors()
}
\seealso{
Other ANSI styling:
\code{\link{ansi-styles}},
\code{\link{combine_ansi_styles}()},
\code{\link{make_ansi_style}()}
}
\concept{ANSI styling}
cli/man/ansi_regex.Rd 0000644 0001762 0000144 00000001121 14521175065 014210 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_regex}
\alias{ansi_regex}
\title{Perl compatible regular expression that matches ANSI escape
sequences}
\usage{
ansi_regex()
}
\value{
String scalar, the regular expression.
}
\description{
Don't forget to use \code{perl = TRUE} when using this with \code{\link[=grepl]{grepl()}} and
friends.
}
\seealso{
Other low level ANSI functions:
\code{\link{ansi_has_any}()},
\code{\link{ansi_hide_cursor}()},
\code{\link{ansi_string}()},
\code{\link{ansi_strip}()}
}
\concept{low level ANSI functions}
cli/man/utf8_substr.Rd 0000644 0001762 0000144 00000002007 14143453131 014351 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utf8.R
\name{utf8_substr}
\alias{utf8_substr}
\title{Substring of an UTF-8 string}
\usage{
utf8_substr(x, start, stop)
}
\arguments{
\item{x}{Character vector.}
\item{start}{Starting index or indices, recycled to match the length
of \code{x}.}
\item{stop}{Ending index or indices, recycled to match the length of
\code{x}.}
}
\value{
Character vector of the same length as \code{x}, containing
the requested substrings.
}
\description{
This function uses grapheme clusters instead of Unicode code points in
UTF-8 strings.
}
\examples{
# Five grapheme clusters, select the middle three
str <- paste0(
"\U0001f477\U0001f3ff\u200d\u2640\ufe0f",
"\U0001f477\U0001f3ff",
"\U0001f477\u200d\u2640\ufe0f",
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3ff")
cat(str)
str24 <- utf8_substr(str, 2, 4)
cat(str24)
}
\seealso{
Other UTF-8 string manipulation:
\code{\link{utf8_graphemes}()},
\code{\link{utf8_nchar}()}
}
\concept{UTF-8 string manipulation}
cli/man/make_spinner.Rd 0000644 0001762 0000144 00000006564 14300734360 014551 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/spinner.R
\name{make_spinner}
\alias{make_spinner}
\title{Create a spinner}
\usage{
make_spinner(
which = NULL,
stream = "auto",
template = "{spin}",
static = c("dots", "print", "print_line", "silent")
)
}
\arguments{
\item{which}{The name of the chosen spinner. If \code{NULL}, then the default
is used, which can be customized via the \code{cli.spinner_unicode},
\code{cli.spinner_ascii} and \code{cli.spinner} options. (The latter applies to
both Unicode and ASCII displays. These options can be set to the name
of a built-in spinner, or to a list that has an entry called \code{frames},
a character vector of frames.}
\item{stream}{The stream to use for the spinner. Typically this is
standard error, or maybe the standard output stream.
It can also be a string, one of \code{"auto"}, \code{"message"}, \code{"stdout"},
\code{"stderr"}. \code{"auto"} will select \code{stdout()} if the session is
interactive and there are no sinks, otherwise it will select
\code{stderr()}.}
\item{template}{A template string, that will contain the spinner. The
spinner itself will be substituted for \code{{spin}}. See example below.}
\item{static}{What to do if the terminal does not support dynamic
displays:
\itemize{
\item \code{"dots"}: show a dot for each \verb{$spin()} call.
\item \code{"print"}: just print the frames of the spinner, one after another.
\item \code{"print_line"}: print the frames of the spinner, each on its own line.
\item \code{"silent"} do not print anything, just the \code{template}.
}}
}
\value{
A \code{cli_spinner} object, which is a list of functions. See
its methods below.
\code{cli_spinner} methods:
\itemize{
\item \verb{$spin()}: output the next frame of the spinner.
\item \verb{$finish()}: terminate the spinner. Depending on terminal capabilities
this removes the spinner from the screen. Spinners can be reused,
you can start calling the \verb{$spin()} method again.
}
All methods return the spinner object itself, invisibly.
The spinner is automatically throttled to its ideal update frequency.
}
\description{
Create a spinner
}
\section{Examples}{
\subsection{Default spinner}{
\if{html}{\out{}}\preformatted{sp1 <- make_spinner()
fun_with_spinner <- function() \{
lapply(1:100, function(x) \{ sp1$spin(); Sys.sleep(0.05) \})
sp1$finish()
\}
ansi_with_hidden_cursor(fun_with_spinner())
}\if{html}{\out{
}}
\if{html}{\figure{make-spinner-default.svg}}
}
\subsection{Spinner with a template}{
\if{html}{\out{}}\preformatted{sp2 <- make_spinner(template = "Computing \{spin\}")
fun_with_spinner2 <- function() \{
lapply(1:100, function(x) \{ sp2$spin(); Sys.sleep(0.05) \})
sp2$finish()
\}
ansi_with_hidden_cursor(fun_with_spinner2())
}\if{html}{\out{
}}
\if{html}{\figure{make-spinner-template.svg}}
}
\subsection{Custom spinner}{
\if{html}{\out{}}\preformatted{sp3 <- make_spinner("simpleDotsScrolling", template = "Downloading \{spin\}")
fun_with_spinner3 <- function() \{
lapply(1:100, function(x) \{ sp3$spin(); Sys.sleep(0.05) \})
sp3$finish()
\}
ansi_with_hidden_cursor(fun_with_spinner3())
}\if{html}{\out{
}}
\if{html}{\figure{make-spinner-custom.svg}}
}
}
\seealso{
Other spinners:
\code{\link{demo_spinners}()},
\code{\link{get_spinner}()},
\code{\link{list_spinners}()}
}
\concept{spinners}
cli/man/cli_progress_along.Rd 0000644 0001762 0000144 00000007616 14500305721 015745 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-along.R
\name{cli_progress_along}
\alias{cli_progress_along}
\title{Add a progress bar to a mapping function or for loop}
\usage{
cli_progress_along(
x,
name = NULL,
total = length(x),
...,
.envir = parent.frame()
)
}
\arguments{
\item{x}{Sequence to add the progress bar to.}
\item{name}{Name of the progress bar, a label, passed to
\code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{total}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{...}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.envir}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
}
\value{
An index vector from 1 to \code{length(x)} that triggers progress
updates as you iterate over it.
}
\description{
Note that this function is currently experimental!
Use \code{cli_progress_along()} in a mapping function or in a for loop, to add a
progress bar. It uses \code{\link[=cli_progress_bar]{cli_progress_bar()}} internally.
}
\details{
\subsection{\code{for} loop}{
A \code{for} loop with \code{cli_progress_along()} looks like this:
\if{html}{\out{}}\preformatted{for (i in cli_progress_along(seq)) \{
...
\}
}\if{html}{\out{
}}
A complete example:
\if{html}{\out{}}\preformatted{clifun <- function() \{
for (i in cli_progress_along(1:100, "Downloading")) \{
Sys.sleep(4/100)
\}
\}
clifun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-along-1.svg}}
}
\subsection{\code{lapply()} and other mapping functions}{
They will look like this:
\if{html}{\out{}}\preformatted{lapply(cli_progress_along(X), function(i) ...)
}\if{html}{\out{
}}
A complete example:
\if{html}{\out{}}\preformatted{res <- lapply(cli_progress_along(1:100, "Downloading"), function(i) \{
Sys.sleep(4/100)
\})
}\if{html}{\out{
}}
\if{html}{\figure{progress-along-2.svg}}
}
\subsection{Custom format string}{
\if{html}{\out{}}\preformatted{clifun <- function() \{
for (i in cli_progress_along(1:100,
format = "Downloading data file \{cli::pb_current\}")) \{
Sys.sleep(4/100)
\}
\}
clifun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-along-3.svg}}
}
\subsection{Breaking out of loops}{
Note that if you use \code{break} in the \code{for} loop, you probably want to
terminate the progress bar explicitly when breaking out of the loop,
or right after the loop:
\if{html}{\out{}}\preformatted{for (i in cli_progress_along(seq)) \{
...
if (cond) cli_progress_done() && break
...
\}
}\if{html}{\out{
}}
}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
\code{\link[=cli_progress_bar]{cli_progress_bar()}} and the traditional progress bar API.
Other progress bar functions:
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{progress bar functions}
cli/man/console_width.Rd 0000644 0001762 0000144 00000002710 14143453131 014723 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/width.R
\name{console_width}
\alias{console_width}
\title{Determine the width of the console}
\usage{
console_width()
}
\value{
Integer scalar, the console with, in number of characters.
}
\description{
It uses the \code{cli.width} option, if set. Otherwise it tries to
determine the size of the terminal or console window.
}
\details{
These are the exact rules:
\itemize{
\item If the \code{cli.width} option is set to a positive integer, it is used.
\item If the \code{cli.width} option is set, but it is not a positive integer,
and error is thrown.
}
Then we try to determine the size of the terminal or console window:
\itemize{
\item If we are not in RStudio, or we are in an RStudio terminal,
then we try to use the \code{tty_size()} function to query the
terminal size. This might fail if R is not running in a terminal,
but failures are ignored.
\item If we are in the RStudio build pane, then the \code{RSTUDIO_CONSOLE_WIDTH}
environment variable is used. If the build pane is resized, then this
environment variable is not accurate any more, and the output might
get garbled.
\item We are \emph{not} using the \code{RSTUDIO_CONSOLE_WIDTH} environment variable
if we are in the RStudio console.
}
If we cannot determine the size of the terminal or console window, then
we use the \code{width} option. If the \code{width} option is not set, then
we return 80L.
}
\examples{
console_width()
}
cli/man/progress-utils.Rd 0000644 0001762 0000144 00000002113 14500305721 015057 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-utils.R
\name{cli_progress_num}
\alias{cli_progress_num}
\alias{cli_progress_cleanup}
\title{Progress bar utility functions.}
\usage{
cli_progress_num()
cli_progress_cleanup()
}
\value{
\code{cli_progress_num()} returns an integer scalar.
`cli_progress_cleanup() does not return anything.
}
\description{
Progress bar utility functions.
}
\details{
\code{cli_progress_num()} returns the number of currently
active progress bars. (These do not currently include the progress
bars created in C/C++ code.)
\code{cli_progress_cleanup()} terminates all active progress bars.
(It currently ignores progress bars created in the C/C++ code.)
}
\seealso{
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
}
\concept{progress bar functions}
cli/man/progress-c.Rd 0000644 0001762 0000144 00000015564 14262015555 014167 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/docs.R
\name{progress-c}
\alias{progress-c}
\title{The cli progress C API}
\description{
The cli progress C API
}
\section{The cli progress C API}{
\subsection{\code{CLI_SHOULD_TICK}}{
A macro that evaluates to (int) 1 if a cli progress bar update is due,
and to (int) 0 otherwise. If the timer hasn't been initialized in this
compilation unit yet, then it is always 0. To initialize the timer,
call \code{cli_progress_init_timer()} or create a progress bar with
\code{cli_progress_bar()}.
}
\subsection{\code{cli_progress_add()}}{
\if{html}{\out{}}\preformatted{void cli_progress_add(SEXP bar, double inc);
}\if{html}{\out{
}}
Add a number of progress units to the progress bar. It will also
trigger an update if an update is due.
\itemize{
\item \code{bar}: progress bar object.
\item \code{inc}: progress increment.
}
}
\subsection{\code{cli_progress_bar()}}{
\if{html}{\out{}}\preformatted{SEXP cli_progress_bar(double total, SEXP config);
}\if{html}{\out{
}}
Create a new progress bar object. The returned progress bar object
must be \code{PROTECT()}-ed.
\itemize{
\item \code{total}: Total number of progress units. Use \code{NA_REAL} if it is not
known.
\item \code{config}: R named list object of additional parameters. May be \code{NULL}
(the C \verb{NULL~) or }R_NilValue\verb{(the R}NULL`) for the defaults.
}
\code{config} may contain the following entries:
\itemize{
\item \code{name}: progress bar name.
\item \code{status}: (initial) progress bar status.
\item \code{type}: progress bar type.
\item \code{total}: total number of progress units.
\item \code{show_after}: show the progress bar after the specified number of
seconds. This overrides the global \code{show_after} option.
\item \code{format}: format string, must be specified for custom progress bars.
\item \code{format_done}: format string for successful termination.
\item \code{format_failed}: format string for unsuccessful termination.
\item \code{clear}: whether to remove the progress bar from the screen after
termination.
\item \code{auto_terminate}: whether to terminate the progress bar when the
number of current units equals the number of total progress units.
}
\subsection{Example}{
\if{html}{\out{}}\preformatted{#include
SEXP progress_test1() \{
int i;
SEXP bar = PROTECT(cli_progress_bar(1000, NULL));
for (i = 0; i < 1000; i++) \{
cli_progress_sleep(0, 4 * 1000 * 1000);
if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
\}
cli_progress_done(bar);
UNPROTECT(1);
return Rf_ScalarInteger(i);
\}
}\if{html}{\out{
}}
}
}
\subsection{\code{cli_progress_done()}}{
\if{html}{\out{}}\preformatted{void cli_progress_done(SEXP bar);
}\if{html}{\out{
}}
Terminate the progress bar.
\itemize{
\item \code{bar}: progress bar object.
}
}
\subsection{\code{cli_progress_init_timer()}}{
\if{html}{\out{}}\preformatted{void cli_progress_init_timer();
}\if{html}{\out{
}}
Initialize the cli timer without creating a progress bar.
}
\subsection{\code{cli_progress_num()}}{
\if{html}{\out{}}\preformatted{int cli_progress_num();
}\if{html}{\out{
}}
Returns the number of currently active progress bars.
}
\subsection{\code{cli_progress_set()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set(SEXP bar, double set);
}\if{html}{\out{
}}
Set the progress bar to the specified number of progress units.
\itemize{
\item \code{bar}: progress bar object.
\item \code{set}: number of current progress progress units.
}
}
\subsection{\code{cli_progress_set_clear()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set_clear(SEXP bar, int clear);
}\if{html}{\out{
}}
Set whether to remove the progress bar from the screen. You can call
this any time before \code{cli_progress_done()} is called.
\itemize{
\item \code{bar}: progress bar object.
\item \code{clear}: whether to remove the progress bar from the screen, zero or
one.
}
}
\subsection{\code{cli_progress_set_format()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set_format(SEXP bar, const char *format, ...);
}\if{html}{\out{
}}
Set a custom format string for the progress bar. This call does not
try to update the progress bar. If you want to request an update,
call \code{cli_progress_add()}, \code{cli_progress_set()} or
\code{cli_progress_update()}.
\itemize{
\item \code{bar}: progress bar object.
\item \code{format}: format string.
\item \code{...}: values to substitute into \code{format}.
}
\code{format} and \code{...} are passed to \code{vsnprintf()} to create a format
string.
Format strings may contain glue substitutions, referring to
\href{https://cli.r-lib.org/dev/reference/progress-variables.html}{progress variables}, pluralization, and cli
styling.
}
\subsection{\code{cli_progress_set_name()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set_name(SEXP bar, const char *name);
}\if{html}{\out{
}}
Set the name of the progress bar.
\itemize{
\item \code{bar}; progress bar object.
\item \code{name}: progress bar name.
}
}
\subsection{\code{cli_progress_set_status()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set_status(SEXP bar, const char *status);
}\if{html}{\out{
}}
Set the status of the progress bar.
\itemize{
\item \code{bar}: progress bar object.
\item \code{status }: progress bar status.
}
}
\subsection{\code{cli_progress_set_type()}}{
\if{html}{\out{}}\preformatted{void cli_progress_set_type(SEXP bar, const char *type);
}\if{html}{\out{
}}
Set the progress bar type. Call this function right after creating
the progress bar with \code{cli_progress_bar()}. Otherwise the behavior is
undefined.
\itemize{
\item \code{bar}: progress bar object.
\item \code{type}: progress bar type. Possible progress bar types:
\code{iterator}, \code{tasks}, \code{download} and \code{custom}.
}
}
\subsection{\code{cli_progress_update()}}{
\if{html}{\out{}}\preformatted{void cli_progress_update(SEXP bar, double set, double inc, int force);
}\if{html}{\out{
}}
Update the progress bar. Unlike the simpler \code{cli_progress_add()} and
\code{cli_progress_set()} function, it can force an update if \code{force} is
set to 1.
\itemize{
\item \code{bar}: progress bar object.
\item \code{set}: the number of current progress units. It is ignored if
negative.
\item \code{inc}: increment to add to the current number of progress units.
It is ignored if \code{set} is not negative.
\item \code{force}: whether to force an update, even if no update is due.
}
To force an update without changing the current number of progress units,
supply \code{set = -1}, \code{inc = 0} and \code{force = 1}.
}
}
cli/man/code_highlight.Rd 0000644 0001762 0000144 00000002144 14317007616 015032 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prettycode.R
\name{code_highlight}
\alias{code_highlight}
\title{Syntax highlight R code}
\usage{
code_highlight(code, code_theme = NULL, envir = NULL)
}
\arguments{
\item{code}{Character vector, each element is one line of code.}
\item{code_theme}{Theme see \code{\link[=code_theme_list]{code_theme_list()}}.}
\item{envir}{Environment to look up function calls for hyperlinks.
If \code{NULL}, then the global search path is used.}
}
\value{
Character vector, the highlighted code.
}
\description{
Syntax highlight R code
}
\details{
See \code{\link[=code_theme_list]{code_theme_list()}} for the default syntax highlighting theme and
how to change it.
If \code{code} does not parse, then it is returned unchanged and a
\code{cli_parse_failure} condition is thrown. Note that this is not an error,
and the condition is ignored, unless explicitly caught.
}
\examples{
code_highlight(deparse(ls))
cat(code_highlight(deparse(ls)), sep = "\n")
}
\seealso{
Other syntax highlighting:
\code{\link{code_theme_list}()}
}
\concept{syntax highlighting}
cli/man/cli_text.Rd 0000644 0001762 0000144 00000013723 14500305721 013701 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_text}
\alias{cli_text}
\title{CLI text}
\usage{
cli_text(..., .envir = parent.frame())
}
\arguments{
\item{...}{The text to show, in character vectors. They will be
concatenated into a single string. Newlines are \emph{not} preserved.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
Write some text to the screen. This function is most appropriate for
longer paragraphs. See \code{\link[=cli_alert]{cli_alert()}} for shorter status messages.
}
\details{
\subsection{Text wrapping}{
Text is wrapped to the console width, see \code{\link[=console_width]{console_width()}}.
\if{html}{\out{}}\preformatted{cli_text(cli:::lorem_ipsum())
}\if{html}{\out{
}}\if{html}{\out{
#> Lorem ad ipsum veniam esse nisi deserunt duis. Qui incididunt elit #> elit mollit sint nulla consectetur aute commodo do elit laboris minim #> et. Laboris ipsum mollit voluptate et non do incididunt eiusmod. Anim #> consectetur mollit laborum occaecat eiusmod excepteur. Ullamco non #> tempor esse anim tempor magna non.
}}\preformatted{cli_text("First line.")
cli_text("Second line.")
}\if{html}{\out{
}}\if{html}{\out{
#> First line. #> Second line.
}}\preformatted{cli_text("The \{.fn cli_text\} function in the \{.pkg cli\} package.")
}\if{html}{\out{
}}\if{html}{\out{
#> The `cli_text()` function in the cli package.
}}\preformatted{pos <- c(5, 14, 25, 26)
cli_text("We have \{length(pos)\} missing measurements: \{pos\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> We have 4 missing measurements: 5, 14, 25, and 26.
}}\preformatted{fun <- "cli-text"
pkg <- "cli"
cli_text("The \{.fn \{fun\}\} function in the \{.pkg \{pkg\}\} package.")
}\if{html}{\out{
}}\if{html}{\out{
#> The `cli-text()` function in the cli package.
}}\preformatted{cli_text(c("This ", "will ", "all "), "be ", "one ", "sentence.")
}\if{html}{\out{
}}\if{html}{\out{
#> This will all be one sentence.
}}\preformatted{ul <- cli_ul()
cli_li("First item.")
cli_text("Still the \{.emph first\} item")
cli_li("Second item.")
cli_text("Still the \{.emph second\} item")
cli_end(ul)
}\if{html}{\out{
}}\if{html}{\out{
#> • First item. #> Still the first item #> • Second item. #> Still the second item
}}\preformatted{fun <- function() \{
cli_dl(c(foo = "one", bar = "two", baz = "three"))
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> foo: one #> bar: two #> baz: three
}}\preformatted{fun <- function() \{
cli_dl()
cli_li(c(foo = "\{.emph one\}"))
cli_li(c(bar = "two"))
cli_li(c(baz = "three"))
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> foo: one
#> bar: two
#> baz: three
}}\preformatted{fun <- function() \{
ul <- cli_ul()
cli_li("one:")
cli_ol(letters[1:3])
cli_li("two:")
cli_li("three")
cli_end(ul)
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> • one: #> 1. a #> 2. b #> 3. c #> • two: #> • three
}}\preformatted{clean <- function() \{
cli_progress_bar("Cleaning data", total = 100)
for (i in 1:100) \{
Sys.sleep(5/100)
cli_progress_update()
\}
cli_progress_done()
\}
clean()
}\if{html}{\out{
}}
\if{html}{\figure{progress-1.svg}}
}
\subsection{Progress bar types}{
There are three builtin types of progress bars, and a custom type.
\if{html}{\out{}}\preformatted{tasks <- function() \{
cli_progress_bar("Tasks", total = 3, type = "tasks")
for (i in 1:3) \{
Sys.sleep(1)
cli_progress_update()
\}
cli_progress_done()
\}
tasks()
}\if{html}{\out{
}}
\if{html}{\figure{progress-tasks.svg}}
}
\subsection{Unknown \code{total}}{
If \code{total} is not known, then cli shows a different progress bar.
Note that you can also set \code{total} in \code{cli_progress_update()}, if it
not known when the progress bar is created, but you learn it later.
\if{html}{\out{}}\preformatted{nototal <- function() \{
cli_progress_bar("Parameter tuning")
for (i in 1:100) \{
Sys.sleep(3/100)
cli_progress_update()
\}
cli_progress_done()
\}
nototal()
}\if{html}{\out{
}}
\if{html}{\figure{progress-natotal.svg}}
}
\subsection{Clearing the progress bar}{
By default cli removes terminated progress bars from the screen, if
the terminal supports this. If you want to change this, use the
\code{clear} argument of \code{cli_progress_bar()}, or the \code{cli.progress_clear}
global option (see \link{cli-config}) to change this.
(In the cli documentation we usually set \code{cli.progress_clear} to \code{FALSE},
so users can see how finished progress bars look.)
In this example the first progress bar is cleared, the second is not.
\if{html}{\out{}}\preformatted{fun <- function() \{
cli_progress_bar("Data cleaning", total = 100, clear = TRUE)
for (i in 1:100) \{
Sys.sleep(3/100)
cli_progress_update()
\}
cli_progress_bar("Parameter tuning", total = 100, clear = FALSE)
for (i in 1:100) \{
Sys.sleep(3/100)
cli_progress_update()
\}
\}
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-clear.svg}}
}
\subsection{Initial delay}{
Updating a progress bar on the screen is costly, so cli tries to avoid
it for quick loops. By default a progress bar is only shown after two
seconds, or after half of that if less than 50\% of the iterations are
complete. You can change the two second default with the
\code{cli.progress_show_after} global option (see \link{cli-config}).
(In the cli documentation we usually set \code{cli.progress_show_after} to
\code{0} (zero seconds), so progress bars are shown immediately.)
In this example we only show the progress bar after one second, because
more than 50\% of the iterations remain after one second.
\if{html}{\out{}}\preformatted{fun <- function() \{
cli_alert("Starting now, at \{Sys.time()\}")
cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{pb_percent\} @ \{Sys.time()\}"
)
for (i in 1:100) \{
Sys.sleep(4/100)
cli_progress_update()
\}
\}
options(cli.progress_show_after = 2)
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-after.svg}}
}
\subsection{The \emph{current} progress bar}{
By default cli sets the new progress bar as the \emph{current} progress bar
of the calling function. The current progress bar is the default one
in cli progress bar operations. E.g. if no progress bar id is supplied
in \code{cli_progress_update()}, then the current progress bar is updated.
Every function can only have a single \emph{current} progress bar, and if a
new one is created, then the previous one (if any) is automatically
terminated. The current progress bar is also terminated when the function
that created it exits. Thanks to these rules, most often you don't need
to explicitly deal with progress bar ids, and you don't need to
explicitly call \code{cli_progress_done()}:
\if{html}{\out{}}\preformatted{fun <- function() \{
cli_progress_bar("First step ", total = 100)
for (i in 1:100) \{
Sys.sleep(2/100)
cli_progress_update()
\}
cli_progress_bar("Second step", total = 100)
for (i in 1:100) \{
Sys.sleep(2/100)
cli_progress_update()
\}
\}
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-current.svg}}
}
\subsection{cli output while the progress bar is active}{
cli allows emitting regular cli output (alerts, headers, lists, etc.)
while a progress bar is active. On terminals that support this, cli
will remove the progress bar temporarily, emit the output, and then
restores the progress bar.
\if{html}{\out{}}\preformatted{fun <- function() \{
cli_alert_info("Before the progress bar")
cli_progress_bar("Calculating", total = 100)
for (i in 1:50) \{
Sys.sleep(4/100)
cli_progress_update()
\}
cli_alert_info("Already half way!")
for (i in 1:50) \{
Sys.sleep(4/100)
cli_progress_update()
\}
cli_alert_info("All done")
\}
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-output.svg}}
See also \code{\link[=cli_progress_output]{cli_progress_output()}}, which sends text for the current
progress handler. E.g. in a Shiny app it will send the output to the
Shiny progress bar, as opposed to the \code{cli_alert()} etc. cli functions
which will print the text to the console.
}
\subsection{Custom formats}{
In addition to the builtin types, you can also specify a custom
format string. In this case \link[=progress-variables]{progress variables}
are probably useful to avoid calculating some progress bar quantities
like the elapsed time, of the ETA manually. You can also use your own
variables in the calling function:
\if{html}{\out{}}\preformatted{fun <- function(urls) \{
cli_progress_bar(
format = paste0(
"\{pb_spin\} Downloading \{.path \{basename(url)\}\} ",
"[\{pb_current\}/\{pb_total\}] ETA:\{pb_eta\}"
),
format_done = paste0(
"\{col_green(symbol$tick)\} Downloaded \{pb_total\} files ",
"in \{pb_elapsed\}."
),,
total = length(urls)
)
for (url in urls) \{
cli_progress_update()
Sys.sleep(5/10)
\}
\}
fun(paste0("https://acme.com/data-", 1:10, ".zip"))
}\if{html}{\out{
}}
\if{html}{\figure{progress-format.svg}}
}
}
\seealso{
These functions support \link[=inline-markup]{inline markup}.
\code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}} for simpler
progress messages.
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{progress bar functions}
cli/man/ansi_strip.Rd 0000644 0001762 0000144 00000001732 14521175065 014247 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_strip}
\alias{ansi_strip}
\title{Remove ANSI escape sequences from a string}
\usage{
ansi_strip(string, sgr = TRUE, csi = TRUE, link = TRUE)
}
\arguments{
\item{string}{The input string.}
\item{sgr}{Whether to remove for SGR (styling) control sequences.}
\item{csi}{Whether to remove for non-SGR control sequences.}
\item{link}{Whether to remove ANSI hyperlinks.}
}
\value{
The cleaned up string. Note that \code{ansi_strip()} always drops
the \code{cli_ansi_string} class, even if \code{sgr} and sci\code{are}FALSE`.
}
\description{
The input may be of class \code{cli_ansi_string} class, this is also dropped
from the result.
}
\examples{
ansi_strip(col_red("foobar")) == "foobar"
}
\seealso{
Other low level ANSI functions:
\code{\link{ansi_has_any}()},
\code{\link{ansi_hide_cursor}()},
\code{\link{ansi_regex}()},
\code{\link{ansi_string}()}
}
\concept{low level ANSI functions}
cli/man/cli_format_method.Rd 0000644 0001762 0000144 00000004030 14143453131 015536 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/print.R
\name{cli_format_method}
\alias{cli_format_method}
\title{Create a format method for an object using cli tools}
\usage{
cli_format_method(expr, theme = getOption("cli.theme"))
}
\arguments{
\item{expr}{Expression that calls \verb{cli_*} methods, \code{\link[base:cat]{base::cat()}} or
\code{\link[base:print]{base::print()}} to format an object's printout.}
\item{theme}{Theme to use for the formatting.}
}
\value{
Character vector, one element for each line of the printout.
}
\description{
This method can be typically used in \code{format()} S3 methods. Then the
\code{print()} method of the class can be easily defined in terms of such a
\code{format()} method. See examples below.
}
\examples{
# Let's create format and print methods for a new S3 class that
# represents the an installed R package: `r_package`
# An `r_package` will contain the DESCRIPTION metadata of the package
# and also its installation path.
new_r_package <- function(pkg) {
tryCatch(
desc <- packageDescription(pkg),
warning = function(e) stop("Cannot find R package `", pkg, "`")
)
file <- dirname(attr(desc, "file"))
if (basename(file) != pkg) file <- dirname(file)
structure(
list(desc = unclass(desc), lib = dirname(file)),
class = "r_package"
)
}
format.r_package <- function(x, ...) {
cli_format_method({
cli_h1("{.pkg {x$desc$Package}} {cli::symbol$line} {x$desc$Title}")
cli_text("{x$desc$Description}")
cli_ul(c(
"Version: {x$desc$Version}",
if (!is.null(x$desc$Maintainer)) "Maintainer: {x$desc$Maintainer}",
"License: {x$desc$License}"
))
if (!is.na(x$desc$URL)) cli_text("See more at {.url {x$desc$URL}}")
})
}
# Now the print method is easy:
print.r_package <- function(x, ...) {
cat(format(x, ...), sep = "\n")
}
# Try it out
new_r_package("cli")
# The formatting of the output depends on the current theme:
opt <- options(cli.theme = simple_theme())
print(new_r_package("cli"))
options(opt) # <- restore theme
}
cli/man/cli_progress_styles.Rd 0000644 0001762 0000144 00000005622 14500305721 016163 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-bar.R
\name{cli_progress_styles}
\alias{cli_progress_styles}
\title{List of built-in cli progress styles}
\usage{
cli_progress_styles()
}
\value{
A named list with sublists containing elements
\code{complete}, \code{incomplete} and potentially \code{current}.
}
\description{
The following options are used to select a style:
\itemize{
\item \code{cli_progress_bar_style}
\item \code{cli_progress_bar_style_ascii}
\item \code{cli_progress_bar_style_unicode}
}
}
\details{
On Unicode terminals (if \code{\link[=is_utf8_output]{is_utf8_output()}} is \code{TRUE}), the
\code{cli_progress_bar_style_unicode} and \code{cli_progress_bar_style}
options are used.
On ASCII terminals (if \code{\link[=is_utf8_output]{is_utf8_output()}} is \code{FALSE}), the
\code{cli_pgoress_bar_style_ascii} and \code{cli_progress_bar_style} options
are are used.
\if{html}{\out{}}\preformatted{for (style in names(cli_progress_styles())) \{
options(cli.progress_bar_style = style)
label <- ansi_align(paste0("Style '", style, "'"), 20)
print(cli_progress_demo(label, live = FALSE, at = 66, total = 100))
\}
options(cli.progress_var_style = NULL)
}\if{html}{\out{
}}\if{html}{\out{
#> Style 'classic' ##################### 66% | ETA: 3s #> Style 'squares' ■■■■■■■■■■■■■■■■■■■■■ 66% | ETA: 3s #> Style 'dot' ────────────────────●────────── 66% | ETA: 3s #> Style 'fillsquares' ■■■■■■■■■■■■■■■■■■■■■□□□□□□□□□□ 66% | ETA: 3s #> Style 'bar' ███████████████████████████████ 66% | ETA: 3s
}}\preformatted{options(cli.spinner = "hearts")
fun <- function() \{
cli_progress_bar("Spinning")
for (i in 1:100) \{
Sys.sleep(4/100)
cli_progress_update()
\}
\}
fun()
options(cli.spinner = NULL)
}\if{html}{\out{
}}
\if{html}{\figure{get-spinner.svg}}
}
\seealso{
Other spinners:
\code{\link{demo_spinners}()},
\code{\link{list_spinners}()},
\code{\link{make_spinner}()}
}
\concept{spinners}
cli/man/ansi_substr.Rd 0000644 0001762 0000144 00000003261 14143453131 014420 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_substr}
\alias{ansi_substr}
\title{Substring(s) of an ANSI colored string}
\usage{
ansi_substr(x, start, stop)
}
\arguments{
\item{x}{Character vector, potentially ANSI styled, or a vector to
coerced to character.}
\item{start}{Starting index or indices, recycled to match the length
of \code{x}.}
\item{stop}{Ending index or indices, recycled to match the length
of \code{x}.}
}
\value{
Character vector of the same length as \code{x}, containing
the requested substrings. ANSI styles are retained.
}
\description{
This is a color-aware counterpart of \code{\link[base:substr]{base::substr()}}.
It works exactly like the original, but keeps the colors
in the substrings. The ANSI escape sequences are ignored when
calculating the positions within the string.
}
\examples{
str <- paste(
col_red("red"),
"default",
col_green("green")
)
cat(str, "\n")
cat(ansi_substr(str, 1, 5), "\n")
cat(ansi_substr(str, 1, 15), "\n")
cat(ansi_substr(str, 3, 7), "\n")
substr(ansi_strip(str), 1, 5)
substr(ansi_strip(str), 1, 15)
substr(ansi_strip(str), 3, 7)
str2 <- paste(
"another",
col_red("multi-", style_underline("style")),
"text"
)
cat(str2, "\n")
cat(ansi_substr(c(str, str2), c(3,5), c(7, 18)), sep = "\n")
substr(ansi_strip(c(str, str2)), c(3,5), c(7, 18))
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_toupper}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/man/ansi_strwrap.Rd 0000644 0001762 0000144 00000003021 14143453131 014572 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_strwrap}
\alias{ansi_strwrap}
\title{Wrap an ANSI styled string to a certain width}
\usage{
ansi_strwrap(
x,
width = console_width(),
indent = 0,
exdent = 0,
simplify = TRUE
)
}
\arguments{
\item{x}{ANSI string.}
\item{width}{Width to wrap to.}
\item{indent}{Indentation of the first line of each paragraph.}
\item{exdent}{Indentation of the subsequent lines of each paragraph.}
\item{simplify}{Whether to return all wrapped strings in a single
character vector, or wrap each element of \code{x} independently and return
a list.}
}
\value{
If \code{simplify} is \code{FALSE}, then a list of character vectors,
each an ANSI string. Otherwise a single ANSI string vector.
}
\description{
This function is similar to \code{\link[base:strwrap]{base::strwrap()}}, but works on ANSI
styled strings, and leaves the styling intact.
}
\examples{
text <- cli:::lorem_ipsum()
# Highlight some words, that start with 's'
rexp <- gregexpr("\\\\b([sS][a-zA-Z]+)\\\\b", text)
regmatches(text, rexp) <- lapply(regmatches(text, rexp), col_red)
cat(text)
wrp <- ansi_strwrap(text, width = 40)
cat(wrp, sep = "\n")
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_toupper}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/man/simple_theme.Rd 0000644 0001762 0000144 00000013723 14332664317 014555 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/simple-theme.R
\name{simple_theme}
\alias{simple_theme}
\title{A simple CLI theme}
\usage{
simple_theme(dark = getOption("cli.theme_dark", "auto"))
}
\arguments{
\item{dark}{Whether the theme should be optimized for a dark
background. If \code{"auto"}, then cli will try to detect this.
Detection usually works in recent RStudio versions, and in iTerm
on macOS, but not on other platforms.}
}
\description{
To use this theme, you can set it as the \code{cli.theme} option.
Note that this is in addition to the builtin theme, which is still in
effect.
}
\details{
\if{html}{\out{}}\preformatted{options(cli.theme = cli::simple_theme())
}\if{html}{\out{
}}
and then CLI apps started after this will use it as the default theme.
You can also use it temporarily, in a div element:
\if{html}{\out{}}\preformatted{cli_div(theme = cli::simple_theme())
}\if{html}{\out{
}}
}
\section{Showcase}{
\if{html}{\out{}}\preformatted{show <- cli_div(theme = cli::simple_theme())
cli_h1("Heading 1")
cli_h2("Heading 2")
cli_h3("Heading 3")
cli_par()
cli_alert_danger("Danger alert")
cli_alert_warning("Warning alert")
cli_alert_info("Info alert")
cli_alert_success("Success alert")
cli_alert("Alert for starting a process or computation",
class = "alert-start")
cli_end()
cli_text("Packages and versions: \{.pkg cli\} \{.version 1.0.0\}.")
cli_text("Time intervals: \{.timestamp 3.4s\}")
cli_text("\{.emph Emphasis\} and \{.strong strong emphasis\}")
cli_text("This is a piece of code: \{.code sum(x) / length(x)\}")
cli_text("Function names: \{.fn cli::simple_theme\}")
cli_text("Files: \{.file /usr/bin/env\}")
cli_text("URLs: \{.url https://r-project.org\}")
cli_h2("Longer code chunk")
cli_par(class = "code R")
cli_verbatim(
'# window functions are useful for grouped mutates',
'mtcars \%>\%',
' group_by(cyl) \%>\%',
' mutate(rank = min_rank(desc(mpg)))')
cli_end(show)
}\if{html}{\out{
}}\if{html}{\out{
#> #> ── Heading 1 ───────────────────────────────────────────────────────── #> #> ─ Heading 2 ── #> #> Heading 3 #> ✖ Danger alert #> ! Warning alert #> ℹ Info alert #> ✔ Success alert #> → Alert for starting a process or computation #> #> Packages and versions: cli 1.0.0. #> Time intervals: [3.4s] #> Emphasis and strong emphasis #> This is a piece of code: `sum(x) / length(x)` #> Function names: `cli::simple_theme()`() #> Files: /usr/bin/env #> URLs: <https://r-project.org> #> #> ─ Longer code chunk ── #> # window functions are useful for grouped mutates #> mtcars %>% #> group_by(cyl) %>% #> mutate(rank = min_rank(desc(mpg))) #>
}}\preformatted{cli(\{
cli_h1("Title")
cli_h2("Subtitle")
cli_ul(c("this", "that", "end"))
\})
}\if{html}{\out{
}}\if{html}{\out{
#> #> ── Title ───────────────────────────────────────────────────────────── #> #> ── Subtitle ── #> #> • this #> • that #> • end
}}\preformatted{cli_text("This is \{.emph important\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> This is important.
}}\preformatted{adjective <- "great"
cli_text("This is \{.emph \{adjective\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> This is great.
}}\preformatted{cli_div(theme = list(span.emph = list(color = "red")))
adjective <- "nice and red"
cli_text("This is \{.emph \{adjective\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> This is nice and red.
}}\preformatted{ul <- cli_ul()
cli_li("\{.emph Emphasized\} text.")
cli_li("\{.strong Strong\} importance.")
cli_li("A piece of code: \{.code sum(a) / length(a)\}.")
cli_li("A package name: \{.pkg cli\}.")
cli_li("A function name: \{.fn cli_text\}.")
cli_li("A keyboard key: press \{.kbd ENTER\}.")
cli_li("A file name: \{.file /usr/bin/env\}.")
cli_li("An email address: \{.email bugs.bunny@acme.com\}.")
cli_li("A URL: \{.url https://example.com\}.")
cli_li("An environment variable: \{.envvar R_LIBS\}.")
cli_li("`mtcars` is \{.obj_type_friendly \{mtcars\}\}")
cli_end(ul)
}\if{html}{\out{
}}\if{html}{\out{
#> • Emphasized text. #> • Strong importance. #> • A piece of code: `sum(a) / length(a)`. #> • A package name: cli. #> • A function name: `cli_text()`. #> • A keyboard key: press [ENTER]. #> • A file name: /usr/bin/env. #> • An email address: bugs.bunny@acme.com. #> • A URL: <https://example.com>. #> • An environment variable: `R_LIBS`. #> • `mtcars` is a data frame
}}\preformatted{cli_div(theme = list(
span.myclass = list(color = "lightgrey"),
"span.myclass" = list(before = "<<"),
"span.myclass" = list(after = ">>")))
cli_text("This is \{.myclass in angle brackets\}.")
cli_end()
}\if{html}{\out{
}}\if{html}{\out{
#> This is <<in angle brackets>>.
}}\preformatted{pkgs <- c("pkg1", "pkg2", "pkg3")
cli_text("Packages: \{pkgs\}.")
cli_text("Packages: \{.pkg \{pkgs\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> Packages: pkg1, pkg2, and pkg3. #> Packages: pkg1, pkg2, and pkg3.
}}\preformatted{x <- Sys.time()
cli_text("Hey, \{.var x\} has class \{.cls \{class(x)\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> Hey, `x` has class <POSIXct/POSIXt>.
}}\preformatted{nms <- cli_vec(names(mtcars), list("vec-trunc" = 5))
cli_text("Column names: \{nms\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> Column names: mpg, cyl, disp, …, gear, and carb.
}}\preformatted{msg <- "Error in if (ncol(dat$y)) \{: argument is of length zero"
cli_alert_warning("\{msg\}")
}\if{html}{\out{
}}\if{html}{\out{
#> ! Error in if (ncol(dat$y)) \{: argument is of length zero
}}\preformatted{cli_alert_warning("A warning with \{\{ braces \}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ! A warning with \{ braces \}.
}}\preformatted{ndirs <- 1
nfiles <- 13
pkgs <- c("pkg1", "pkg2", "pkg3")
cli_alert_info("Found \{ndirs\} director\{?y/ies\} and \{nfiles\} file\{?s\}.")
cli_text("Will install \{length(pkgs)\} package\{?s\}: \{.pkg \{pkgs\}\}")
}\if{html}{\out{
}}\if{html}{\out{
#> ℹ Found 1 directory and 13 files. #> Will install 3 packages: pkg1, pkg2, and pkg3
}}\preformatted{str <- c(
col_red("This is red"),
style_bold("This is bold")
)
astr <- ansi_align(str, width = 30)
boxx(astr)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌────────────────────────────────────┐ #> │ │ #> │ This is red │ #> │ This is bold │ #> │ │ #> └────────────────────────────────────┘
}}\preformatted{str <- c(
col_red("This is red"),
style_bold("This is bold")
)
astr <- ansi_align(str, align = "center", width = 30)
boxx(astr)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌────────────────────────────────────┐ #> │ │ #> │ This is red │ #> │ This is bold │ #> │ │ #> └────────────────────────────────────┘
}}\preformatted{str <- c(
col_red("This is red"),
style_bold("This is bold")
)
astr <- ansi_align(str, align = "right", width = 30)
boxx(astr)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌────────────────────────────────────┐ #> │ │ #> │ This is red │ #> │ This is bold │ #> │ │ #> └────────────────────────────────────┘
} element.
}
}
\keyword{internal}
cli/man/cli_process_start.Rd 0000644 0001762 0000144 00000011150 14500305721 015600 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/status-bar.R
\name{cli_process_start}
\alias{cli_process_start}
\alias{cli_process_done}
\alias{cli_process_failed}
\title{Indicate the start and termination of some computation in the status bar
(superseded)}
\usage{
cli_process_start(
msg,
msg_done = paste(msg, "... done"),
msg_failed = paste(msg, "... failed"),
on_exit = c("auto", "failed", "done"),
msg_class = "alert-info",
done_class = "alert-success",
failed_class = "alert-danger",
.auto_close = TRUE,
.envir = parent.frame()
)
cli_process_done(
id = NULL,
msg_done = NULL,
.envir = parent.frame(),
done_class = "alert-success"
)
cli_process_failed(
id = NULL,
msg = NULL,
msg_failed = NULL,
.envir = parent.frame(),
failed_class = "alert-danger"
)
}
\arguments{
\item{msg}{The message to show to indicate the start of the process or
computation. It will be collapsed into a single string, and the first
line is kept and cut to \code{\link[=console_width]{console_width()}}.}
\item{msg_done}{The message to use for successful termination.}
\item{msg_failed}{The message to use for unsuccessful termination.}
\item{on_exit}{Whether this process should fail or terminate
successfully when the calling function (or the environment in \code{.envir})
exits.}
\item{msg_class}{The style class to add to the message. Use an empty
string to suppress styling.}
\item{done_class}{The style class to add to the successful termination
message. Use an empty string to suppress styling.a}
\item{failed_class}{The style class to add to the unsuccessful
termination message. Use an empty string to suppress styling.a}
\item{.auto_close}{Whether to clear the status bar when the calling
function finishes (or \code{.envir} is removed from the stack, if
specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-clear the status bar if \code{.auto_close} is \code{TRUE}.}
\item{id}{Id of the status bar container to clear. If \code{id} is not the id
of the current status bar (because it was overwritten by another
status bar container), then the status bar is not cleared. If \code{NULL}
(the default) then the status bar is always cleared.}
}
\value{
Id of the status bar container.
}
\description{
\strong{The \verb{cli_process_*()} functions are superseded by
the \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}} functions,
because they have a better default behavior.}
Typically you call \code{cli_process_start()} to start the process, and then
\code{cli_process_done()} when it is done. If an error happens before
\code{cli_process_done()} is called, then cli automatically shows the message
for unsuccessful termination.
}
\details{
If you handle the errors of the process or computation, then you can do
the opposite: call \code{cli_process_start()} with \code{on_exit = "done"}, and
in the error handler call \code{cli_process_failed()}. cli will automatically
call \code{cli_process_done()} on successful termination, when the calling
function finishes.
See examples below.
}
\examples{
## Failure by default
fun <- function() {
cli_process_start("Calculating")
if (interactive()) Sys.sleep(1)
if (runif(1) < 0.5) stop("Failed")
cli_process_done()
}
tryCatch(fun(), error = function(err) err)
## Success by default
fun2 <- function() {
cli_process_start("Calculating", on_exit = "done")
tryCatch({
if (interactive()) Sys.sleep(1)
if (runif(1) < 0.5) stop("Failed")
}, error = function(err) cli_process_failed())
}
fun2()
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
The \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}}
functions, for a superior API.
Other status bar:
\code{\link{cli_status_clear}()},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{status bar}
cli/man/spark_line.Rd 0000644 0001762 0000144 00000001664 14332664317 014232 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/spark.R
\name{spark_line}
\alias{spark_line}
\title{Draw a sparkline line graph with Braille characters.}
\usage{
spark_line(x)
}
\arguments{
\item{x}{A numeric vector between 0 and 1}
}
\description{
You might want to avoid sparklines on non-UTF-8 systems, because they
do not look good. You can use \code{\link[=is_utf8_output]{is_utf8_output()}} to test for support
for them.
}
\details{
\if{html}{\out{
}}
}
\seealso{
\code{\link[=spark_bar]{spark_bar()}}
}
cli/man/match_selector.Rd 0000644 0001762 0000144 00000001076 14143453131 015062 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/themes.R
\name{match_selector}
\alias{match_selector}
\title{Match a selector to a container stack}
\usage{
match_selector(sels, cnts)
}
\arguments{
\item{sels}{A list of selector nodes.}
\item{cnts}{A list of container nodes.
The last selector in the list must match the last container, so we
do the matching from the back. This is because we use this function
to calculate the style of newly encountered containers.}
}
\description{
Match a selector to a container stack
}
\keyword{internal}
cli/man/ansi_palettes.Rd 0000644 0001762 0000144 00000005060 14232501151 014711 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansi-palette.R
\docType{data}
\name{truecolor}
\alias{truecolor}
\alias{ansi_palettes}
\alias{ansi_palette_show}
\title{ANSI colors palettes}
\format{
\code{truecolor} is an integer scalar.
\code{ansi_palettes} is a data frame with one row for each palette,
and one column for each base ANSI color. \code{attr(ansi_palettes, "info")}
contains a list with information about each palette.
}
\usage{
truecolor
ansi_palettes
ansi_palette_show(palette = NULL, colors = num_ansi_colors(), rows = 4)
}
\arguments{
\item{palette}{The palette to show, in the same format as for the
\code{cli.palette} option, so it can be the name of a built-in palette,
of a list of 16 colors.}
\item{colors}{Number of ANSI colors to use the show the palette. If the
platform does not have sufficient support, the output might have
a lower color resolution. Without color support it will have no color
at all.}
\item{rows}{The number of colored rows to print.}
}
\value{
\code{ansi_palette_show} returns a character vector, the rows that
are printed to the screen, invisibly.
}
\description{
If your platform supports at least 256 colors, then you can configure
the colors that cli uses for the eight base and the eight bright colors.
(I.e. the colors of \code{\link[=col_black]{col_black()}}, \code{\link[=col_red]{col_red()}}, and \code{\link[=col_br_black]{col_br_black()}},
\code{\link[=col_br_red]{col_br_red()}}, etc.
}
\details{
\code{truecolor} is an integer constant for the number of 24 bit ANSI colors.
To customize the default palette, set the \code{cli.palette} option to the
name of a built-in palette (see \code{ansi_palettes()}), or the list of
16 colors. Colors can be specified with RGB colors strings:
\verb{#rrggbb} or R color names (see the output of \code{\link[grDevices:colors]{grDevices::colors()}}).
For example, you can put this in your R profile:
\if{html}{\out{
}}
}
\seealso{
\link{themes}, \code{\link[=simple_theme]{simple_theme()}}.
}
cli/man/style_hyperlink.Rd 0000644 0001762 0000144 00000002572 14312603722 015316 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansi-hyperlink.R
\name{style_hyperlink}
\alias{style_hyperlink}
\alias{ansi_has_hyperlink_support}
\alias{ansi_hyperlink_types}
\title{Terminal Hyperlinks}
\usage{
style_hyperlink(text, url, params = NULL)
ansi_has_hyperlink_support()
ansi_hyperlink_types()
}
\arguments{
\item{text}{Text to show. \code{text} and \code{url} are recycled to match their
length, via a \code{paste0()} call.}
\item{url}{URL to link to.}
\item{params}{A named character vector of additional parameters, or \code{NULL}.}
}
\value{
Styled \code{cli_ansi_string} for \code{style_hyperlink()}.
Logical scalar for \code{ansi_has_hyperlink_support()}.
}
\description{
\code{ansi_hyperlink()} creates an ANSI hyperlink.
}
\details{
This function is currently experimental. In particular, many of the
\verb{ansi_*()} functions do not support it properly.
\code{ansi_has_hyperlink_support()} checks if the current \code{stdout()}
supports hyperlinks.
See also
\url{https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda}.
\code{ansi_hyperlink_types()} checks if current \code{stdout()} supports various
types of hyperlinks. It returns a list with entries \code{href}, \code{run},
\code{help} and \code{vignettes}.
}
\examples{
cat("This is an", style_hyperlink("R", "https://r-project.org"), "link.\n")
ansi_has_hyperlink_support()
}
cli/man/roxygen/ 0000755 0001762 0000144 00000000000 14301737210 013265 5 ustar ligges users cli/man/roxygen/meta.R 0000644 0001762 0000144 00000001473 14301737210 014343 0 ustar ligges users
if (exists(".knitr_asciicast_process", envir = .GlobalEnv)) {
rm(list = ".knitr_asciicast_process", envir = .GlobalEnv)
}
asciicast::init_knitr_engine(
echo = TRUE,
echo_input = FALSE,
interactive = TRUE,
timeout = as.integer(Sys.getenv("ASCIICAST_TIMEOUT", 10)),
startup = quote({
options(cli.width = 70)
options(cli.progress_show_after = 0)
options(cli.progress_clear = FALSE)
library(cli)
set.seed(1)
})
)
knitr::opts_chunk$set(
asciicast_knitr_output = "html",
asciicast_include_style = FALSE,
asciicast_theme = "pkgdown"
)
list(
markdown = TRUE,
knitr_chunk_options = list(
cache = TRUE,
cache_lazy = FALSE,
cache.path = file.path(getwd(), "man/_cache/"),
fig.path = file.path(getwd(), "man/figures"),
error = TRUE
),
restrict_image_formats = TRUE
)
cli/man/list_spinners.Rd 0000644 0001762 0000144 00000000756 14143453131 014766 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/spinner.R
\name{list_spinners}
\alias{list_spinners}
\title{List all available spinners}
\usage{
list_spinners()
}
\value{
Character vector of all available spinner names.
}
\description{
List all available spinners
}
\examples{
list_spinners()
get_spinner(list_spinners()[1])
}
\seealso{
Other spinners:
\code{\link{demo_spinners}()},
\code{\link{get_spinner}()},
\code{\link{make_spinner}()}
}
\concept{spinners}
cli/man/pluralization-helpers.Rd 0000644 0001762 0000144 00000001144 14143453131 016417 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pluralize.R
\name{no}
\alias{no}
\alias{qty}
\title{Pluralization helper functions}
\usage{
no(expr)
qty(expr)
}
\arguments{
\item{expr}{For \code{no()} it is an expression that is printed as "no" in
cli expressions, it is interpreted as a zero quantity. For \code{qty()}
an expression that sets the pluralization quantity without printing
anything. See examples below.}
}
\description{
Pluralization helper functions
}
\seealso{
Other pluralization:
\code{\link{pluralization}},
\code{\link{pluralize}()}
}
\concept{pluralization}
cli/man/rule.Rd 0000644 0001762 0000144 00000017732 14332664317 013055 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rules.R
\name{rule}
\alias{rule}
\title{Make a rule with one or two text labels}
\usage{
rule(
left = "",
center = "",
right = "",
line = 1,
col = NULL,
line_col = col,
background_col = NULL,
width = console_width()
)
}
\arguments{
\item{left}{Label to show on the left. It interferes with the \code{center}
label, only at most one of them can be present.}
\item{center}{Label to show at the center. It interferes with the
\code{left} and \code{right} labels.}
\item{right}{Label to show on the right. It interferes with the \code{center}
label, only at most one of them can be present.}
\item{line}{The character or string that is used to draw the line.
It can also \code{1} or \code{2}, to request a single line (Unicode, if
available), or a double line. Some strings are interpreted specially,
see \emph{Line styles} below.}
\item{col}{Color of text, and default line color. Either an ANSI style
function (see \link[=ansi-styles]{ANSI styles}), or a color name that is
passed to \code{\link[=make_ansi_style]{make_ansi_style()}}.}
\item{line_col, background_col}{Either a color name (used in
\code{\link[=make_ansi_style]{make_ansi_style()}}), or a style function (see
\link[=ansi-styles]{ANSI styles}), to color the line and background.}
\item{width}{Width of the rule. Defaults to the \code{width} option, see
\code{\link[base:options]{base::options()}}.}
}
\value{
Character scalar, the rule.
}
\description{
The rule can include either a centered text label, or labels on the
left and right side.
To color the labels, use the functions \verb{col_*}, \verb{bg_*} and \verb{style_*}
functions, see \link[=ansi-styles]{ANSI styles}, and the examples below.
To color the line, either these functions directly, or the \code{line_col}
option.
}
\details{
\subsection{Simple rule}{
\if{html}{\out{
}}
}
\subsection{Line styles}{
Some strings for the \code{line} argument are interpreted specially:
\itemize{
\item \code{"single"}: (same as \code{1}), a single line,
\item \code{"double"}: (same as \code{2}), a double line,
\item \code{"bar1"}, \code{"bar2"}, \code{"bar3"}, etc., \code{"bar8"} uses varying height bars.
}
\subsection{Double rule}{
\if{html}{\out{
}}
}
\subsection{Bars}{
\if{html}{\out{
}}
}
\subsection{Custom lines}{
\if{html}{\out{
}}
\if{html}{\out{
}}
\if{html}{\out{
}}
}
}
\subsection{Left label}{
\if{html}{\out{
}}
}
\subsection{Centered label}{
\if{html}{\out{
}}
}
\subsection{Colored labels}{
\if{html}{\out{
}}
}
\subsection{Colored line}{
\if{html}{\out{
}}
}
}
cli/man/cli_ol.Rd 0000644 0001762 0000144 00000010671 14500305721 013326 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_ol}
\alias{cli_ol}
\title{Ordered CLI list}
\usage{
cli_ol(
items = NULL,
id = NULL,
class = NULL,
.close = TRUE,
.auto_close = TRUE,
.envir = parent.frame()
)
}
\arguments{
\item{items}{If not \code{NULL}, then a character vector. Each element of
the vector will be one list item, and the list container will be
closed by default (see the \code{.close} argument).}
\item{id}{Id of the list container. Can be used for closing it with
\code{\link[=cli_end]{cli_end()}} or in themes. If \code{NULL}, then an id is generated and
returned invisibly.}
\item{class}{Class of the list container. Can be used in themes.}
\item{.close}{Whether to close the list container if the \code{items} were
specified. If \code{FALSE} then new items can be added to the list.}
\item{.auto_close}{Whether to close the container, when the calling
function finishes (or \code{.envir} is removed, if specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-close the container if \code{.auto_close} is \code{TRUE}.}
}
\value{
The id of the new container element, invisibly.
}
\description{
An ordered list is a container, see \link{containers}.
}
\details{
\subsection{Adding all items at once}{
\if{html}{\out{
}}
}
\subsection{Adding items one by one}{
\if{html}{\out{
}}
}
\subsection{Nested lists}{
\if{html}{\out{
}}
}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/ansi_string.Rd 0000644 0001762 0000144 00000001356 14521175065 014416 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_string}
\alias{ansi_string}
\title{Labels a character vector as containing ANSI control codes.}
\usage{
ansi_string(x)
}
\arguments{
\item{x}{A character vector or something that can be
coerced into one.}
}
\value{
A \code{cli_ansi_string} object, a subclass of
\code{character}, with the same length and contents
as \code{x}.
}
\description{
This function sets the class of its argument, activating
ANSI-string-specific methods such as for printing.
}
\seealso{
Other low level ANSI functions:
\code{\link{ansi_has_any}()},
\code{\link{ansi_hide_cursor}()},
\code{\link{ansi_regex}()},
\code{\link{ansi_strip}()}
}
\concept{low level ANSI functions}
cli/man/cli_progress_output.Rd 0000644 0001762 0000144 00000004530 14500305721 016175 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-client.R
\name{cli_progress_output}
\alias{cli_progress_output}
\title{Add text output to a progress bar}
\usage{
cli_progress_output(text, id = NULL, .envir = parent.frame())
}
\arguments{
\item{text}{Text to output. It is formatted via \code{\link[=cli_text]{cli_text()}}.}
\item{id}{Progress bar id. The default is the current progress bar.}
\item{.envir}{Environment to use for glue interpolation of \code{text}.}
}
\value{
\code{TRUE}, always.
}
\description{
The text is calculated via \code{\link[=cli_text]{cli_text()}}, so all cli features can be
used here, including progress variables.
}
\details{
The text is passed to the progress handler(s), that may or may not be
able to print it.
\if{html}{\out{
}}
\if{html}{\out{
}}
\subsection{Colored nodes}{
\if{html}{\out{
}}
}
\subsection{Trimming}{
\if{html}{\out{
}}
\if{html}{\out{
}}
}
}
cli/man/cli_bullets.Rd 0000644 0001762 0000144 00000007740 14500305721 014371 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bullets.R
\name{cli_bullets}
\alias{cli_bullets}
\title{List of items}
\usage{
cli_bullets(text, id = NULL, class = NULL, .envir = parent.frame())
}
\arguments{
\item{text}{Character vector of items. See details below on how names
are interpreted.}
\item{id}{Optional id of the \code{div.bullets} element, can be used in themes.}
\item{class}{Optional additional class(es) for the \code{div.bullets} element.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
It is often useful to print out a list of items, tasks a function or
package performs, or a list of notes.
}
\details{
Items may be formatted differently, e.g. they can have a prefix symbol.
Formatting is specified by the names of \code{text}, and can be themed.
cli creates a \code{div} element of class \code{bullets} for the whole bullet list.
Each item is another \code{div} element of class \verb{bullet-}, where
\verb{} is the name of the entry in \code{text}. Entries in \code{text} without
a name create a \code{div} element of class \code{bullet-empty}, and if the
name is a single space character, the class is \code{bullet-space}.
The built-in theme defines the following item types:
\itemize{
\item No name: Item without a prefix.
\item \verb{ }: Indented item.
\item \code{*}: Item with a bullet.
\item \code{>}: Item with an arrow or pointer.
\item \code{v}: Item with a green "tick" symbol, like \code{\link[=cli_alert_success]{cli_alert_success()}}.
\item \code{x}: Item with a ref cross, like \code{\link[=cli_alert_danger]{cli_alert_danger()}}.
\item \code{!}: Item with a yellow exclamation mark, like \code{\link[=cli_alert_warning]{cli_alert_warning()}}.
\item \code{i}: Info item, like \code{\link[=cli_alert_info]{cli_alert_info()}}.
}
You can define new item type by simply defining theming for the
corresponding \verb{bullet-} classes.
\if{html}{\out{
}}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/test_that_cli.Rd 0000644 0001762 0000144 00000006200 14312603722 014707 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/test.R
\name{test_that_cli}
\alias{test_that_cli}
\title{Test cli output with testthat}
\usage{
test_that_cli(
desc,
code,
configs = c("plain", "ansi", "unicode", "fancy"),
links = NULL
)
}
\arguments{
\item{desc}{Test description, passed to \code{\link[testthat:test_that]{testthat::test_that()}}, after
appending the name of the cli configuration to it.}
\item{code}{Test code, it is modified to set up the cli config, and
then passed to \code{\link[testthat:test_that]{testthat::test_that()}}}
\item{configs}{cli configurations to test \code{code} with. The default is
\code{NULL}, which includes all possible configurations. It can also be a
character vector, to restrict the tests to some configurations only.
See available configurations below.}
\item{links}{Whether to run the code with various hyperlinks allowed.
If \code{NULL} then hyperlinks are turned off. Otherwise it can be a character
vector with possible hyperlink configurations:
\itemize{
\item \code{"all"}: turn on all hyperlinks,
\item \code{"none"}: turn off all hyperlinks.
}}
}
\description{
Use this function in your testthat test files, to test cli output.
It requires testthat edition 3, and works best with snapshot tests.
}
\details{
\code{test_that_cli()} calls \code{\link[testthat:test_that]{testthat::test_that()}} multiple times, with
different cli configurations. This makes it simple to test cli output
with and without ANSI colors, with and without Unicode characters.
Currently available configurations:
\itemize{
\item \code{plain}: no ANSI colors, ASCII characters only.
\item \code{ansi}: ANSI colors, ASCII characters only.
\item \code{unicode}: no ANSI colors, Unicode characters.
\item \code{fancy}; ANSI colors, Unicode characters.
}
See examples below and in cli's own tests, e.g. in
\url{https://github.com/r-lib/cli/tree/main/tests/testthat}
and the corresponding snapshots at
\url{https://github.com/r-lib/cli/tree/main/tests/testthat/_snaps}
\subsection{Important note regarding Windows}{
Because of base R's limitation to record Unicode characters on Windows,
we suggest that you record your snapshots on Unix, or you restrict
your tests to ASCII configurations.
Unicode tests on Windows are automatically skipped by testthat
currently.
}
}
\examples{
# testthat cannot record or compare snapshots when you run these
# examples interactively, so you might want to copy them into a test
# file
# Default configurations
cli::test_that_cli("success", {
testthat::local_edition(3)
testthat::expect_snapshot({
cli::cli_alert_success("wow")
})
})
# Only use two configurations, because this output does not have colors
cli::test_that_cli(configs = c("plain", "unicode"), "cat_bullet", {
testthat::local_edition(3)
testthat::expect_snapshot({
cli::cat_bullet(letters[1:5])
})
})
# You often need to evaluate all cli calls of a test case in the same
# environment. Use `local()` to do that:
cli::test_that_cli("theming", {
testthat::local_edition(3)
testthat::expect_snapshot(local({
cli::cli_div(theme = list(".alert" = list(before = "!!! ")))
cli::cli_alert("wow")
}))
})
}
cli/man/ansi_grep.Rd 0000644 0001762 0000144 00000003153 14301737210 014032 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_grep}
\alias{ansi_grep}
\alias{ansi_grepl}
\title{Like \code{\link[base:grep]{base::grep()}} and \code{\link[base:grep]{base::grepl()}}, but for ANSI strings}
\usage{
ansi_grep(pattern, x, ignore.case = FALSE, perl = FALSE, value = FALSE, ...)
ansi_grepl(pattern, x, ...)
}
\arguments{
\item{pattern}{Character scalar, regular expression or fixed string
(if \code{fixed = TRUE}), the pattern to search for. Other objects will be
coerced using \code{\link[=as.character]{as.character()}}.}
\item{x}{Character vector to search in. Other objects will be coerced
using \code{\link[=as.character]{as.character()}}.}
\item{ignore.case, perl, value}{Passed to \code{\link[base:grep]{base::grep()}}.}
\item{...}{Extra arguments are passed to \code{\link[base:grep]{base::grep()}} or \code{\link[base:grep]{base::grepl()}}.}
}
\value{
The same as \code{\link[base:grep]{base::grep()}} and \code{\link[base:grep]{base::grepl()}}, respectively.
}
\description{
First ANSI sequences will be stripped with \code{\link[=ansi_strip]{ansi_strip()}}, both
}
\details{
Note that these functions work on code points (or bytes if
\code{useBytes = TRUE}), and not graphemes.
Unlike \code{\link[base:grep]{base::grep()}} and \code{\link[base:grep]{base::grepl()}} these functions do not special
case factors.
Both \code{pattern} and \code{x} are converted to UTF-8.
}
\examples{
red_needle <- col_red("needle")
haystack <- c("foo", "needle", "foo")
green_haystack <- col_green(haystack)
ansi_grepl(red_needle, haystack)
ansi_grepl(red_needle, green_haystack)
}
cli/man/ansi_html_style.Rd 0000644 0001762 0000144 00000002747 14143453131 015272 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_html_style}
\alias{ansi_html_style}
\title{CSS styles for the output of \code{ansi_html()}}
\usage{
ansi_html_style(
colors = TRUE,
palette = c("vscode", "dichro", "vga", "winxp", "win10", "macos", "putty", "mirc",
"xterm", "ubuntu", "eclipse", "iterm", "iterm-pastel", "iterm-smoooooth",
"iterm-snazzy", "iterm-solarized", "iterm-tango")
)
}
\arguments{
\item{colors}{Whether or not to include colors. \code{FALSE} will not include
colors, \code{TRUE} or \code{8} will include eight colors (plus their bright
variants), \code{256} will include 256 colors.}
\item{palette}{Character scalar, palette to use for the first eight colors
plus their bright variants. Terminals define these colors differently,
and cli includes a couple of examples. Sources of palettes:
\itemize{
\item https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit
\item iTerm2 builtin palettes
\item \url{https://github.com/sindresorhus/iterm2-snazzy}
}}
}
\value{
Named list of CSS declaration blocks, where the names are
CSS selectors. It has a \code{format()} and \code{print()} methods, which you
can use to write the output to a CSS or HTML file.
}
\description{
CSS styles for the output of \code{ansi_html()}
}
\examples{
ansi_html_style(colors = FALSE)
ansi_html_style(colors = 8, palette = "iterm-snazzy")
}
\seealso{
Other ANSI to HTML conversion:
\code{\link{ansi_html}()}
}
\concept{ANSI to HTML conversion}
cli/man/cli_ul.Rd 0000644 0001762 0000144 00000007010 14500305721 013325 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_ul}
\alias{cli_ul}
\title{Unordered CLI list}
\usage{
cli_ul(
items = NULL,
id = NULL,
class = NULL,
.close = TRUE,
.auto_close = TRUE,
.envir = parent.frame()
)
}
\arguments{
\item{items}{If not \code{NULL}, then a character vector. Each element of
the vector will be one list item, and the list container will be
closed by default (see the \code{.close} argument).}
\item{id}{Id of the list container. Can be used for closing it with
\code{\link[=cli_end]{cli_end()}} or in themes. If \code{NULL}, then an id is generated and
returned invisibly.}
\item{class}{Class of the list container. Can be used in themes.}
\item{.close}{Whether to close the list container if the \code{items} were
specified. If \code{FALSE} then new items can be added to the list.}
\item{.auto_close}{Whether to close the container, when the calling
function finishes (or \code{.envir} is removed, if specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-close the container if \code{.auto_close} is \code{TRUE}.}
}
\value{
The id of the new container element, invisibly.
}
\description{
An unordered list is a container, see \link{containers}.
}
\details{
\subsection{Adding all items at once}{
\if{html}{\out{
}}
}
\subsection{Adding items one by one}{
\if{html}{\out{
}}
}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/ansi_hide_cursor.Rd 0000644 0001762 0000144 00000002461 14521175065 015414 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tty.R
\name{ansi_hide_cursor}
\alias{ansi_hide_cursor}
\alias{ansi_show_cursor}
\alias{ansi_with_hidden_cursor}
\title{Hide/show cursor in a terminal}
\usage{
ansi_hide_cursor(stream = "auto")
ansi_show_cursor(stream = "auto")
ansi_with_hidden_cursor(expr, stream = "auto")
}
\arguments{
\item{stream}{The stream to inspect or manipulate, an R connection
object. It can also be a string, one of \code{"auto"}, \code{"message"},
\code{"stdout"}, \code{"stderr"}. \code{"auto"} will select \code{stdout()} if the session is
interactive and there are no sinks, otherwise it will select \code{stderr()}.}
\item{expr}{R expression to evaluate.}
}
\description{
This only works in terminal emulators. In other environments, it
does nothing.
}
\details{
\code{ansi_hide_cursor()} hides the cursor.
\code{ansi_show_cursor()} shows the cursor.
\code{ansi_with_hidden_cursor()} temporarily hides the cursor for
evaluating an expression.
}
\seealso{
Other terminal capabilities:
\code{\link{is_ansi_tty}()},
\code{\link{is_dynamic_tty}()}
Other low level ANSI functions:
\code{\link{ansi_has_any}()},
\code{\link{ansi_regex}()},
\code{\link{ansi_string}()},
\code{\link{ansi_strip}()}
}
\concept{low level ANSI functions}
\concept{terminal capabilities}
cli/man/spark_bar.Rd 0000644 0001762 0000144 00000004667 14332664317 014055 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/spark.R
\name{spark_bar}
\alias{spark_bar}
\title{Draw a sparkline bar graph with unicode block characters}
\usage{
spark_bar(x)
}
\arguments{
\item{x}{A numeric vector between 0 and 1}
}
\description{
Rendered using \href{https://en.wikipedia.org/wiki/Block_Elements}{block elements}.
In most common fixed width fonts these are rendered wider than regular
characters which means they are not suitable if you need precise alignment.
You might want to avoid sparklines on non-UTF-8 systems, because they
do not look good. You can use \code{\link[=is_utf8_output]{is_utf8_output()}} to test for support
for them.
}
\details{
\if{html}{\out{
}}
\if{html}{\out{
}}
\if{html}{\out{
}}
\code{NA}s are left out:
\if{html}{\out{
}}
}
\seealso{
\code{\link[=spark_line]{spark_line()}}
}
cli/man/cli_list_themes.Rd 0000644 0001762 0000144 00000001453 14535114677 015252 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/themes.R
\name{cli_list_themes}
\alias{cli_list_themes}
\title{List the currently active themes}
\usage{
cli_list_themes()
}
\value{
A list of data frames with the active themes.
Each data frame row is a style that applies to selected CLI tree nodes.
Each data frame has columns:
\itemize{
\item \code{selector}: The original CSS-like selector string. See \link{themes}.
\item \code{parsed}: The parsed selector, as used by cli for matching to nodes.
\item \code{style}: The original style.
\item \code{cnt}: The id of the container the style is currently applied to, or
\code{NA} if the style is not used.
}
}
\description{
If there is no active app, then it calls \code{\link[=start_app]{start_app()}}.
}
\seealso{
\link{themes}
}
cli/man/cli_blockquote.Rd 0000644 0001762 0000144 00000006067 14500305721 015070 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_blockquote}
\alias{cli_blockquote}
\title{CLI block quote}
\usage{
cli_blockquote(
quote,
citation = NULL,
id = NULL,
class = NULL,
.envir = parent.frame()
)
}
\arguments{
\item{quote}{Text of the quotation.}
\item{citation}{Source of the quotation, typically a link or the name
of a person.}
\item{id}{Element id, a string. If \code{NULL}, then a new id is generated
and returned.}
\item{class}{Class name, sting. Can be used in themes.}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-close the container if \code{.auto_close} is \code{TRUE}.}
}
\description{
A section that is quoted from another source. It is typically indented.
}
\details{
\if{html}{\out{
}}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/containers.Rd 0000644 0001762 0000144 00000006312 14332664317 014243 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cliapp-docs.R
\name{containers}
\alias{containers}
\title{About cli containers}
\description{
Container elements may contain other elements. Currently the following
commands create container elements: \code{\link[=cli_div]{cli_div()}}, \code{\link[=cli_par]{cli_par()}}, the list
elements: \code{\link[=cli_ul]{cli_ul()}}, \code{\link[=cli_ol]{cli_ol()}}, \code{\link[=cli_dl]{cli_dl()}}, and list items are
containers as well: \code{\link[=cli_li]{cli_li()}}.
}
\details{
\subsection{Themes}{
A container can add a new theme, which is removed when the container
exits.
\if{html}{\out{
}}
}
\subsection{Auto-closing}{
Container elements are closed with \code{\link[=cli_end]{cli_end()}}. For convenience,
by default they are closed automatically when the function that created
them terminated (either regularly or with an error). The default
behavior can be changed with the \code{.auto_close} argument.
\if{html}{\out{
}}
}
\subsection{Debugging}{
You can use the internal \code{cli:::cli_debug_doc()} function to see the
currently open containers.
\if{html}{\out{
}}
}
}
cli/man/cli_rule.Rd 0000644 0001762 0000144 00000006543 14500305721 013666 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_rule}
\alias{cli_rule}
\title{CLI horizontal rule}
\usage{
cli_rule(
left = "",
center = "",
right = "",
id = NULL,
.envir = parent.frame()
)
}
\arguments{
\item{left}{Label to show on the left. It interferes with the \code{center}
label, only at most one of them can be present.}
\item{center}{Label to show at the center. It interferes with the
\code{left} and \code{right} labels.}
\item{right}{Label to show on the right. It interferes with the \code{center}
label, only at most one of them can be present.}
\item{id}{Element id, a string. If \code{NULL}, then a new id is generated
and returned.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
It can be used to separate parts of the output.
}
\details{
\subsection{Inline styling and interpolation}{
\if{html}{\out{
}}
}
\subsection{Theming}{
The line style of the rule can be changed via the the \code{line-type}
property. Possible values are:
\itemize{
\item \code{"single"}: (same as \code{1}), a single line,
\item \code{"double"}: (same as \code{2}), a double line,
\item \code{"bar1"}, \code{"bar2"}, \code{"bar3"}, etc., \code{"bar8"} uses varying height bars.
}
Colors and background colors can similarly changed via a theme.
\if{html}{\out{
}}
}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/ansi-styles.Rd 0000644 0001762 0000144 00000013514 14535431165 014351 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/zzz.R
\name{ansi-styles}
\alias{ansi-styles}
\alias{bg_black}
\alias{bg_blue}
\alias{bg_cyan}
\alias{bg_green}
\alias{bg_magenta}
\alias{bg_red}
\alias{bg_white}
\alias{bg_yellow}
\alias{bg_none}
\alias{bg_br_black}
\alias{bg_br_blue}
\alias{bg_br_cyan}
\alias{bg_br_green}
\alias{bg_br_magenta}
\alias{bg_br_red}
\alias{bg_br_white}
\alias{bg_br_yellow}
\alias{col_black}
\alias{col_blue}
\alias{col_cyan}
\alias{col_green}
\alias{col_magenta}
\alias{col_red}
\alias{col_white}
\alias{col_yellow}
\alias{col_grey}
\alias{col_silver}
\alias{col_none}
\alias{col_br_black}
\alias{col_br_blue}
\alias{col_br_cyan}
\alias{col_br_green}
\alias{col_br_magenta}
\alias{col_br_red}
\alias{col_br_white}
\alias{col_br_yellow}
\alias{style_dim}
\alias{style_blurred}
\alias{style_bold}
\alias{style_hidden}
\alias{style_inverse}
\alias{style_italic}
\alias{style_reset}
\alias{style_strikethrough}
\alias{style_underline}
\alias{style_no_bold}
\alias{style_no_blurred}
\alias{style_no_dim}
\alias{style_no_italic}
\alias{style_no_underline}
\alias{style_no_inverse}
\alias{style_no_hidden}
\alias{style_no_strikethrough}
\alias{style_no_color}
\alias{style_no_bg_color}
\title{ANSI colored text}
\usage{
bg_black(...)
bg_blue(...)
bg_cyan(...)
bg_green(...)
bg_magenta(...)
bg_red(...)
bg_white(...)
bg_yellow(...)
bg_none(...)
bg_br_black(...)
bg_br_blue(...)
bg_br_cyan(...)
bg_br_green(...)
bg_br_magenta(...)
bg_br_red(...)
bg_br_white(...)
bg_br_yellow(...)
col_black(...)
col_blue(...)
col_cyan(...)
col_green(...)
col_magenta(...)
col_red(...)
col_white(...)
col_yellow(...)
col_grey(...)
col_silver(...)
col_none(...)
col_br_black(...)
col_br_blue(...)
col_br_cyan(...)
col_br_green(...)
col_br_magenta(...)
col_br_red(...)
col_br_white(...)
col_br_yellow(...)
style_dim(...)
style_blurred(...)
style_bold(...)
style_hidden(...)
style_inverse(...)
style_italic(...)
style_reset(...)
style_strikethrough(...)
style_underline(...)
style_no_bold(...)
style_no_blurred(...)
style_no_dim(...)
style_no_italic(...)
style_no_underline(...)
style_no_inverse(...)
style_no_hidden(...)
style_no_strikethrough(...)
style_no_color(...)
style_no_bg_color(...)
}
\arguments{
\item{...}{Character strings, they will be pasted together with
\code{paste0()}, before applying the style function.}
}
\value{
An ANSI string (class \code{cli_ansi_string}), that contains ANSI
sequences, if the current platform supports them. You can simply
use \code{cat()} to print them to the terminal.
}
\description{
cli has a number of functions to color and style text at the command
line. They provide a more modern interface than the crayon package.
}
\details{
The \verb{col_*} functions change the (foreground) color to the text.
These are the eight original ANSI colors. Note that in some terminals,
they might actually look differently, as terminals have their own
settings for how to show them. \code{col_none()} is the default color, this
is useful in a substring of a colored string.
The \verb{col_br_*} functions are bright versions of the eight ANSI colors.
Note that on some terminal configurations and themes they might be the
same as the non-bright colors.
The \verb{bg_*} functions change the background color of the text.
These are the eight original ANSI background colors. These, too, can
vary in appearance, depending on terminal settings. \code{bg_none()} the
the default background color, this is useful in a substring of a
background-colored string.
The \verb{bg_br_*} functions are the bright versions of the eight ANSI
background colors. Note that on some terminal configurations and themes
they might be the same as the non-bright colors.
The \verb{style_*} functions apply other styling to the text. The currently
supported styling functions are:
\itemize{
\item \code{style_reset()} to remove any style, including color,
\item \code{style_bold()} for boldface / strong text, although some terminals
show a bright, high intensity text instead,
\item \code{style_dim()} (or \code{style_blurred()} reduced intensity text.
\item \code{style_italic()} (not widely supported).
\item \code{style_underline()},
\item \code{style_inverse()},
\item \code{style_hidden()},
\item \code{style_strikethrough()} (not widely supported).
}
The style functions take any number of character vectors as arguments,
and they concatenate them using \code{paste0()} before adding the style.
Styles can also be nested, and then inner style takes precedence, see
examples below.
Sometimes you want to revert back to the default text color, in the
middle of colored text, or you want to have a normal font in the middle
of italic text. You can use the \verb{style_no_*} functions for this. Every
\verb{style_*()} function has a \verb{style_no_*()} pair, which defends its
argument from taking on the style. See examples below.
}
\examples{
col_blue("Hello ", "world!")
cat(col_blue("Hello ", "world!"))
cat("... to highlight the", col_red("search term"),
"in a block of text\n")
## Style stack properly
cat(col_green(
"I am a green line ",
col_blue(style_underline(style_bold("with a blue substring"))),
" that becomes green again!"
))
error <- combine_ansi_styles("red", "bold")
warn <- combine_ansi_styles("magenta", "underline")
note <- col_cyan
cat(error("Error: subscript out of bounds!\n"))
cat(warn("Warning: shorter argument was recycled.\n"))
cat(note("Note: no such directory.\n"))
# style_no_* functions, note that the color is not removed
style_italic(col_green(paste0(
"italic before, ",
style_no_italic("normal here, "),
"italic after"
)))
# avoiding color for substring
style_italic(col_red(paste(
"red before",
col_none("not red between"),
"red after"
)))
}
\seealso{
Other ANSI styling:
\code{\link{combine_ansi_styles}()},
\code{\link{make_ansi_style}()},
\code{\link{num_ansi_colors}()}
}
\concept{ANSI styling}
cli/man/faq.Rd 0000644 0001762 0000144 00000005620 14232501151 012627 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/docs.R
\name{faq}
\alias{faq}
\title{Frequently Asked Questions}
\description{
Frequently Asked Questions
}
\details{
\subsection{My platform supports ANSI colors, why does cli not use them?}{
It is probably a mistake in the ANSI support detection algorithm. Please
open an issue at \url{https://github.com/r-lib/cli/issues} and do not forget
to tell us the details of your platform and terminal or GUI.
}
\subsection{How do I turn off ANSI colors and styles?}{
Set the \code{NO_COLOR} environment variable to a non-empty value. You can do
this in your \code{.Renviron} file (use \code{usethis::edit_r_environ()}).
If you want to do this for testthat tests, then consider using the 3rd
edition on testthat, which does turn off ANSI styling automatically
inside \code{test_that()}.
}
\subsection{cli does not show the output before \code{file.choose()}}{
Try calling \code{flush.console()} to flush the console, before
\code{file.choose()}. If flushing does not work and you are in RStudio, then
it is probably this RStudio bug:
\url{https://github.com/rstudio/rstudio/issues/8040} See more details at
\url{https://github.com/r-lib/cli/issues/151}
}
\subsection{Why are heading separators wider than my screen in RStudio?}{
The display width of some Unicode characters ambiguous in the Unicode
standard. Some software treats them as narrow (one column on the
screen), other as wide (two columns). In some terminal emulators (for
example iTerm2), you can configure the preferred behavior.
Unfortunately the box drawing characters that cli uses also have
ambiguous width.
In RStudio the behavior depends on the font. In particular, Consolas,
Courier and Inconsolata treats them as wide characters, so cli output
will not look great with these. Some good, modern fonts that look good
include Menlo, Fira Code and Source Code Pro.
If you do not want to change your font, you can also turn off Unicode
output, by setting the \code{cli.unicode} option:
\if{html}{\out{
}}
}
\subsection{\code{pb_current}}{
The number of current progress units.
\if{html}{\out{
}}
}
\subsection{\code{pb_current_bytes}}{
The number of current progress units formatted as bytes.
The output has a constant width of six characters.
\if{html}{\out{
}}
}
\subsection{\code{pb_elapsed}}{
The elapsed time since the start of the progress bar. The time is
measured since the progress bar was created with \code{\link[=cli_progress_bar]{cli_progress_bar()}}
or similar.
\if{html}{\out{
}}
}
\subsection{\code{pb_elapsed_clock}}{
The elapsed time, in \verb{hh::mm::ss} format.
\if{html}{\out{
}}
}
\subsection{\code{pb_elapsed_raw}}{
The number of seconds since the start of the progress bar.
\if{html}{\out{
}}
}
\subsection{\code{pb_eta}}{
The estimated time until the end of the progress bar,
in human readable form.
\if{html}{\out{
}}
}
\subsection{\code{pb_eta_raw}}{
The estimated time until the end of the progress
bar, in seconds. This is useful if you want to adjust the default
\code{pb_eta} display.
\if{html}{\out{
}}
}
\subsection{\code{pb_eta_str}}{
The estimated time until the end of the progress bar.
It includes the \code{"ETA:"} prefix. It is only shown if the time can be
estimated, otherwise it is the empty string.
\if{html}{\out{
}}
}
\subsection{\code{pb_extra}}{
\code{pb_extra} can be used to access extra data, see the \code{extra} argument
of \code{cli_progress_bar()} and \code{cli_progress_update()}.
\if{html}{\out{
}}
}
\subsection{\code{pb_id}}{
The id of the progress bar. The id has the format
\verb{cli--} where \verb{} is the process id, and
\verb{} is an integer counter that is incremented every time
cli needs a new unique id.
This is useful for debugging progress bars.
\if{html}{\out{
}}
}
\subsection{\code{pb_name}}{
The name of the progress bar. This is supplied by the
developer, and it is by default the empty string. A space character
is added to non-empty names.
\if{html}{\out{
}}
}
\subsection{\code{pb_percent}}{
The percentage of the progress bar, always formatted
in three characters plus the percentage sign. If the total number of
units is unknown, then it is \code{" NA\%"}.
\if{html}{\out{
}}
}
\subsection{\code{pb_pid}}{
The integer process id of the progress bar. This is useful if you are
aggregating logging output or progress results from multiple processes.
}
\subsection{\code{pb_rate}}{
The progress rate, in number of units per second, formatted in a string.
\if{html}{\out{
}}
}
\subsection{\code{pb_rate_raw}}{
The raw progress rate, in number of units per second.
\if{html}{\out{
}}
}
\subsection{\code{pb_rate_bytes}}{
The progress rate, formatted as bytes per second, in human readable form.
\if{html}{\out{
}}
}
\subsection{\code{pb_spin}}{
A spinner. The default spinner is selected via a \code{\link[=get_spinner]{get_spinner()}} call.
\if{html}{\out{
}}
}
\subsection{\code{pb_status}}{
The status string of the progress bar. By default this is an empty
string, but it is possible to set it in \code{\link[=cli_progress_bar]{cli_progress_bar()}}
and `cli_progress_update()].
\if{html}{\out{
}}
}
\subsection{\code{pb_timestamp}}{
A time stamp for the current time in ISO 8601 format.
\if{html}{\out{
}}
}
\subsection{\code{pb_total}}{
The total number of progress units, or \code{NA} if the number of units is
unknown.
\if{html}{\out{
}}
}
\subsection{\code{pb_total_bytes}}{
The total number of progress units, formatted as
bytes, in a human readable format.
\if{html}{\out{
}}
}
}
\seealso{
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()}
}
\concept{progress bar functions}
cli/man/is_ansi_tty.Rd 0000644 0001762 0000144 00000002144 14143453131 014410 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tty.R
\name{is_ansi_tty}
\alias{is_ansi_tty}
\title{Detect if a stream support ANSI escape characters}
\usage{
is_ansi_tty(stream = "auto")
}
\arguments{
\item{stream}{The stream to inspect or manipulate, an R connection
object. It can also be a string, one of \code{"auto"}, \code{"message"},
\code{"stdout"}, \code{"stderr"}. \code{"auto"} will select \code{stdout()} if the session is
interactive and there are no sinks, otherwise it will select \code{stderr()}.}
}
\value{
\code{TRUE} or \code{FALSE}.
}
\description{
We check that all of the following hold:
\itemize{
\item The stream is a terminal.
\item The platform is Unix.
\item R is not running inside R.app (the macOS GUI).
\item R is not running inside RStudio.
\item R is not running inside Emacs.
\item The terminal is not "dumb".
\item \code{stream} is either the standard output or the standard error stream.
}
}
\examples{
is_ansi_tty()
}
\seealso{
Other terminal capabilities:
\code{\link{ansi_hide_cursor}()},
\code{\link{is_dynamic_tty}()}
}
\concept{terminal capabilities}
cli/man/figures/ 0000755 0001762 0000144 00000000000 14500305721 013235 5 ustar ligges users cli/man/figures/README/ 0000755 0001762 0000144 00000000000 14343071116 014175 5 ustar ligges users cli/man/figures/README/lists-dark.svg 0000644 0001762 0000144 00000003327 14521141212 016771 0 ustar ligges users cli/man/figures/README/h3.svg 0000644 0001762 0000144 00000002221 14521141212 015216 0 ustar ligges users cli/man/figures/README/progress-dark.svg 0000644 0001762 0000144 00000120632 14521141212 017476 0 ustar ligges users cli/man/figures/README/h2.svg 0000644 0001762 0000144 00000002440 14521141212 015220 0 ustar ligges users cli/man/figures/README/plurals-dark.svg 0000644 0001762 0000144 00000002661 14521141212 017315 0 ustar ligges users cli/man/figures/README/progress.svg 0000644 0001762 0000144 00000120635 14521141212 016562 0 ustar ligges users cli/man/figures/README/glue.svg 0000644 0001762 0000144 00000002571 14521141212 015650 0 ustar ligges users cli/man/figures/README/h2-dark.svg 0000644 0001762 0000144 00000002435 14521141212 016143 0 ustar ligges users cli/man/figures/README/h1.svg 0000644 0001762 0000144 00000003005 14521141212 015215 0 ustar ligges users cli/man/figures/README/alert-dark.svg 0000644 0001762 0000144 00000002277 14521141212 016745 0 ustar ligges users cli/man/figures/README/glue-dark.svg 0000644 0001762 0000144 00000002566 14521141212 016573 0 ustar ligges users cli/man/figures/README/alert.svg 0000644 0001762 0000144 00000002302 14521141212 016013 0 ustar ligges users cli/man/figures/README/h1-dark.svg 0000644 0001762 0000144 00000003002 14521141212 016131 0 ustar ligges users cli/man/figures/README/alert-info-dark.svg 0000644 0001762 0000144 00000002620 14521141212 017666 0 ustar ligges users cli/man/figures/README/alert-success.svg 0000644 0001762 0000144 00000002375 14521141212 017473 0 ustar ligges users cli/man/figures/README/alert-info.svg 0000644 0001762 0000144 00000002623 14521141212 016752 0 ustar ligges users cli/man/figures/README/alert-danger-dark.svg 0000644 0001762 0000144 00000002602 14521141212 020173 0 ustar ligges users cli/man/figures/README/alert-danger.svg 0000644 0001762 0000144 00000002605 14521141212 017257 0 ustar ligges users cli/man/figures/README/alert-success-dark.svg 0000644 0001762 0000144 00000002372 14521141212 020407 0 ustar ligges users cli/man/figures/README/themes-dark.svg 0000644 0001762 0000144 00000003277 14521141212 017124 0 ustar ligges users cli/man/figures/README/alert-warning.svg 0000644 0001762 0000144 00000003057 14521141212 017466 0 ustar ligges users cli/man/figures/README/alert-warning-dark.svg 0000644 0001762 0000144 00000003054 14521141212 020402 0 ustar ligges users cli/man/figures/README/themes.svg 0000644 0001762 0000144 00000003302 14521141212 016172 0 ustar ligges users cli/man/figures/README/h3-dark.svg 0000644 0001762 0000144 00000002216 14521141212 016141 0 ustar ligges users cli/man/figures/README/lists.svg 0000644 0001762 0000144 00000003332 14521141212 016046 0 ustar ligges users cli/man/figures/README/plurals.svg 0000644 0001762 0000144 00000002664 14521141212 016401 0 ustar ligges users cli/man/figures/progress-format.svg 0000644 0001762 0000144 00000014742 14535432162 017130 0 ustar ligges users cli/man/figures/progress-along-1.svg 0000644 0001762 0000144 00000033630 14535432162 017073 0 ustar ligges users cli/man/figures/progress-message.svg 0000644 0001762 0000144 00000012164 14535432163 017261 0 ustar ligges users cli/man/figures/progress-tasks.svg 0000644 0001762 0000144 00000005714 14535432162 016764 0 ustar ligges users cli/man/figures/progress-current.svg 0000644 0001762 0000144 00000056667 14535432162 017336 0 ustar ligges users cli/man/figures/get-spinner.svg 0000644 0001762 0000144 00000036326 14535432163 016234 0 ustar ligges users cli/man/figures/progress-after.svg 0000644 0001762 0000144 00000027121 14535432162 016734 0 ustar ligges users cli/man/figures/make-spinner-custom.svg 0000644 0001762 0000144 00000040474 14535432163 017701 0 ustar ligges users cli/man/figures/progress-along-3.svg 0000644 0001762 0000144 00000022716 14535432162 017100 0 ustar ligges users cli/man/figures/progress-step.svg 0000644 0001762 0000144 00000014676 14535432163 016622 0 ustar ligges users cli/man/figures/make-spinner-default.svg 0000644 0001762 0000144 00000075172 14535432163 020016 0 ustar ligges users cli/man/figures/progress-along-2.svg 0000644 0001762 0000144 00000033227 14535432162 017076 0 ustar ligges users cli/man/figures/progress-output2.svg 0000644 0001762 0000144 00000052426 14535432163 017264 0 ustar ligges users cli/man/figures/progress-1.svg 0000644 0001762 0000144 00000053405 14535432162 015777 0 ustar ligges users cli/man/figures/make-spinner-template.svg 0000644 0001762 0000144 00000076170 14535432163 020204 0 ustar ligges users cli/man/figures/progress-output.svg 0000644 0001762 0000144 00000052550 14535432162 017177 0 ustar ligges users cli/man/figures/progress-natotal.svg 0000644 0001762 0000144 00000033576 14535432162 017310 0 ustar ligges users cli/man/figures/progress-step-dynamic.svg 0000644 0001762 0000144 00000044435 14535432163 020240 0 ustar ligges users cli/man/figures/progress-clear.svg 0000644 0001762 0000144 00000067523 14535432162 016733 0 ustar ligges users cli/man/figures/demo-spinners.svg 0000644 0001762 0000144 00000041074 14535432163 016560 0 ustar ligges users cli/man/figures/progress-step-msg.svg 0000644 0001762 0000144 00000014321 14535432163 017371 0 ustar ligges users cli/man/figures/progress-step-spin.svg 0000644 0001762 0000144 00000036066 14535432163 017566 0 ustar ligges users cli/man/cli_code.Rd 0000644 0001762 0000144 00000005340 14332664317 013637 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_code}
\alias{cli_code}
\title{A block of code}
\usage{
cli_code(
lines = NULL,
...,
language = "R",
.auto_close = TRUE,
.envir = environment()
)
}
\arguments{
\item{lines}{Character vector, each line will be a line of code, and
newline characters also create new lines. Note that \emph{no} glue
substitution is performed on the code.}
\item{...}{More character vectors, they are appended to \code{lines}.}
\item{language}{Programming language. This is also added as a class,
in addition to \code{code}.}
\item{.auto_close}{Passed to \code{cli_div()} when creating the container of
the code. By default the code container is closed after emitting
\code{lines} and \code{...} via \code{cli_verbatim()}. You can keep that container
open with \code{.auto_close} and/or \code{.envir}, and then calling
\code{cli_verbatim()} to add (more) code. Note that the code will be
formatted and syntax highlighted separately for each \code{cli_verbatim()}
call.}
\item{.envir}{Passed to \code{cli_div()} when creating the container of the
code.}
}
\value{
The id of the container that contains the code.
}
\description{
A helper function that creates a \code{div} with class \code{code} and then calls
\code{cli_verbatim()} to output code lines. The builtin theme formats these
containers specially. In particular, it adds syntax highlighting to
valid R code.
}
\details{
\if{html}{\out{
}}
}
cli/man/ansi_columns.Rd 0000644 0001762 0000144 00000006200 14332664317 014564 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_columns}
\alias{ansi_columns}
\title{Format a character vector in multiple columns}
\usage{
ansi_columns(
text,
width = console_width(),
sep = " ",
fill = c("rows", "cols"),
max_cols = 4,
align = c("left", "center", "right"),
type = "width",
ellipsis = symbol$ellipsis
)
}
\arguments{
\item{text}{Character vector to format. Each element will formatted
as a cell of a table.}
\item{width}{Width of the screen.}
\item{sep}{Separator between the columns. It may have ANSI styles.}
\item{fill}{Whether to fill the columns row-wise or column-wise.}
\item{max_cols}{Maximum number of columns to use. Will not use more,
even if there is space for it.}
\item{align}{Alignment within the columns.}
\item{type}{Passed to \code{\link[=ansi_nchar]{ansi_nchar()}} and \code{\link[=ansi_align]{ansi_align()}}. Most probably
you want the default, \code{"width"}.}
\item{ellipsis}{The string to append to truncated strings. Supply an
empty string if you don't want a marker.}
}
\value{
ANSI string vector.
}
\description{
This function helps with multi-column output of ANSI styles strings.
It works well together with \code{\link[=boxx]{boxx()}}, see the example below.
}
\details{
If a string does not fit into the specified \code{width}, it will be
truncated using \code{\link[=ansi_strtrim]{ansi_strtrim()}}.
\if{html}{\out{
}}
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_toupper}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/man/hash_sha1.Rd 0000644 0001762 0000144 00000002752 14521175065 013736 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hash.R
\name{hash_sha1}
\alias{hash_sha1}
\alias{hash_raw_sha1}
\alias{hash_obj_sha1}
\alias{hash_file_sha1}
\title{SHA-1 hash}
\usage{
hash_sha1(x)
hash_raw_sha1(x)
hash_obj_sha1(x, serialize_version = 2)
hash_file_sha1(paths)
}
\arguments{
\item{x}{Character vector. If not a character vector, then
\code{\link[=as.character]{as.character()}} is used to try to coerce it into one. \code{NA} entries
will have an \code{NA} hash.}
\item{serialize_version}{Workspace format version to use, see
\code{\link[base:serialize]{base::serialize()}}.}
\item{paths}{Character vector of file names.}
}
\value{
\code{hash_sha1()} returns a character vector of hexadecimal
SHA-1 hashes.
\code{hash_raw_sha1()} returns a character scalar.
\code{hash_obj_sha1()} returns a character scalar.
\code{hash_file_sha1()} returns a character vector of SHA-1
hashes.
}
\description{
Calculate the SHA-1 hash of each element of a character vector.
}
\details{
\code{hash_raw_sha1()} calculates the SHA-1 hash of the bytes
of a raw vector.
\code{hash_obj_sha1()} calculates the SHA-1 hash of an R
object. The object is serialized into a binary vector first.
\code{hash_file_sha1()} calculates the SHA-1 hash of one or
more files.
}
\examples{
hash_sha1(c("foo", NA, "bar", ""))
}
\seealso{
Other hash functions:
\code{\link{hash_animal}()},
\code{\link{hash_emoji}()},
\code{\link{hash_md5}()},
\code{\link{hash_sha256}()}
}
\concept{hash functions}
cli/man/cli_format.Rd 0000644 0001762 0000144 00000007354 14332664317 014224 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/format.R
\name{cli_format}
\alias{cli_format}
\alias{cli_format.default}
\alias{cli_format.character}
\alias{cli_format.numeric}
\title{Format a value for printing}
\usage{
cli_format(x, style = NULL, ...)
\method{cli_format}{default}(x, style = NULL, ...)
\method{cli_format}{character}(x, style = NULL, ...)
\method{cli_format}{numeric}(x, style = NULL, ...)
}
\arguments{
\item{x}{The object to format.}
\item{style}{List of formatting options, see the individual methods
for the style options they support.}
\item{...}{Additional arguments for methods.}
}
\description{
This function can be used directly, or via the \verb{\{.val ...\}} inline
style. \verb{\{.val \{expr\}\}} calls \code{cli_format()} automatically on the value
of \code{expr}, before styling and collapsing it.
}
\details{
\subsection{Default style}{
\if{html}{\out{
}}
\if{html}{\out{
}}
}
\subsection{Styling with themes}{
\if{html}{\out{
}}
It is possible to define new S3 methods for \code{cli_format} and then
these will be used automatically for \verb{\{.val ...\}} expressions.
\if{html}{\out{
}}
}
}
\seealso{
\code{\link[=cli_vec]{cli_vec()}}
}
cli/man/cli_status.Rd 0000644 0001762 0000144 00000007415 14500305721 014241 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/status-bar.R
\name{cli_status}
\alias{cli_status}
\title{Update the status bar (superseded)}
\usage{
cli_status(
msg,
msg_done = paste(msg, "... done"),
msg_failed = paste(msg, "... failed"),
.keep = FALSE,
.auto_close = TRUE,
.envir = parent.frame(),
.auto_result = c("clear", "done", "failed", "auto")
)
}
\arguments{
\item{msg}{The text to show, a character vector. It will be
collapsed into a single string, and the first line is kept and cut to
\code{\link[=console_width]{console_width()}}. The message is often associated with the start of
a calculation.}
\item{msg_done}{The message to use when the message is cleared, when
the calculation finishes successfully. If \code{.auto_close} is \code{TRUE}
and \code{.auto_result} is \code{"done"}, then this is printed automatically
when the calling function (or \code{.envir}) finishes.}
\item{msg_failed}{The message to use when the message is cleared, when
the calculation finishes unsuccessfully. If \code{.auto_close} is \code{TRUE}
and \code{.auto_result} is \code{"failed"}, then this is printed automatically
when the calling function (or \code{.envir}) finishes.}
\item{.keep}{What to do when this status bar is cleared. If \code{TRUE} then
the content of this status bar is kept, as regular cli output (the
screen is scrolled up if needed). If \code{FALSE}, then this status bar
is deleted.}
\item{.auto_close}{Whether to clear the status bar when the calling
function finishes (or \code{.envir} is removed from the stack, if
specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-clear the status bar if \code{.auto_close} is \code{TRUE}.}
\item{.auto_result}{What to do when auto-closing the status bar.}
}
\value{
The id of the new status bar container element, invisibly.
}
\description{
\strong{The \verb{cli_status_*()} functions are superseded by
the \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}} functions,
because they have a better default behavior.}
The status bar is the last line of the terminal. cli apps can use this
to show status information, progress bars, etc. The status bar is kept
intact by all semantic cli output.
}
\details{
Use \code{\link[=cli_status_clear]{cli_status_clear()}} to clear the status bar.
Often status messages are associated with processes. E.g. the app starts
downloading a large file, so it sets the status bar accordingly. Once the
download is done (or has failed), the app typically updates the status bar
again. cli automates much of this, via the \code{msg_done}, \code{msg_failed}, and
\code{.auto_result} arguments. See examples below.
}
\seealso{
Status bars support \link[=inline-markup]{inline markup}.
The \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}}
functions, for a superior API.
Other status bar:
\code{\link{cli_process_start}()},
\code{\link{cli_status_clear}()},
\code{\link{cli_status_update}()}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{status bar}
cli/man/pluralize.Rd 0000644 0001762 0000144 00000004121 14301737210 014066 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pluralize.R
\name{pluralize}
\alias{pluralize}
\title{String templating with pluralization}
\usage{
pluralize(
...,
.envir = parent.frame(),
.transformer = glue::identity_transformer
)
}
\arguments{
\item{..., .envir, .transformer}{All arguments are passed to \code{\link[glue:glue]{glue::glue()}}.}
}
\description{
\code{pluralize()} is similar to \code{\link[glue:glue]{glue::glue()}}, with two differences:
\itemize{
\item It supports cli's \link{pluralization} syntax, using \verb{\{?\}} markers.
\item It collapses substituted vectors into a comma separated string.
}
}
\details{
See \link{pluralization} and some examples below.
You need to install the glue package to use this function.
}
\examples{
\dontshow{if (requireNamespace("glue", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
# Regular plurals
nfile <- 0; pluralize("Found {nfile} file{?s}.")
nfile <- 1; pluralize("Found {nfile} file{?s}.")
nfile <- 2; pluralize("Found {nfile} file{?s}.")
# Irregular plurals
ndir <- 1; pluralize("Found {ndir} director{?y/ies}.")
ndir <- 5; pluralize("Found {ndir} director{?y/ies}.")
# Use 'no' instead of zero
nfile <- 0; pluralize("Found {no(nfile)} file{?s}.")
nfile <- 1; pluralize("Found {no(nfile)} file{?s}.")
nfile <- 2; pluralize("Found {no(nfile)} file{?s}.")
# Use the length of character vectors
pkgs <- "pkg1"
pluralize("Will remove the {pkgs} package{?s}.")
pkgs <- c("pkg1", "pkg2", "pkg3")
pluralize("Will remove the {pkgs} package{?s}.")
pkgs <- character()
pluralize("Will remove {?no/the/the} {pkgs} package{?s}.")
pkgs <- c("pkg1", "pkg2", "pkg3")
pluralize("Will remove {?no/the/the} {pkgs} package{?s}.")
# Multiple quantities
nfiles <- 3; ndirs <- 1
pluralize("Found {nfiles} file{?s} and {ndirs} director{?y/ies}")
# Explicit quantities
nupd <- 3; ntotal <- 10
cli_text("{nupd}/{ntotal} {qty(nupd)} file{?s} {?needs/need} updates")
\dontshow{\}) # examplesIf}
}
\seealso{
Other pluralization:
\code{\link{no}()},
\code{\link{pluralization}}
}
\concept{pluralization}
cli/man/cli_status_clear.Rd 0000644 0001762 0000144 00000003347 14143453131 015411 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/status-bar.R
\name{cli_status_clear}
\alias{cli_status_clear}
\title{Clear the status bar (superseded)}
\usage{
cli_status_clear(
id = NULL,
result = c("clear", "done", "failed"),
msg_done = NULL,
msg_failed = NULL,
.envir = parent.frame()
)
}
\arguments{
\item{id}{Id of the status bar container to clear. If \code{id} is not the id
of the current status bar (because it was overwritten by another
status bar container), then the status bar is not cleared. If \code{NULL}
(the default) then the status bar is always cleared.}
\item{result}{Whether to show a message for success or failure or just
clear the status bar.}
\item{msg_done}{If not \code{NULL}, then the message to use for successful
process termination. This overrides the message given when the status
bar was created.}
\item{msg_failed}{If not \code{NULL}, then the message to use for failed
process termination. This overrides the message give when the status
bar was created.}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-clear the status bar if \code{.auto_close} is \code{TRUE}.}
}
\description{
\strong{The \verb{cli_status_*()} functions are superseded by
the \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}} functions,
because they have a better default behavior.}
Clear the status bar
}
\seealso{
The \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}}
functions, for a superior API.
Other status bar:
\code{\link{cli_process_start}()},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()}
}
\concept{status bar}
cli/man/cli-package.Rd 0000644 0001762 0000144 00000002172 14535114677 014242 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli-package.R
\docType{package}
\name{cli-package}
\alias{cli-package}
\title{cli: Helpers for Developing Command Line Interfaces}
\description{
A suite of tools to build attractive command line interfaces ('CLIs'), from semantic elements: headings, lists, alerts, paragraphs, etc. Supports custom themes via a 'CSS'-like language. It also contains a number of lower level 'CLI' elements: rules, boxes, trees, and 'Unicode' symbols with 'ASCII' alternatives. It support ANSI colors and text styles as well.
}
\seealso{
Useful links:
\itemize{
\item \url{https://cli.r-lib.org}
\item \url{https://github.com/r-lib/cli}
\item Report bugs at \url{https://github.com/r-lib/cli/issues}
}
}
\author{
\strong{Maintainer}: Gábor Csárdi \email{csardi.gabor@gmail.com}
Other contributors:
\itemize{
\item Hadley Wickham [contributor]
\item Kirill Müller [contributor]
\item Salim Brüggemann \email{salim-b@pm.me} (\href{https://orcid.org/0000-0002-5329-5987}{ORCID}) [contributor]
\item Posit Software, PBC [copyright holder, funder]
}
}
\keyword{internal}
cli/man/cli_progress_message.Rd 0000644 0001762 0000144 00000006007 14500305721 016262 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-client.R
\name{cli_progress_message}
\alias{cli_progress_message}
\title{Simplified cli progress messages}
\usage{
cli_progress_message(
msg,
current = TRUE,
.auto_close = TRUE,
.envir = parent.frame(),
...
)
}
\arguments{
\item{msg}{Message to show. It may contain glue substitution and cli
styling. It can be updated via \code{\link[=cli_progress_update]{cli_progress_update()}}, as usual.}
\item{current}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.auto_close}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.envir}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{...}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
}
\value{
The id of the new progress bar.
}
\description{
This is a simplified progress bar, a single (dynamic)
message, without progress units.
}
\details{
\code{cli_progress_message()} always shows the message, even if no
update is due. When the progress message is terminated, it is removed
from the screen by default.
Note that the message can be dynamic: if you update it with
\code{\link[=cli_progress_update]{cli_progress_update()}}, then cli uses the current values in the string
substitutions.
\if{html}{\out{
}}
}
\subsection{Change border style}{
\if{html}{\out{
}}
}
\subsection{Multiple lines}{
\if{html}{\out{
}}
}
\subsection{Padding}{
\if{html}{\out{
}}
}
\subsection{Floating}{
\if{html}{\out{
}}
}
\subsection{Text color}{
\if{html}{\out{
}}
}
\subsection{Background color}{
\if{html}{\out{
}}
}
\subsection{Border color}{
\if{html}{\out{
}}
}
\subsection{Label alignment}{
\if{html}{\out{
}}
}
\subsection{A very customized box}{
\if{html}{\out{
}}
}
}
\section{About fonts and terminal settings}{
The boxes might or might not look great in your terminal, depending
on the box style you use and the font the terminal uses. We found that
the Menlo font looks nice in most terminals an also in Emacs.
RStudio currently has a line height greater than one for console output,
which makes the boxes ugly.
}
cli/man/themes.Rd 0000644 0001762 0000144 00000015716 14535114677 013377 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cliapp-docs.R
\name{themes}
\alias{themes}
\title{About cli themes}
\description{
CLI elements can be styled via a CSS-like language of selectors and
properties. Only a small subset of CSS3 is supported, and
a lot visual properties cannot be implemented on a terminal, so these
will be ignored as well.
}
\section{Adding themes}{
The style of an element is calculated from themes from four sources.
These form a stack, and the themes on the top of the stack take
precedence, over themes in the bottom.
\enumerate{
\item The cli package has a built-in theme. This is always active.
See \code{\link[=builtin_theme]{builtin_theme()}}.
\item When an app object is created via \code{\link[=start_app]{start_app()}}, the caller can
specify a theme, that is added to theme stack. If no theme is
specified for \code{\link[=start_app]{start_app()}}, the content of the \code{cli.theme} option
is used. Removed when the corresponding app stops.
\item The user may specify a theme in the \code{cli.user_theme} option. This
is added to the stack \emph{after} the app's theme (step 2.), so it can
override its settings. Removed when the app that added it stops.
\item Themes specified explicitly in \code{\link[=cli_div]{cli_div()}} elements. These are
removed from the theme stack, when the corresponding \code{\link[=cli_div]{cli_div()}}
elements are closed.
}
}
\section{Writing themes}{
A theme is a named list of lists. The name of each entry is a CSS
selector. Only a subset of CSS is supported:
\itemize{
\item Type selectors, e.g. \code{input} selects all \verb{} elements.
\item Class selectors, e.g. \code{.index} selects any element that has a class
of "index".
\item ID selector. \verb{#toc} will match the element that has the ID "toc".
\item The descendant combinator, i.e. the space, that selects nodes
that are descendants of the first element. E.g. \verb{div span} will match
all \verb{} elements that are inside a \verb{
}}\preformatted{x <- seq(0, 1, length = 10)
spark_line(x)
}\if{html}{\out{
}}\if{html}{\out{
#> ⣀⡠⠔⠊⠉
}}\preformatted{options(cli.palette = "vscode")
}\if{html}{\out{
}}
It is currently not possible to configure the background colors
separately, these will be always the same as the foreground colors.
If your platform only has 256 colors, then the colors specified in the
palette have to be interpolated. On true color platforms they RGB
values are used as-is.
\code{ansi_palettes} is a data frame of the built-in palettes, each row
is one palette.
\code{ansi_palette_show()} shows the colors of an ANSI palette on the screen.
}
\examples{
ansi_palettes
ansi_palette_show("dichro", colors = truecolor)
}
\keyword{datasets}
cli/man/builtin_theme.Rd 0000644 0001762 0000144 00000012340 14535114677 014730 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/themes.R
\name{builtin_theme}
\alias{builtin_theme}
\title{The built-in CLI theme}
\usage{
builtin_theme(dark = getOption("cli.theme_dark", "auto"))
}
\arguments{
\item{dark}{Whether to use a dark theme. The \code{cli.theme_dark} option
can be used to request a dark theme explicitly. If this is not set,
or set to \code{"auto"}, then cli tries to detect a dark theme, this
works in recent RStudio versions and in iTerm on macOS.}
}
\value{
A named list, a CLI theme.
}
\description{
This theme is always active, and it is at the bottom of the theme
stack. See \link{themes}.
}
\section{Showcase}{
\if{html}{\out{}}\preformatted{cli_h1("Heading 1")
cli_h2("Heading 2")
cli_h3("Heading 3")
cli_par()
cli_alert_danger("Danger alert")
cli_alert_warning("Warning alert")
cli_alert_info("Info alert")
cli_alert_success("Success alert")
cli_alert("Alert for starting a process or computation",
class = "alert-start")
cli_end()
cli_text("Packages and versions: \{.pkg cli\} \{.version 1.0.0\}.")
cli_text("Time intervals: \{.timestamp 3.4s\}")
cli_text("\{.emph Emphasis\} and \{.strong strong emphasis\}")
cli_text("This is a piece of code: \{.code sum(x) / length(x)\}")
cli_text("Function names: \{.fn cli::simple_theme\}")
cli_text("Files: \{.file /usr/bin/env\}")
cli_text("URLs: \{.url https://r-project.org\}")
cli_h2("Longer code chunk")
cli_par(class = "code R")
cli_verbatim(
'# window functions are useful for grouped mutates',
'mtcars \%>\%',
' group_by(cyl) \%>\%',
' mutate(rank = min_rank(desc(mpg)))')
}\if{html}{\out{
}}\if{html}{\out{
#> ── Heading 1 ───────────────────────────────────────────────────────── #> #> ── Heading 2 ── #> #> ── Heading 3 #> ✖ Danger alert #> ! Warning alert #> ℹ Info alert #> ✔ Success alert #> → Alert for starting a process or computation #> #> Packages and versions: cli 1.0.0. #> Time intervals: [3.4s] #> Emphasis and strong emphasis #> This is a piece of code: `sum(x) / length(x)` #> Function names: `cli::simple_theme()` #> Files: /usr/bin/env #> URLs: <https://r-project.org> #> #> ── Longer code chunk ── #> #> # window functions are useful for grouped mutates #> mtcars %>% #> group_by(cyl) %>% #> mutate(rank = min_rank(desc(mpg)))
}}\preformatted{rule()
}\if{html}{\out{
}}\if{html}{\out{
#> ──────────────────────────────────────────────────────────────────────
}}\preformatted{rule(line = 2)
}\if{html}{\out{
}}\if{html}{\out{
#> ══════════════════════════════════════════════════════════════════════
}}\preformatted{rule(line = "bar2")
rule(line = "bar5")
}\if{html}{\out{
}}\if{html}{\out{
#> ▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂ #> ▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅▅
}}\preformatted{rule(center = "TITLE", line = "~")
}\if{html}{\out{
}}\if{html}{\out{
#> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ TITLE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
}}\preformatted{rule(center = "TITLE", line = col_blue("~-"))
}\if{html}{\out{
}}\if{html}{\out{
#> ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~- TITLE ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~
}}\preformatted{rule(center = bg_red(" ", symbol$star, "TITLE",
symbol$star, " "),
line = "\\u2582",
line_col = "orange")
}\if{html}{\out{
}}\if{html}{\out{
#> ▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂ ★TITLE★ ▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂▂
}}\preformatted{rule(left = "Results")
}\if{html}{\out{
}}\if{html}{\out{
#> ── Results ───────────────────────────────────────────────────────────
}}\preformatted{rule(center = " * RESULTS * ")
}\if{html}{\out{
}}\if{html}{\out{
#> ──────────────────────────── * RESULTS * ───────────────────────────
}}\preformatted{rule(center = col_red(" * RESULTS * "))
}\if{html}{\out{
}}\if{html}{\out{
#> ──────────────────────────── * RESULTS * ───────────────────────────
}}\preformatted{rule(center = col_red(" * RESULTS * "), line_col = "red")
}\if{html}{\out{
}}\if{html}{\out{
#> ──────────────────────────── * RESULTS * ───────────────────────────
}}\preformatted{fun <- function() \{
cli_ol(c("one", "two", "three"))
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> 1. one #> 2. two #> 3. three
}}\preformatted{## Adding items one by one
fun <- function() \{
cli_ol()
cli_li("\{.emph one\}")
cli_li("\{.emph two\}")
cli_li("\{.emph three\}")
cli_end()
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> 1. one #> 2. two #> 3. three
}}\preformatted{fun <- function() \{
cli_div(theme = list(ol = list("margin-left" = 2)))
cli_ul()
cli_li("one")
cli_ol(c("foo", "bar", "foobar"))
cli_li("two")
cli_end()
cli_end()
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> • one #> 1. foo #> 2. bar #> 3. foobar #> • two
}}\preformatted{fun <- function() \{
cli_alert_info("Before the progress bar")
cli_progress_bar("Calculating", total = 100)
for (i in 1:50) \{
Sys.sleep(4/100)
cli_progress_update()
\}
cli_progress_output("Already half way!")
for (i in 1:50) \{
Sys.sleep(4/100)
cli_progress_update()
\}
cli_alert_info("All done")
\}
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-output2.svg}}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{progress bar functions}
cli/man/tree.Rd 0000644 0001762 0000144 00000040161 14332664317 013035 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tree.R
\name{tree}
\alias{tree}
\title{Draw a tree}
\usage{
tree(
data,
root = data[[1]][[1]],
style = NULL,
width = console_width(),
trim = FALSE
)
}
\arguments{
\item{data}{Data frame that contains the tree structure.
The first column is an id, and the second column is a list column,
that contains the ids of the child nodes. The optional third column
may contain the text to print to annotate the node.}
\item{root}{The name of the root node.}
\item{style}{Optional box style list.}
\item{width}{Maximum width of the output. Defaults to the \code{width}
option, see \code{\link[base:options]{base::options()}}.}
\item{trim}{Whether to avoid traversing the same nodes multiple times.
If \code{TRUE} and \code{data} has a \code{trimmed} column, then that is used for
printing repeated nodes.}
}
\value{
Character vector, the lines of the tree drawing.
}
\description{
Draw a tree using box drawing characters. Unicode characters are
used if available. (Set the \code{cli.unicode} option if auto-detection
fails.)
}
\details{
A node might appear multiple times in the tree, or might not appear
at all.
\if{html}{\out{}}\preformatted{data <- data.frame(
stringsAsFactors = FALSE,
package = c("processx", "backports", "assertthat", "Matrix",
"magrittr", "rprojroot", "clisymbols", "prettyunits", "withr",
"desc", "igraph", "R6", "crayon", "debugme", "digest", "irlba",
"rcmdcheck", "callr", "pkgconfig", "lattice"),
dependencies = I(list(
c("assertthat", "crayon", "debugme", "R6"), character(0),
character(0), "lattice", character(0), "backports", character(0),
c("magrittr", "assertthat"), character(0),
c("assertthat", "R6", "crayon", "rprojroot"),
c("irlba", "magrittr", "Matrix", "pkgconfig"), character(0),
character(0), "crayon", character(0), "Matrix",
c("callr", "clisymbols", "crayon", "desc", "digest", "prettyunits",
"R6", "rprojroot", "withr"),
c("processx", "R6"), character(0), character(0)
))
)
tree(data)
}\if{html}{\out{
}}\if{html}{\out{
#> processx #> ├─assertthat #> ├─crayon #> ├─debugme #> │ └─crayon #> └─R6
}}\preformatted{tree(data, root = "rcmdcheck")
}\if{html}{\out{
}}\if{html}{\out{
#> rcmdcheck #> ├─callr #> │ ├─processx #> │ │ ├─assertthat #> │ │ ├─crayon #> │ │ ├─debugme #> │ │ │ └─crayon #> │ │ └─R6 #> │ └─R6 #> ├─clisymbols #> ├─crayon #> ├─desc #> │ ├─assertthat #> │ ├─R6 #> │ ├─crayon #> │ └─rprojroot #> │ └─backports #> ├─digest #> ├─prettyunits #> │ ├─magrittr #> │ └─assertthat #> ├─R6 #> ├─rprojroot #> │ └─backports #> └─withr
}}\preformatted{data$label <- paste(data$package,
style_dim(paste0("(", c("2.0.0.1", "1.1.1", "0.2.0", "1.2-11",
"1.5", "1.2", "1.2.0", "1.0.2", "2.0.0", "1.1.1.9000", "1.1.2",
"2.2.2", "1.3.4", "1.0.2", "0.6.12", "2.2.1", "1.2.1.9002",
"1.0.0.9000", "2.0.1", "0.20-35"), ")"))
)
roots <- ! data$package \%in\% unlist(data$dependencies)
data$label[roots] <- col_cyan(style_italic(data$label[roots]))
tree(data, root = "rcmdcheck")
}\if{html}{\out{
}}\if{html}{\out{
#> rcmdcheck (1.2.1.9002)
#> ├─callr (1.0.0.9000)
#> │ ├─processx (2.0.0.1)
#> │ │ ├─assertthat (0.2.0)
#> │ │ ├─crayon (1.3.4)
#> │ │ ├─debugme (1.0.2)
#> │ │ │ └─crayon (1.3.4)
#> │ │ └─R6 (2.2.2)
#> │ └─R6 (2.2.2)
#> ├─clisymbols (1.2.0)
#> ├─crayon (1.3.4)
#> ├─desc (1.1.1.9000)
#> │ ├─assertthat (0.2.0)
#> │ ├─R6 (2.2.2)
#> │ ├─crayon (1.3.4)
#> │ └─rprojroot (1.2)
#> │ └─backports (1.1.1)
#> ├─digest (0.6.12)
#> ├─prettyunits (1.0.2)
#> │ ├─magrittr (1.5)
#> │ └─assertthat (0.2.0)
#> ├─R6 (2.2.2)
#> ├─rprojroot (1.2)
#> │ └─backports (1.1.1)
#> └─withr (2.0.0)
}}\preformatted{pkgdeps <- list(
"dplyr@0.8.3" = c("assertthat@0.2.1", "glue@1.3.1", "magrittr@1.5",
"R6@2.4.0", "Rcpp@1.0.2", "rlang@0.4.0", "tibble@2.1.3",
"tidyselect@0.2.5"),
"assertthat@0.2.1" = character(),
"glue@1.3.1" = character(),
"magrittr@1.5" = character(),
"pkgconfig@2.0.3" = character(),
"R6@2.4.0" = character(),
"Rcpp@1.0.2" = character(),
"rlang@0.4.0" = character(),
"tibble@2.1.3" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
"pillar@1.4.2", "pkgconfig@2.0.3", "rlang@0.4.0"),
"cli@1.1.0" = c("assertthat@0.2.1", "crayon@1.3.4"),
"crayon@1.3.4" = character(),
"fansi@0.4.0" = character(),
"pillar@1.4.2" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
"rlang@0.4.0", "utf8@1.1.4", "vctrs@0.2.0"),
"utf8@1.1.4" = character(),
"vctrs@0.2.0" = c("backports@1.1.5", "ellipsis@0.3.0",
"digest@0.6.21", "glue@1.3.1", "rlang@0.4.0", "zeallot@0.1.0"),
"backports@1.1.5" = character(),
"ellipsis@0.3.0" = c("rlang@0.4.0"),
"digest@0.6.21" = character(),
"glue@1.3.1" = character(),
"zeallot@0.1.0" = character(),
"tidyselect@0.2.5" = c("glue@1.3.1", "purrr@1.3.1", "rlang@0.4.0",
"Rcpp@1.0.2"),
"purrr@0.3.3" = c("magrittr@1.5", "rlang@0.4.0")
)
pkgs <- data.frame(
stringsAsFactors = FALSE,
name = names(pkgdeps),
deps = I(unname(pkgdeps))
)
tree(pkgs, trim = TRUE)
}\if{html}{\out{
}}\if{html}{\out{
#> dplyr@0.8.3 #> ├─assertthat@0.2.1 #> ├─glue@1.3.1 #> ├─magrittr@1.5 #> ├─R6@2.4.0 #> ├─Rcpp@1.0.2 #> ├─rlang@0.4.0 #> ├─tibble@2.1.3 #> │ ├─cli@1.1.0 #> │ │ ├─assertthat@0.2.1 #> │ │ └─crayon@1.3.4 #> │ ├─crayon@1.3.4 #> │ ├─fansi@0.4.0 #> │ ├─pillar@1.4.2 #> │ │ ├─cli@1.1.0 #> │ │ ├─crayon@1.3.4 #> │ │ ├─fansi@0.4.0 #> │ │ ├─rlang@0.4.0 #> │ │ ├─utf8@1.1.4 #> │ │ └─vctrs@0.2.0 #> │ │ ├─backports@1.1.5 #> │ │ ├─ellipsis@0.3.0 #> │ │ │ └─rlang@0.4.0 #> │ │ ├─digest@0.6.21 #> │ │ ├─glue@1.3.1 #> │ │ ├─rlang@0.4.0 #> │ │ └─zeallot@0.1.0 #> │ ├─pkgconfig@2.0.3 #> │ └─rlang@0.4.0 #> └─tidyselect@0.2.5 #> ├─glue@1.3.1 #> ├─rlang@0.4.0 #> └─Rcpp@1.0.2
}}\preformatted{# Mark the trimmed nodes
pkgs$label <- pkgs$name
pkgs$trimmed <- paste(pkgs$name, " (trimmed)")
tree(pkgs, trim = TRUE)
}\if{html}{\out{
}}\if{html}{\out{
#> dplyr@0.8.3 #> ├─assertthat@0.2.1 #> ├─glue@1.3.1 #> ├─magrittr@1.5 #> ├─R6@2.4.0 #> ├─Rcpp@1.0.2 #> ├─rlang@0.4.0 #> ├─tibble@2.1.3 #> │ ├─cli@1.1.0 #> │ │ ├─assertthat@0.2.1 (trimmed) #> │ │ └─crayon@1.3.4 #> │ ├─crayon@1.3.4 (trimmed) #> │ ├─fansi@0.4.0 #> │ ├─pillar@1.4.2 #> │ │ ├─cli@1.1.0 (trimmed) #> │ │ ├─crayon@1.3.4 (trimmed) #> │ │ ├─fansi@0.4.0 (trimmed) #> │ │ ├─rlang@0.4.0 (trimmed) #> │ │ ├─utf8@1.1.4 #> │ │ └─vctrs@0.2.0 #> │ │ ├─backports@1.1.5 #> │ │ ├─ellipsis@0.3.0 #> │ │ │ └─rlang@0.4.0 (trimmed) #> │ │ ├─digest@0.6.21 #> │ │ ├─glue@1.3.1 (trimmed) #> │ │ ├─rlang@0.4.0 (trimmed) #> │ │ └─zeallot@0.1.0 #> │ ├─pkgconfig@2.0.3 #> │ └─rlang@0.4.0 (trimmed) #> └─tidyselect@0.2.5 #> ├─glue@1.3.1 (trimmed) #> ├─rlang@0.4.0 (trimmed) #> └─Rcpp@1.0.2 (trimmed)
}}\preformatted{cli_bullets(c(
"noindent",
" " = "indent",
"*" = "bullet",
">" = "arrow",
"v" = "success",
"x" = "danger",
"!" = "warning",
"i" = "info"
))
}\if{html}{\out{
}}\if{html}{\out{
#> noindent #> indent #> • bullet #> → arrow #> ✔ success #> ✖ danger #> ! warning #> ℹ info
}}\preformatted{fun <- function() \{
cli_ul(c("one", "two", "three"))
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> • one #> • two #> • three
}}\preformatted{fun <- function() \{
cli_ul()
cli_li("\{.emph one\}")
cli_li("\{.emph two\}")
cli_li("\{.emph three\}")
cli_end()
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> • one #> • two #> • three
}}\preformatted{x <- seq(0, 1, length = 6)
spark_bar(x)
}\if{html}{\out{
}}\if{html}{\out{
#> ▁▂▄▅▇█
}}\preformatted{x <- seq(0, 1, length = 6)
spark_bar(sample(x))
}\if{html}{\out{
}}\if{html}{\out{
#> ▅▁█▄▇▂
}}\preformatted{spark_bar(seq(0, 1, length = 8))
}\if{html}{\out{
}}\if{html}{\out{
#> ▁▂▃▄▅▆▇█
}}\preformatted{spark_bar(c(0, NA, 0.5, NA, 1))
}\if{html}{\out{
}}\if{html}{\out{
#> ▁ ▄ █
}}\preformatted{evil <- paste(
"The real problem is that programmers have spent far too much time",
"worrying about efficiency in the wrong places and at the wrong",
"times; premature optimization is the root of all evil (or at least",
"most of it) in programming.")
cli_blockquote(evil, citation = "Donald Ervin Knuth")
}\if{html}{\out{
}}\if{html}{\out{
#> #> “The real problem is that programmers have spent far #> too much time worrying about efficiency in the wrong #> places and at the wrong times; premature optimization #> is the root of all evil (or at least most of it) in #> programming.” #> — Donald Ervin Knuth #>
}}\preformatted{d <- cli_div(theme = list(h1 = list(color = "blue",
"font-weight" = "bold")))
cli_h1("Custom title")
cli_end(d)
}\if{html}{\out{
}}\if{html}{\out{
#>
#> Custom title
}}\preformatted{div <- function() \{
cli_div(class = "tmp", theme = list(.tmp = list(color = "yellow")))
cli_text("This is yellow")
\}
div()
cli_text("This is not yellow any more")
}\if{html}{\out{
}}\if{html}{\out{
#> This is yellow
#> This is not yellow any more
}}\preformatted{fun <- function() \{
cli_div(id = "mydiv")
cli_par(class = "myclass")
cli:::cli_debug_doc()
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> #> <cli document> #> <body id="body"> #> <div id="mydiv"> +theme #> <par id="cli-82040-226" class="myclass">
}}\preformatted{pkg <- "mypackage"
cli_rule(left = "\{.pkg \{pkg\}\} results")
}\if{html}{\out{
}}\if{html}{\out{
#> ── mypackage results ─────────────────────────────────────────────────
}}\preformatted{d <- cli_div(theme = list(rule = list(
color = "cyan",
"line-type" = "double")))
cli_rule("Summary", right = "\{.pkg mypackage\}")
cli_end(d)
}\if{html}{\out{
}}\if{html}{\out{
#> ══ Summary ══════════════════════════════════════════════ mypackage ══
}}\preformatted{options(cli.unicode = FALSE)
}\if{html}{\out{
}}
A related issue: \url{https://github.com/r-lib/cli/issues/320}
}
\subsection{Is there a suggested font to use with cli?}{
In modern terminals, cli output usually looks good.
If you see too wide heading separators in RStudio, then see the previous
question: Why are heading separators wider than my screen in RStudio?.
If some output is garbled, then cli probably misdetected Unicode support
for your terminal or font. You can try choosing a different font. In our
experience output looks good with Menlo, Fira Code and Source Code Pro.
Alternatively you can turn off Unicode output:
\if{html}{\out{}}\preformatted{options(cli.unicode = FALSE)
}\if{html}{\out{
}}
If you think this is our fault, then please also file an issue at
\url{https://github.com/r-lib/cli/issues}
}
}
cli/man/ansi_toupper.Rd 0000644 0001762 0000144 00000004125 14143453131 014574 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_toupper}
\alias{ansi_toupper}
\alias{ansi_tolower}
\alias{ansi_chartr}
\title{ANSI character translation and case folding}
\usage{
ansi_toupper(x)
ansi_tolower(x)
ansi_chartr(old, new, x)
}
\arguments{
\item{x}{Input string. May have ANSI colors and styles.}
\item{old}{a character string specifying the characters to be
translated. If a character vector of length 2 or more is supplied,
the first element is used with a warning.}
\item{new}{a character string specifying the translations. If a
character vector of length 2 or more is supplied, the first element
is used with a warning.}
}
\value{
Character vector of the same length as \code{x}, containing
the translated strings. ANSI styles are retained.
}
\description{
There functions are similar to \code{\link[=toupper]{toupper()}}, \code{\link[=tolower]{tolower()}} and
\code{\link[=chartr]{chartr()}}, but they keep the ANSI colors of the string.
}
\examples{
ansi_toupper(col_red("Uppercase"))
ansi_tolower(col_red("LowerCase"))
x <- paste0(col_green("MiXeD"), col_red(" cAsE 123"))
ansi_chartr("iXs", "why", x)
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_trimws}()}
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_trimws}()}
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/man/progress-variables.Rd 0000644 0001762 0000144 00000041405 14500305721 015676 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-variables.R
\name{progress-variables}
\alias{progress-variables}
\alias{cli__pb_bar}
\alias{pb_bar}
\alias{cli__pb_current}
\alias{pb_current}
\alias{cli__pb_current_bytes}
\alias{pb_current_bytes}
\alias{cli__pb_elapsed}
\alias{pb_elapsed}
\alias{cli__pb_elapsed_clock}
\alias{pb_elapsed_clock}
\alias{cli__pb_elapsed_raw}
\alias{pb_elapsed_raw}
\alias{cli__pb_eta}
\alias{pb_eta}
\alias{cli__pb_eta_raw}
\alias{pb_eta_raw}
\alias{cli__pb_eta_str}
\alias{pb_eta_str}
\alias{cli__pb_extra}
\alias{pb_extra}
\alias{cli__pb_id}
\alias{pb_id}
\alias{cli__pb_name}
\alias{pb_name}
\alias{cli__pb_percent}
\alias{pb_percent}
\alias{cli__pb_pid}
\alias{pb_pid}
\alias{cli__pb_rate}
\alias{pb_rate}
\alias{cli__pb_rate_raw}
\alias{pb_rate_raw}
\alias{cli__pb_rate_bytes}
\alias{pb_rate_bytes}
\alias{cli__pb_spin}
\alias{pb_spin}
\alias{cli__pb_status}
\alias{pb_status}
\alias{cli__pb_timestamp}
\alias{pb_timestamp}
\alias{cli__pb_total}
\alias{pb_total}
\alias{cli__pb_total_bytes}
\alias{pb_total_bytes}
\title{Progress bar variables}
\description{
Progress bar variables
}
\details{
These variables can be used in cli progress bar format
strings. They are calculated on demand. To use a variable, e.g. \code{pb_bar}
in a package, you either need to to import \code{pb_bar} from cli, or use
the qualified form in the format string: \code{cli::pb_bar}.
Similarly, in R scripts, you can use \code{pb_bar} after \code{library(cli)},
or \code{cli::pb_bar} if you do not attach the cli package.
\subsection{\code{pb_bar}}{
Creates a visual progress bar. If the number of total units
is unknown, then it will return an empty string.
\if{html}{\out{}}\preformatted{cli_progress_bar(
total = 100,
format = "Fitting model \{cli::pb_bar\} \{cli::pb_percent\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Fitting model ███████████████████████████████ 66%
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_spin\} Reading file \{cli::pb_current\}/\{cli::pb_total\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ⠙ Reading file 66/100
}}\preformatted{cli_progress_bar(
format = "Got \{cli::pb_current_bytes\} in \{cli::pb_elapsed\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Got 524 kB in 5s
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} [\{cli::pb_elapsed\}]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% [5s]
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} [\{cli::pb_elapsed_clock\}]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% [00:00:05]
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} [\{round(cli::pb_elapsed_raw)\}s]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% [5s]
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} | ETA: \{cli::pb_eta\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% | ETA: 3s
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} | ETA: \{round(cli::pb_eta_raw)\}s"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% | ETA: 3s
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\} | \{cli::pb_eta_str\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66% | ETA: 3s
}}\preformatted{cli_progress_bar(
total = 100,
extra = list(user = whoami::username()),
format = "Cleaning cache for user '\{cli::pb_extra$user\}': \{cli::pb_current_bytes\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Cleaning cache for user 'gaborcsardi': 161 MB
}}\preformatted{cli_progress_bar(
format = "Progress bar '\{cli::pb_id\}' is at \{cli::pb_current\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Progress bar 'cli-82040-1814' is at 64
}}\preformatted{cli_progress_bar(
name = "Loading training data",
total = 100,
format = "\{cli::pb_name\} \{cli::pb_bar\} \{cli::pb_percent\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Loading training data ███████████████████████████████ 66%
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_bar\} \{cli::pb_percent\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ███████████████████████████████ 66%
}}\preformatted{cli_progress_bar(
total = 156,
format = "Reading input files \{pb_current\}/\{pb_total\} [\{pb_rate\}]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Reading input files 68/156 [14/s]
}}\preformatted{cli_progress_bar(
total = 156,
format = "Reading input files \{pb_current\}/\{pb_total\} [\{round(pb_rate_raw)\}/s]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Reading input files 68/156 [14/s]
}}\preformatted{cli_progress_bar(
total = 256 * 1024 * 1014,
format = paste0(
"Reading data \{pb_current_bytes\}/\{pb_total_bytes\} ",
"[\{ansi_trimws(pb_rate_bytes)\}]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Reading data 70 MB/266 MB [14 MB/s]
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_spin\} Reading file \{cli::pb_current\}/\{cli::pb_total\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ⠙ Reading file 66/100
}}\preformatted{cli_progress_bar(status = "Connecting...")
}\if{html}{\out{
}}\if{html}{\out{
#> ⠙ Connecting... 0 done (0/s) | 1s
}}\preformatted{cli_progress_bar(
"Loading training data files",
format = "\{pb_timestamp\} \{pb_current\} (\{pb_rate\})"
}\if{html}{\out{
}}\if{html}{\out{
#> 2022-09-07T11:27:50+00:00 125 (25/s)
}}\preformatted{cli_progress_bar(
total = 100,
format = "\{cli::pb_spin\} Reading file \{cli::pb_current\}/\{cli::pb_total\}"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ⠙ Reading file 66/100
}}\preformatted{cli_progress_bar(
total = 256 * 1024 * 1014,
format = paste0(
"Reading data \{pb_current_bytes\}/\{pb_total_bytes\} ",
"[\{ansi_trimws(pb_rate_bytes)\}]"
)
}\if{html}{\out{
}}\if{html}{\out{
#> Reading data 70 MB/266 MB [14 MB/s]
}}\preformatted{myfun <- function() \{
message("Just an example function")
graphics::pairs(iris, col = 1:4)
\}
cli_code(format(myfun))
}\if{html}{\out{
}}\if{html}{\out{
#> function () #> \{ #> message("Just an example function") #> graphics::pairs(iris, col = 1:4) #> \}
}}\preformatted{fmt <- ansi_columns(
paste(col_red("foo"), 1:10),
width = 50,
fill = "rows",
max_cols=10,
align = "center",
sep = " "
)
boxx(fmt, padding = c(0,1,0,1), header = col_cyan("Columns"))
}\if{html}{\out{
}}\if{html}{\out{
#> ┌ Columns ───────────────────────────────────────────┐ #> │ foo 1 foo 2 foo 3 foo 4 foo 5 │ #> │ foo 6 foo 7 foo 8 foo 9 foo 10 │ #> └────────────────────────────────────────────────────┘
}}\preformatted{months <- month.name[1:3]
cli_text("\{.val \{months\}\}")
}\if{html}{\out{
}}\if{html}{\out{
#> "January", "February", and "March"
}}\preformatted{nums <- 1:5 / 7
cli_text("\{.val \{nums\}\}")
}\if{html}{\out{
}}\if{html}{\out{
#> 0.142857142857143, 0.285714285714286, 0.428571428571429, #> 0.571428571428571, and 0.714285714285714
}}\preformatted{nums <- 1:5 / 7
divid <- cli_div(theme = list(.val = list(digits = 3)))
cli_text("\{.val \{nums\}\}")
cli_end(divid)
}\if{html}{\out{
}}\if{html}{\out{
#> 0.143, 0.286, 0.429, 0.571, and 0.714
}}\preformatted{cli_format.month <- function(x, style = NULL, ...) \{
x <- encodeString(substr(x, 1, 3), quote = "\\"")
NextMethod("cli_format")
\}
registerS3method("cli_format", "month", cli_format.month)
months <- structure(month.name[1:3], class = "month")
cli_text("\{.val \{months\}\}")
}\if{html}{\out{
}}\if{html}{\out{
#> "Jan", "Feb", and "Mar"
}}\preformatted{fun <- function() \{
cli_progress_message("Task one is running...")
Sys.sleep(2)
cli_progress_message("Task two is running...")
Sys.sleep(2)
step <- 1L
cli_progress_message("Task three is underway: step \{step\}")
for (step in 1:5) \{
Sys.sleep(0.5)
cli_progress_update()
\}
\}
fun()
}\if{html}{\out{
}}
\if{html}{\figure{progress-message.svg}}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
\code{\link[=cli_progress_bar]{cli_progress_bar()}} for the complete progress bar API.
\code{\link[=cli_progress_step]{cli_progress_step()}} for a similar display that is styled by default.
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{progress bar functions}
cli/man/ansi_strtrim.Rd 0000644 0001762 0000144 00000002314 14317007616 014606 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_strtrim}
\alias{ansi_strtrim}
\title{Truncate an ANSI string}
\usage{
ansi_strtrim(x, width = console_width(), ellipsis = symbol$ellipsis)
}
\arguments{
\item{x}{Character vector of ANSI strings.}
\item{width}{The width to truncate to.}
\item{ellipsis}{The string to append to truncated strings. Supply an
empty string if you don't want a marker.}
}
\description{
This function is similar to \code{\link[base:strtrim]{base::strtrim()}}, but works correctly with
ANSI styled strings. It also adds \code{...} (or the corresponding Unicode
character if Unicode characters are allowed) to the end of truncated
strings.
}
\details{
Note: \code{ansi_strtrim()} does not support NA values currently.
}
\examples{
text <- cli::col_red(cli:::lorem_ipsum())
ansi_strtrim(c(text, "foobar"), 40)
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_toupper}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/man/boxx.Rd 0000644 0001762 0000144 00000042225 14332664317 013061 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/box-styles.R, R/boxes.R
\name{list_border_styles}
\alias{list_border_styles}
\alias{boxx}
\title{Draw a banner-like box in the console}
\usage{
list_border_styles()
boxx(
label,
header = "",
footer = "",
border_style = "single",
padding = 1,
margin = 0,
float = c("left", "center", "right"),
col = NULL,
background_col = NULL,
border_col = col,
align = c("left", "center", "right"),
width = console_width()
)
}
\arguments{
\item{label}{Label to show, a character vector. Each element will be
in a new line. You can color it using the \verb{col_*}, \verb{bg_*} and
\verb{style_*} functions, see \link[=ansi-styles]{ANSI styles} and the examples
below.}
\item{header}{Text to show on top border of the box. If too long,
it will be cut.}
\item{footer}{Text to show on the bottom border of the box. If too long,
it will be cut.}
\item{border_style}{String that specifies the border style.
\code{list_border_styles} lists all current styles.}
\item{padding}{Padding within the box. Either an integer vector of
four numbers (bottom, left, top, right), or a single number \code{x}, which
is interpreted as \code{c(x, 3*x, x, 3*x)}.}
\item{margin}{Margin around the box. Either an integer vector of four
numbers (bottom, left, top, right), or a single number \code{x}, which is
interpreted as \code{c(x, 3*x, x, 3*x)}.}
\item{float}{Whether to display the box on the \code{"left"}, \code{"center"}, or
the \code{"right"} of the screen.}
\item{col}{Color of text, and default border color. Either a style
function (see \link[=ansi-styles]{ANSI styles}) or a color name that is
passed to \code{\link[=make_ansi_style]{make_ansi_style()}}.}
\item{background_col}{Background color of the inside of the box.
Either a style function (see \link[=ansi-styles]{ANSI styles}), or a color
name which will be used in \code{\link[=make_ansi_style]{make_ansi_style()}} to create a
\emph{background} style (i.e. \code{bg = TRUE} is used).}
\item{border_col}{Color of the border. Either a style function
(see \link[=ansi-styles]{ANSI styles}) or a color name that is passed to
\code{\link[=make_ansi_style]{make_ansi_style()}}.}
\item{align}{Alignment of the label within the box: \code{"left"},
\code{"center"}, or \code{"right"}.}
\item{width}{Width of the screen, defaults to \code{\link[=console_width]{console_width()}}.}
}
\description{
Draw a banner-like box in the console
}
\details{
\subsection{Defaults}{
\if{html}{\out{}}\preformatted{boxx("Hello there!")
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘
}}\preformatted{boxx("Hello there!", border_style = "double")
}\if{html}{\out{
}}\if{html}{\out{
#> ╔══════════════════╗ #> ║ ║ #> ║ Hello there! ║ #> ║ ║ #> ╚══════════════════╝
}}\preformatted{boxx(c("Hello", "there!"), padding = 1)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌────────────┐ #> │ │ #> │ Hello │ #> │ there! │ #> │ │ #> └────────────┘
}}\preformatted{boxx("Hello there!", padding = 1)
boxx("Hello there!", padding = c(1, 5, 1, 5))
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘ #> ┌──────────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────────┘
}}\preformatted{boxx("Hello there!", padding = 1, float = "center")
boxx("Hello there!", padding = 1, float = "right")
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘ #> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘
}}\preformatted{boxx(col_cyan("Hello there!"), padding = 1, float = "center")
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐
#> │ │
#> │ Hello there! │
#> │ │
#> └──────────────────┘
}}\preformatted{boxx("Hello there!", padding = 1, background_col = "brown")
boxx("Hello there!", padding = 1, background_col = bg_red)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘ #> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘
}}\preformatted{boxx("Hello there!", padding = 1, border_col = "green")
boxx("Hello there!", padding = 1, border_col = col_red)
}\if{html}{\out{
}}\if{html}{\out{
#> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘ #> ┌──────────────────┐ #> │ │ #> │ Hello there! │ #> │ │ #> └──────────────────┘
}}\preformatted{boxx(c("Hi", "there", "you!"), padding = 1, align = "left")
boxx(c("Hi", "there", "you!"), padding = 1, align = "center")
boxx(c("Hi", "there", "you!"), padding = 1, align = "right")
}\if{html}{\out{
}}\if{html}{\out{
#> ┌───────────┐ #> │ │ #> │ Hi │ #> │ there │ #> │ you! │ #> │ │ #> └───────────┘ #> ┌───────────┐ #> │ │ #> │ Hi │ #> │ there │ #> │ you! │ #> │ │ #> └───────────┘ #> ┌───────────┐ #> │ │ #> │ Hi │ #> │ there │ #> │ you! │ #> │ │ #> └───────────┘
}}\preformatted{star <- symbol$star
label <- c(paste(star, "Hello", star), " there!")
boxx(
col_white(label),
border_style="round",
padding = 1,
float = "center",
border_col = "tomato3",
background_col="darkolivegreen"
)
}\if{html}{\out{
}}\if{html}{\out{
#> ╭───────────────╮ #> │ │ #> │ ★ Hello ★ │ #> │ there! │ #> │ │ #> ╰───────────────╯
} element.
}
The content of a theme list entry is another named list, where the
names are CSS properties, e.g. \code{color}, or \code{font-weight} or
\code{margin-left}, and the list entries themselves define the values of
the properties. See \code{\link[=builtin_theme]{builtin_theme()}} and \code{\link[=simple_theme]{simple_theme()}} for examples.
}
\section{Formatter callbacks}{
For flexibility, themes may also define formatter functions, with
property name \code{fmt}. These will be called once the other styles are
applied to an element. They are only called on elements that produce
output, i.e. \emph{not} on container elements.
}
\section{Supported properties}{
Right now only a limited set of properties are supported. These include
left, right, top and bottom margins, background and foreground colors,
bold and italic fonts, underlined text. The \code{before} and \code{after}
properties are supported to insert text before and after the
content of the element.
The current list of properties:
\itemize{
\item \code{after}: A string literal to insert after the element. It can also be
a function that returns a string literal. Supported by all inline
elements, list items, alerts and rules.
\item \code{background-color}: An R color name, or HTML hexadecimal color.
It can be applied to most elements (inline elements, rules, text,
etc.), but the background of containers is not colored properly
currently.
\item \code{before}: A string literal to insert before the element. It can also be
a function that returns a string literal. Supported by all inline
elements, list items, alerts and rules.
\item \code{class-map}: Its value can be a named list, and it specifies how
R (S3) class names are mapped to cli class names. E.g.
\code{list(fs_path = "file")} specifies that \code{fs_path} objects (from the fs
package) should always print as \code{.file} objects in cli.
\item \code{color}: Text color, an R color name or a HTML hexadecimal color. It
can be applied to most elements that are printed.
\item \code{collapse}: Specifies how to collapse a vector, before applying
styling. If a character string, then that is used as the separator.
If a function, then it is called, with the vector as the only
argument.
\item \code{digits}: Number of digits after the decimal point for numeric inline
element of class \code{.val}.
\item \code{fmt}: Generic formatter function that takes an input text and returns
formatted text. Can be applied to most elements. If colors are in use,
the input text provided to \code{fmt} already includes ANSI sequences.
\item \code{font-style}: If \code{"italic"} then the text is printed as cursive.
\item \code{font-weight}: If \code{"bold"}, then the text is printed in boldface.
\item \code{line-type}: Line type for \code{\link[=cli_rule]{cli_rule()}}.
\item \code{list-style-type}: String literal or functions that returns a string
literal, to be used as a list item marker in un-ordered lists.
\item \code{margin-bottom}, \code{margin-left}, \code{margin-right}, \code{margin-top}: Margins.
\item \code{padding-left}, \code{padding-right}: This is currently used the same way
as the margins, but this might change later.
\item \code{start}: Integer number, the first element in an ordered list.
\item \code{string-quote}: Quoting character for inline elements of class \code{.val}.
\item \code{text-decoration}: If \code{"underline"}, then underlined text is created.
\item \code{text-exdent}: Amount of indentation from the second line of wrapped
text.
\item \code{transform}: A function to call on glue substitutions, before
collapsing them. Note that \code{transform} is applied prior to
implementing color via ANSI sequences.
\item \code{vec-last}: The last separator when collapsing vectors.
\item \code{vec-sep}: The separator to use when collapsing vectors.
\item \code{vec-sep2}: The separator to use for two elements when collapsing
vectors. If not set, then \code{vec-sep} is used for these as well.
\item \code{vec-trunc}: Vectors longer than this will be truncated. Defaults to
100.
\item \code{vec-trunc-style}: Select between two ways of collapsing vectors:
\itemize{
\item \code{"both-ends"} is the current default and it shows the beginning and
the end of the vector.
\item \code{"head"} only shows the beginning of the vector.
}
}
More properties might be added later. If you think that a property is
not applied properly to an element, please open an issue about it in
the cli issue tracker.
}
\section{Examples}{
Color of headings, that are only active in paragraphs with an
'output' class:
\if{html}{\out{
}}
\if{html}{\out{
}}
}
\seealso{
These functions support \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/diff_chr.Rd 0000644 0001762 0000144 00000003506 14143453131 013632 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/diff.R
\name{diff_chr}
\alias{diff_chr}
\title{Compare two character vectors elementwise}
\usage{
diff_chr(old, new, max_dist = Inf)
}
\arguments{
\item{old}{First character vector.}
\item{new}{Second character vector.}
\item{max_dist}{Maximum distance to consider, or \code{Inf} for no limit.
If the LCS edit distance is larger than this, then the function
throws an error with class \code{"cli_diff_max_dist"}. (If you specify
\code{Inf} the real limit is \code{.Machine$integer.max} but to reach this the
function would have to run a very long time.)}
}
\value{
A list that is a \code{cli_diff_chr} object, with a \code{format()} and a
\code{print()} method. You can also access its members:
\itemize{
\item \code{old} and \code{new} are the original inputs,
\item \code{lcs} is a data frame of LCS edit that transform \code{old} into \code{new}.
}
The \code{lcs} data frame has the following columns:
\itemize{
\item \code{operation}: one of \code{"match"}, \code{"delete"} or \code{"insert"}.
\item \code{offset}: offset in \code{old} for matches and deletions, offset in \code{new}
for insertions.
\item \code{length}: length of the operation, i.e. number of matching, deleted
or inserted elements.
\item \code{old_offset}: offset in \code{old} \emph{after} the operation.
\item \code{new_offset}: offset in \code{new} \emph{after} the operation.
}
}
\description{
Its printed output is similar to calling \code{diff -u} at the command
line.
}
\examples{
letters2 <- c("P", "R", "E", letters, "P", "O", "S", "T")
letters2[11:16] <- c("M", "I", "D", "D", "L", "E")
diff_chr(letters, letters2)
}
\seealso{
The diffobj package for a much more comprehensive set of
\code{diff}-like tools.
Other diff functions in cli:
\code{\link{diff_str}()}
}
\concept{diff functions in cli}
cli/man/utf8_graphemes.Rd 0000644 0001762 0000144 00000001445 14143453131 015007 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utf8.R
\name{utf8_graphemes}
\alias{utf8_graphemes}
\title{Break an UTF-8 character vector into grapheme clusters}
\usage{
utf8_graphemes(x)
}
\arguments{
\item{x}{Character vector.}
}
\value{
List of characters vectors, the grapheme clusters of the input
string.
}
\description{
Break an UTF-8 character vector into grapheme clusters
}
\examples{
# Five grapheme clusters
str <- paste0(
"\U0001f477\U0001f3ff\u200d\u2640\ufe0f",
"\U0001f477\U0001f3ff",
"\U0001f477\u200d\u2640\ufe0f",
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3ff")
cat(str, "\n")
chrs <- utf8_graphemes(str)
}
\seealso{
Other UTF-8 string manipulation:
\code{\link{utf8_nchar}()},
\code{\link{utf8_substr}()}
}
\concept{UTF-8 string manipulation}
cli/man/ansi_nzchar.Rd 0000644 0001762 0000144 00000001061 14301737210 014356 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_nzchar}
\alias{ansi_nzchar}
\title{Like \code{\link[base:nchar]{base::nzchar()}}, but for ANSI strings}
\usage{
ansi_nzchar(x, ...)
}
\arguments{
\item{x}{Charcater vector. Other objects are coarced using
\code{\link[base:character]{base::as.character()}}.}
\item{...}{Passed to \code{\link[base:nchar]{base::nzchar()}}.}
}
\description{
Like \code{\link[base:nchar]{base::nzchar()}}, but for ANSI strings
}
\examples{
ansi_nzchar("")
ansi_nzchar(col_red(""))
}
cli/man/cli_debug_doc.Rd 0000644 0001762 0000144 00000002543 14143453131 014630 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/debug.R
\name{cli_debug_doc}
\alias{cli_debug_doc}
\title{Debug cli internals}
\usage{
cli_debug_doc(app = default_app() \%||\% start_app())
}
\arguments{
\item{app}{The cli app to debug. Defaults to the current app.
if there is no app, then it creates one by calling \code{\link[=start_app]{start_app()}}.}
}
\value{
Data frame with columns: \code{tag}, \code{id}, \code{class} (space separated),
theme (id of the theme the element added), \code{styles} (computed styles
for the element).
}
\description{
Return the current state of a cli app. It includes the currently
open tags, their ids, classes and their computed styles.
}
\details{
The returned data frame has a print method, and if you want to create
a plain data frame from it, index it with an empty bracket:
\code{cli_debug_doc()[]}.
To see all currently active themes, use \code{app$themes}, e.g. for the
default app: \code{default_app()$themes}.
}
\examples{
\dontrun{
cli_debug_doc()
olid <- cli_ol()
cli_li()
cli_debug_doc()
cli_debug_doc()[]
cli_end(olid)
cli_debug_doc()
}
}
\seealso{
\code{\link[=cli_sitrep]{cli_sitrep()}}. To debug containers, you can set the
\code{CLI-DEBUG_BAD_END} environment variable to \code{true}, and then cli will
warn when it cannot find the specified container to close (or any
contained at all).
}
cli/man/combine_ansi_styles.Rd 0000644 0001762 0000144 00000002521 14143453131 016113 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansi.R
\name{combine_ansi_styles}
\alias{combine_ansi_styles}
\title{Combine two or more ANSI styles}
\usage{
combine_ansi_styles(...)
}
\arguments{
\item{...}{The styles to combine. For character strings, the
\code{\link[=make_ansi_style]{make_ansi_style()}} function is used to create a style first.
They will be applied from right to left.}
}
\value{
The combined style function.
}
\description{
Combine two or more styles or style functions into a new style function
that can be called on strings to style them.
}
\details{
It does not usually make sense to combine two foreground
colors (or two background colors), because only the first one
applied will be used.
It does make sense to combine different kind of styles,
e.g. background color, foreground color, bold font.
}
\examples{
## Use style names
alert <- combine_ansi_styles("bold", "red4")
cat(alert("Warning!"), "\n")
## Or style functions
alert <- combine_ansi_styles(style_bold, col_red, bg_cyan)
cat(alert("Warning!"), "\n")
## Combine a composite style
alert <- combine_ansi_styles(
"bold",
combine_ansi_styles("red", bg_cyan))
cat(alert("Warning!"), "\n")
}
\seealso{
Other ANSI styling:
\code{\link{ansi-styles}},
\code{\link{make_ansi_style}()},
\code{\link{num_ansi_colors}()}
}
\concept{ANSI styling}
cli/man/diff_str.Rd 0000644 0001762 0000144 00000002234 14143453131 013663 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/diff.R
\name{diff_str}
\alias{diff_str}
\title{Compare two character strings, character by character}
\usage{
diff_str(old, new, max_dist = Inf)
}
\arguments{
\item{old}{First string, must not be \code{NA}.}
\item{new}{Second string, must not be \code{NA}.}
\item{max_dist}{Maximum distance to consider, or \code{Inf} for no limit.
If the LCS edit distance is larger than this, then the function
throws an error with class \code{"cli_diff_max_dist"}. (If you specify
\code{Inf} the real limit is \code{.Machine$integer.max} but to reach this the
function would have to run a very long time.)}
}
\value{
A list that is a \code{cli_diff_str} object and also a
\code{cli_diff_chr} object, see \link{diff_str} for the details about its
structure.
}
\description{
Characters are defined by UTF-8 graphemes.
}
\examples{
str1 <- "abcdefghijklmnopqrstuvwxyz"
str2 <- "PREabcdefgMIDDLEnopqrstuvwxyzPOST"
diff_str(str1, str2)
}
\seealso{
The diffobj package for a much more comprehensive set of
\code{diff}-like tools.
Other diff functions in cli:
\code{\link{diff_chr}()}
}
\concept{diff functions in cli}
cli/man/cli_verbatim.Rd 0000644 0001762 0000144 00000003315 14332664317 014536 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_verbatim}
\alias{cli_verbatim}
\title{CLI verbatim text}
\usage{
cli_verbatim(..., .envir = parent.frame())
}
\arguments{
\item{...}{The text to show, in character vectors. Each element is
printed on a new line.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
It is not wrapped, but printed as is. Long lines will overflow.
No glue substitution is performed on verbatim text.
}
\details{
\subsection{Line breaks}{
\if{html}{\out{
}}
}
\subsection{Special characters}{
No glue substitution happens here.
\if{html}{\out{
}}
}
}
\seealso{
\code{\link[=cli_code]{cli_code()}} for printing R or other source code.
}
cli/man/cli_end.Rd 0000644 0001762 0000144 00000007455 14332664317 013504 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_end}
\alias{cli_end}
\title{Close a CLI container}
\usage{
cli_end(id = NULL)
}
\arguments{
\item{id}{Id of the container to close. If missing, the current
container is closed, if any.}
}
\description{
Containers aut0-close by default, but sometimes you need to explicitly
close them. Closing a container also closes all of its nested
containers.
}
\details{
\subsection{Explicit closing}{
\if{html}{\out{
}}
}
\subsection{Closing a stack of containers}{
\if{html}{\out{
}}
}
\subsection{Omitting \code{id}}{
If \code{id} is omitted, the container that was opened last will be closed.
\if{html}{\out{
}}
}
\subsection{Debugging containers}{
You can use the internal \code{cli:::cli_debug_doc()} function to see the
currently open containers.
\if{html}{\out{
}}
}
}
cli/man/cli_par.Rd 0000644 0001762 0000144 00000004407 14332664317 013512 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_par}
\alias{cli_par}
\title{CLI paragraph}
\usage{
cli_par(id = NULL, class = NULL, .auto_close = TRUE, .envir = parent.frame())
}
\arguments{
\item{id}{Element id, a string. If \code{NULL}, then a new id is generated
and returned.}
\item{class}{Class name, sting. Can be used in themes.}
\item{.auto_close}{Whether to close the container, when the calling
function finishes (or \code{.envir} is removed, if specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-close the container if \code{.auto_close} is \code{TRUE}.}
}
\value{
The id of the new container element, invisibly.
}
\description{
The builtin theme leaves an empty line between paragraphs.
See also \link{containers}.
}
\details{
\if{html}{\out{
}}
}
cli/man/format_error.Rd 0000644 0001762 0000144 00000005745 14500305721 014574 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/format-conditions.R
\name{format_error}
\alias{format_error}
\alias{format_warning}
\alias{format_message}
\title{Format an error, warning or diagnostic message}
\usage{
format_error(message, .envir = parent.frame())
format_warning(message, .envir = parent.frame())
format_message(message, .envir = parent.frame())
}
\arguments{
\item{message}{It is formatted via a call to \code{\link[=cli_bullets]{cli_bullets()}}.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
You can then throw this message with \code{\link[=stop]{stop()}} or \code{rlang::abort()}.
}
\details{
The messages can use inline styling, pluralization and glue
substitutions.
\if{html}{\out{
}}
\if{html}{\out{
}}
}
\seealso{
These functions support \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/ruler.Rd 0000644 0001762 0000144 00000000474 14200477712 013225 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ruler.R
\name{ruler}
\alias{ruler}
\title{Print the helpful ruler to the screen}
\usage{
ruler(width = console_width())
}
\arguments{
\item{width}{Ruler width.}
}
\description{
Print the helpful ruler to the screen
}
\examples{
ruler()
}
cli/man/cli_progress_step.Rd 0000644 0001762 0000144 00000012441 14521175065 015621 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-client.R
\name{cli_progress_step}
\alias{cli_progress_step}
\title{Simplified cli progress messages, with styling}
\usage{
cli_progress_step(
msg,
msg_done = msg,
msg_failed = msg,
spinner = FALSE,
class = if (!spinner) ".alert-info",
current = TRUE,
.auto_close = TRUE,
.envir = parent.frame(),
...
)
}
\arguments{
\item{msg}{Message to show. It may contain glue substitution and cli
styling. It can be updated via \code{\link[=cli_progress_update]{cli_progress_update()}}, as usual.
It is style as a cli info alert (see \code{\link[=cli_alert_info]{cli_alert_info()}}).}
\item{msg_done}{Message to show on successful termination. By default
this it is the same as \code{msg} and it is styled as a cli success alert
(see \code{\link[=cli_alert_success]{cli_alert_success()}}).}
\item{msg_failed}{Message to show on unsuccessful termination. By
default it is the same as \code{msg} and it is styled as a cli danger alert
(see \code{\link[=cli_alert_danger]{cli_alert_danger()}}).}
\item{spinner}{Whether to show a spinner at the beginning of the line.
To make the spinner spin, you'll need to call \code{cli_progress_update()}
regularly.}
\item{class}{cli class to add to the message. By default there is no
class for steps with a spinner.}
\item{current}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.auto_close}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.envir}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{...}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
}
\description{
This is a simplified progress bar, a single (dynamic)
message, without progress units.
}
\details{
\code{cli_progress_step()} always shows the progress message,
even if no update is due.
\subsection{Basic use}{
\if{html}{\out{
}}
}
\seealso{
These functions supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/cli_bullets_raw.Rd 0000644 0001762 0000144 00000003220 14500305721 015227 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bullets.R
\name{cli_bullets_raw}
\alias{cli_bullets_raw}
\alias{format_bullets_raw}
\title{List of verbatim items}
\usage{
cli_bullets_raw(text, id = NULL, class = NULL)
format_bullets_raw(text, id = NULL, class = NULL)
}
\arguments{
\item{text}{Character vector of items. See details below on how names
are interpreted.}
\item{id}{Optional id of the \code{div.bullets} element, can be used in themes.}
\item{class}{Optional additional class(es) for the \code{div.bullets} element.}
}
\description{
\code{cli_format_bullets_raw()} is similar to \code{\link[=cli_bullets]{cli_bullets()}}, but it does
not perform any inline styling or glue substitutions in the input.
}
\details{
\code{format_bullets_raw()} returns the output instead of printing it.
}
\seealso{
These functions support \link[=inline-markup]{inline markup}.
See \code{\link[=cli_bullets]{cli_bullets()}} for examples.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/start_app.Rd 0000644 0001762 0000144 00000002337 14143453131 014064 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/app.R
\name{start_app}
\alias{start_app}
\alias{stop_app}
\alias{default_app}
\title{Start, stop, query the default cli application}
\usage{
start_app(
theme = getOption("cli.theme"),
output = c("auto", "message", "stdout", "stderr"),
.auto_close = TRUE,
.envir = parent.frame()
)
stop_app(app = NULL)
default_app()
}
\arguments{
\item{theme}{Theme to use.}
\item{output}{How to print the output.}
\item{.auto_close}{Whether to stop the app, when the calling frame
is destroyed.}
\item{.envir}{The environment to use, instead of the calling frame,
to trigger the stop of the app.}
\item{app}{App to stop. If \code{NULL}, the current default app is stopped.
Otherwise we find the supplied app in the app stack, and remote it,
together with all the apps above it.}
}
\value{
\code{start_app} returns the new app, \code{default_app} returns the default app.
\code{stop_app} does not return anything.
}
\description{
\code{start_app} creates an app, and places it on the top of the app stack.
}
\details{
\code{stop_app} removes the top app, or multiple apps from the app stack.
\code{default_app} returns the default app, the one on the top of the stack.
}
cli/man/demo_spinners.Rd 0000644 0001762 0000144 00000001207 14300722604 014726 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/spinner.R
\name{demo_spinners}
\alias{demo_spinners}
\title{Show a demo of some (by default all) spinners}
\usage{
demo_spinners(which = NULL)
}
\arguments{
\item{which}{Character vector, which spinners to demo.}
}
\description{
Each spinner is shown for about 2-3 seconds.
}
\details{
\if{html}{\out{
}}
}
\subsection{Auto-closing}{
By default a \code{cli_div()} is closed automatically when the calling
frame exits.
\if{html}{\out{
}}
}
}
cli/man/keypress.Rd 0000644 0001762 0000144 00000002356 14331172227 013740 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/keypress.R
\name{keypress}
\alias{keypress}
\title{Read a single keypress at the terminal}
\usage{
keypress(block = TRUE)
}
\arguments{
\item{block}{Whether to wait for a key press, if there is none
available now.}
}
\value{
The key pressed, a character scalar. For non-blocking reads
\code{NA} is returned if no keys are available.
}
\description{
It currently only works at Linux/Unix and OSX terminals,
and at the Windows command line. see \code{\link{has_keypress_support}}.
}
\details{
The following special keys are supported:
\itemize{
\item Arrow keys: 'up', 'down', 'right', 'left'.
\item Function keys: from 'f1' to 'f12'.
\item Others: 'home', 'end', 'insert', 'delete', 'pageup', 'pagedown',
'tab', 'enter', 'backspace' (same as 'delete' on OSX keyboards),
'escape'.
\item Control with one of the following keys: 'a', 'b', 'c', 'd', 'e', 'f',
'h', 'k', 'l', 'n', 'p', 't', 'u', 'w'.
}
}
\examples{
\dontshow{if (FALSE) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
x <- keypress()
cat("You pressed key", x, "\n")
\dontshow{\}) # examplesIf}
}
\seealso{
Other keypress function:
\code{\link{has_keypress_support}()}
}
\concept{keypress function}
cli/man/cli_alert.Rd 0000644 0001762 0000144 00000013603 14500305721 014021 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_alert}
\alias{cli_alert}
\alias{cli_alert_success}
\alias{cli_alert_danger}
\alias{cli_alert_warning}
\alias{cli_alert_info}
\title{CLI alerts}
\usage{
cli_alert(text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame())
cli_alert_success(
text,
id = NULL,
class = NULL,
wrap = FALSE,
.envir = parent.frame()
)
cli_alert_danger(
text,
id = NULL,
class = NULL,
wrap = FALSE,
.envir = parent.frame()
)
cli_alert_warning(
text,
id = NULL,
class = NULL,
wrap = FALSE,
.envir = parent.frame()
)
cli_alert_info(
text,
id = NULL,
class = NULL,
wrap = FALSE,
.envir = parent.frame()
)
}
\arguments{
\item{text}{Text of the alert.}
\item{id}{Id of the alert element. Can be used in themes.}
\item{class}{Class of the alert element. Can be used in themes.}
\item{wrap}{Whether to auto-wrap the text of the alert.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
Alerts are typically short status messages.
}
\details{
\subsection{Success}{
\if{html}{\out{
}}
}
\subsection{Info}{
\if{html}{\out{
}}
}
\subsection{Warning}{
\if{html}{\out{
}}
}
\subsection{Danger}{
\if{html}{\out{
}}
}
\subsection{Text wrapping}{
Alerts are printed without wrapping, unless you set \code{wrap = TRUE}:
\if{html}{\out{
}}
}
}
\seealso{
These functions supports \link[=inline-markup]{inline markup}.
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
cli/man/is_dynamic_tty.Rd 0000644 0001762 0000144 00000003577 14143453131 015115 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tty.R
\name{is_dynamic_tty}
\alias{is_dynamic_tty}
\title{Detect whether a stream supports \verb{\\\\r} (Carriage return)}
\usage{
is_dynamic_tty(stream = "auto")
}
\arguments{
\item{stream}{The stream to inspect or manipulate, an R connection
object. It can also be a string, one of \code{"auto"}, \code{"message"},
\code{"stdout"}, \code{"stderr"}. \code{"auto"} will select \code{stdout()} if the session is
interactive and there are no sinks, otherwise it will select \code{stderr()}.}
}
\description{
In a terminal, \verb{\\\\r} moves the cursor to the first position of the
same line. It is also supported by most R IDEs. \verb{\\\\r} is typically
used to achieve a more dynamic, less cluttered user interface, e.g.
to create progress bars.
}
\details{
If the output is directed to a file, then \verb{\\\\r} characters are typically
unwanted. This function detects if \verb{\\\\r} can be used for the given
stream or not.
The detection mechanism is as follows:
\enumerate{
\item If the \code{cli.dynamic} option is set to \code{TRUE}, \code{TRUE} is returned.
\item If the \code{cli.dynamic} option is set to anything else, \code{FALSE} is
returned.
\item If the \code{R_CLI_DYNAMIC} environment variable is not empty and set to
the string \code{"true"}, \code{"TRUE"} or \code{"True"}, \code{TRUE} is returned.
\item If \code{R_CLI_DYNAMIC} is not empty and set to anything else, \code{FALSE} is
returned.
\item If the stream is a terminal, then \code{TRUE} is returned.
\item If the stream is the standard output or error within RStudio,
the macOS R app, or RKWard IDE, \code{TRUE} is returned.
\item Otherwise \code{FALSE} is returned.
}
}
\examples{
is_dynamic_tty()
is_dynamic_tty(stdout())
}
\seealso{
Other terminal capabilities:
\code{\link{ansi_hide_cursor}()},
\code{\link{is_ansi_tty}()}
}
\concept{terminal capabilities}
cli/man/ansi_nchar.Rd 0000644 0001762 0000144 00000002355 14143453131 014174 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_nchar}
\alias{ansi_nchar}
\title{Count number of characters in an ANSI colored string}
\usage{
ansi_nchar(x, type = c("chars", "bytes", "width", "graphemes", "codepoints"))
}
\arguments{
\item{x}{Character vector, potentially ANSI styled, or a vector to be
coerced to character. If it converted to UTF-8.}
\item{type}{Whether to count graphemes (characters), code points,
bytes, or calculate the display width of the string.}
}
\value{
Numeric vector, the length of the strings in the character
vector.
}
\description{
This is a color-aware counterpart of \code{\link[=utf8_nchar]{utf8_nchar()}}. By default it
counts Unicode grapheme clusters, instead of code points.
}
\examples{
str <- paste(
col_red("red"),
"default",
col_green("green")
)
cat(str, "\n")
nchar(str)
ansi_nchar(str)
nchar(ansi_strip(str))
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_toupper}()},
\code{\link{ansi_trimws}()}
}
\concept{ANSI string operations}
cli/DESCRIPTION 0000644 0001762 0000144 00000003516 14535536335 012550 0 ustar ligges users Package: cli
Title: Helpers for Developing Command Line Interfaces
Version: 3.6.2
Authors@R: c(
person("Gábor", "Csárdi", , "csardi.gabor@gmail.com", role = c("aut", "cre")),
person("Hadley", "Wickham", role = "ctb"),
person("Kirill", "Müller", role = "ctb"),
person("Salim", "Brüggemann", , "salim-b@pm.me", role = "ctb",
comment = c(ORCID = "0000-0002-5329-5987")),
person("Posit Software, PBC", role = c("cph", "fnd"))
)
Description: A suite of tools to build attractive command line interfaces
('CLIs'), from semantic elements: headings, lists, alerts, paragraphs,
etc. Supports custom themes via a 'CSS'-like language. It also
contains a number of lower level 'CLI' elements: rules, boxes, trees,
and 'Unicode' symbols with 'ASCII' alternatives. It support ANSI
colors and text styles as well.
License: MIT + file LICENSE
URL: https://cli.r-lib.org, https://github.com/r-lib/cli
BugReports: https://github.com/r-lib/cli/issues
Depends: R (>= 3.4)
Imports: utils
Suggests: callr, covr, crayon, digest, glue (>= 1.6.0), grDevices,
htmltools, htmlwidgets, knitr, methods, mockery, processx, ps
(>= 1.3.4.9000), rlang (>= 1.0.2.9003), rmarkdown, rprojroot,
rstudioapi, testthat, tibble, whoami, withr
Config/Needs/website: r-lib/asciicast, bench, brio, cpp11, decor, desc,
fansi, prettyunits, sessioninfo, tidyverse/tidytemplate,
usethis, vctrs
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.2.3
NeedsCompilation: yes
Packaged: 2023-12-10 22:38:10 UTC; gaborcsardi
Author: Gábor Csárdi [aut, cre],
Hadley Wickham [ctb],
Kirill Müller [ctb],
Salim Brüggemann [ctb] (),
Posit Software, PBC [cph, fnd]
Maintainer: Gábor Csárdi
Repository: CRAN
Date/Publication: 2023-12-11 07:40:13 UTC
cli/tests/ 0000755 0001762 0000144 00000000000 14143453131 012162 5 ustar ligges users cli/tests/testthat/ 0000755 0001762 0000144 00000000000 14535536335 014037 5 ustar ligges users cli/tests/testthat/test-progress-variables.R 0000644 0001762 0000144 00000020544 14143453131 020741 0 ustar ligges users
test_that("cli_progress_demo", {
withr::local_options(cli.ansi = TRUE)
out <- cli_progress_demo(live = FALSE, at = 50)
out$lines <- fix_times(out$lines)
expect_snapshot(out)
out <- cli_progress_demo(live = FALSE, at = NULL, total = 3)
out$lines <- fix_times(out$lines)
expect_snapshot(out)
out <- cli_progress_demo(live = FALSE, at = NULL, total = NA, delay = 0.001)
out$lines <- fix_times(out$lines)
expect_snapshot(out)
fun <- function() {
options(cli.progress_handlers_only = "cli")
cli_progress_demo(live = TRUE, at = NULL, total = 3)
}
msgs <- capture_cli_messages(out <- fun())
expect_snapshot(out)
expect_snapshot(msgs)
})
test_that("pb_bar", {
expect_equal(cli__pb_bar(NULL), "")
withr::local_options(cli__pb = list(current = 15, total = NA))
expect_snapshot(cli_text("-{cli::pb_bar}-"))
withr::local_options(cli__pb = list(current = 15, total = 30))
expect_snapshot(cli_text("-{cli::pb_bar}-"))
})
test_that("pb_current", {
expect_equal(cli__pb_current(NULL), "")
withr::local_options(cli__pb = list(current = 15))
expect_equal(cli::pb_current, 15)
})
test_that("pb_current_bytes", {
expect_equal(cli__pb_current_bytes(NULL), "")
expect_snapshot({
cli__pb_current_bytes(list(current = 0))
cli__pb_current_bytes(list(current = 1))
cli__pb_current_bytes(list(current = 1000))
cli__pb_current_bytes(list(current = 1000 * 23))
cli__pb_current_bytes(list(current = 1000 * 1000 * 23))
})
})
test_that("pb_elapsed", {
expect_equal(cli__pb_elapsed(NULL), "")
withr::local_options(cli__pb = list(start = 0, speed_time = 1))
mockery::stub(cli__pb_elapsed, ".Call", 1)
expect_snapshot(cli__pb_elapsed())
mockery::stub(cli__pb_elapsed, ".Call", 21)
expect_snapshot(cli__pb_elapsed())
mockery::stub(cli__pb_elapsed, ".Call", 58)
expect_snapshot(cli__pb_elapsed())
mockery::stub(cli__pb_elapsed, ".Call", 60 * 65)
expect_snapshot(cli__pb_elapsed())
})
test_that("pb_elapsed_clock", {
expect_equal(cli__pb_elapsed_clock(NULL), "")
withr::local_options(cli__pb = list(start = 0, speed_time = 1))
mockery::stub(cli__pb_elapsed_clock, ".Call", 1)
expect_snapshot(cli__pb_elapsed_clock())
mockery::stub(cli__pb_elapsed_clock, ".Call", 21)
expect_snapshot(cli__pb_elapsed_clock())
mockery::stub(cli__pb_elapsed_clock, ".Call", 58)
expect_snapshot(cli__pb_elapsed_clock())
mockery::stub(cli__pb_elapsed_clock, ".Call", 60 * 65)
expect_snapshot(cli__pb_elapsed_clock())
})
test_that("pb_elapsed_raw", {
expect_equal(cli__pb_elapsed_raw(NULL), "")
withr::local_options(cli__pb = list(start = 0, speed_time = 1))
mockery::stub(cli__pb_elapsed_raw, ".Call", 1)
expect_snapshot(cli__pb_elapsed_raw())
mockery::stub(cli__pb_elapsed_raw, ".Call", 21)
expect_snapshot(cli__pb_elapsed_raw())
mockery::stub(cli__pb_elapsed_raw, ".Call", 58)
expect_snapshot(cli__pb_elapsed_raw())
mockery::stub(cli__pb_elapsed_raw, ".Call", 60 * 65)
expect_snapshot(cli__pb_elapsed_raw())
})
test_that("pb_eta", {
expect_equal(cli__pb_eta(NULL), "")
mockery::stub(cli__pb_eta, "cli__pb_eta_raw", NA_real_)
expect_snapshot(cli__pb_eta(list()))
mockery::stub(cli__pb_eta, "cli__pb_eta_raw", as.difftime(12, units = "secs"))
expect_snapshot(cli__pb_eta(list()))
})
test_that("pb_eta_raw", {
expect_equal(cli__pb_eta_raw(NULL), "")
withr::local_options(cli__pb = list(total = NA))
expect_identical(cli__pb_eta_raw(), NA_real_)
mockery::stub(cli__pb_eta_raw, ".Call", 0)
withr::local_options(cli__pb = list(start = -10, total = 100, current = 0))
expect_snapshot(cli__pb_eta_raw())
withr::local_options(cli__pb = list(start = -10, total = 100, current = 20))
expect_snapshot(cli__pb_eta_raw())
withr::local_options(cli__pb = list(start = -40, total = 100, current = 80))
expect_snapshot(cli__pb_eta_raw())
withr::local_options(cli__pb = list(start = -50, total = 100, current = 100))
expect_snapshot(cli__pb_eta_raw())
})
test_that("pb_eta_str", {
expect_equal(cli__pb_eta_str(NULL), "")
withr::local_options(cli__pb = list(total = NA))
expect_identical(cli__pb_eta_str(), "")
mockery::stub(cli__pb_eta_str, "cli__pb_eta", "?")
expect_snapshot(cli__pb_eta_str(list()))
mockery::stub(cli__pb_eta_str, "cli__pb_eta", " 1s")
expect_snapshot(cli__pb_eta_str(list()))
})
test_that("pb_extra", {
expect_equal(cli__pb_extra(NULL), "")
expect_equal(cli__pb_extra(list(extra = list(a = 1))), list(a = 1))
})
test_that("pb_id", {
expect_equal(cli__pb_id(NULL), "")
expect_equal(cli__pb_id(list(id = 123)), 123)
})
test_that("pb_name", {
expect_equal(cli__pb_name(NULL), "")
expect_equal(cli__pb_name(list(name = NULL)), "")
expect_equal(cli__pb_name(list(name = "foo")), "foo ")
})
test_that("pb_percent", {
expect_equal(cli__pb_percent(NULL), "")
expect_snapshot({
cli__pb_percent(list(current = 0, total = 99))
cli__pb_percent(list(current = 5, total = 99))
cli__pb_percent(list(current = 10, total = 99))
cli__pb_percent(list(current = 25, total = 99))
cli__pb_percent(list(current = 99, total = 99))
cli__pb_percent(list(current = 100, total = 99))
})
})
test_that("pb_pid", {
expect_equal(cli__pb_pid(NULL), "")
expect_equal(cli__pb_pid(list()), Sys.getpid())
expect_equal(cli__pb_pid(list(pid = 100)), 100)
})
test_that("pb_rate", {
expect_equal(cli__pb_rate(NULL), "")
mockery::stub(cli__pb_rate, "cli__pb_rate_raw", NaN)
expect_snapshot(cli__pb_rate(list()))
mockery::stub(cli__pb_rate, "cli__pb_rate_raw", Inf)
expect_snapshot(cli__pb_rate(list()))
mockery::stub(cli__pb_rate, "cli__pb_rate_raw", 1/10)
expect_snapshot(cli__pb_rate(list()))
mockery::stub(cli__pb_rate, "cli__pb_rate_raw", 12.4)
expect_snapshot(cli__pb_rate(list()))
})
test_that("pb_rate_raw", {
expect_equal(cli__pb_rate_raw(NULL), "")
mockery::stub(cli__pb_rate_raw, "cli__pb_elapsed_raw", function(...) this)
this <- 0
expect_equal(cli__pb_rate_raw(list(current = 0)), NaN)
expect_equal(cli__pb_rate_raw(list(current = 23)), Inf)
this <- 1
expect_equal(cli__pb_rate_raw(list(current = 23)), 23)
this <- 10
expect_equal(cli__pb_rate_raw(list(current = 1)), 1/10)
})
test_that("pb_rate_bytes", {
expect_equal(cli__pb_rate_bytes(NULL), "")
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", NaN)
expect_snapshot(cli__pb_rate_bytes(list()))
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", Inf)
expect_snapshot(cli__pb_rate_bytes(list()))
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", 0)
expect_snapshot(cli__pb_rate_bytes(list()))
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", 1024)
expect_snapshot(cli__pb_rate_bytes(list()))
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", 1024 * 23)
expect_snapshot(cli__pb_rate_bytes(list()))
mockery::stub(cli__pb_rate_bytes, "cli__pb_rate_raw", 1024 * 1024 * 23)
expect_snapshot(cli__pb_rate_bytes(list()))
})
test_that("pb_spin", {
expect_equal(cli__pb_spin(NULL), "")
withr::local_options(cli.spinner = "line")
withr::local_options(cli__pb = list(tick = 1))
expect_snapshot(cli_text("-{cli::pb_spin}-{cli::pb_spin}-"))
withr::local_options(cli__pb = list(tick = 2))
expect_snapshot(cli_text("-{cli::pb_spin}-{cli::pb_spin}-"))
withr::local_options(cli__pb = list(tick = 10))
expect_snapshot(cli_text("-{cli::pb_spin}-{cli::pb_spin}-"))
})
test_that("pb_status", {
expect_equal(cli__pb_status(NULL), "")
expect_equal(cli__pb_status(NULL), "")
expect_equal(cli__pb_status(list(status = NULL)), "")
expect_equal(cli__pb_status(list(status = "foo")), "foo ")
})
test_that("pb_timestamp", {
expect_equal(cli__pb_timestamp(NULL), "")
fake <- .POSIXct(1623974954, tz = "GMT")
mockery::stub(cli__pb_timestamp, "Sys.time", fake)
expect_snapshot(cli__pb_timestamp(list()))
backup <- mget(c("load_time", "speed_time"), clienv)
on.exit({
clienv$load_time <- backup$load_time
clienv$speed_time <- backup$speed_time
}, add = TRUE)
clienv$load_time <- fake - 10
clienv$speed_time <- 3.0
expect_snapshot(cli__pb_timestamp(list()))
})
test_that("pb_total", {
expect_equal(cli__pb_total(NULL), "")
expect_equal(cli__pb_total(list(total = 101)), 101)
})
test_that("pb_total_bytes", {
expect_equal(cli__pb_total_bytes(NULL), "")
expect_snapshot({
cli__pb_total_bytes(list(total = 0))
cli__pb_total_bytes(list(total = 1))
cli__pb_total_bytes(list(total = 1000))
cli__pb_total_bytes(list(total = 1000 * 23))
cli__pb_total_bytes(list(total = 1000 * 1000 * 23))
})
})
cli/tests/testthat/test-progress-handler-logger.R 0000644 0001762 0000144 00000000365 14143453131 021662 0 ustar ligges users
test_that("loggerr_out", {
bar <- new.env(parent = emptyenv())
bar$id <- "id"
bar$current <- 13
bar$total <- 113
mockery::stub(logger_out, "Sys.time", .POSIXct(1623325865, tz = "CET"))
expect_snapshot(logger_out(bar, "updated"))
})
cli/tests/testthat/test-containers.R 0000644 0001762 0000144 00000004611 14200445676 017302 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("auto closing", {
expect_snapshot(local({
cli_div(theme = list(".xx .emph" = list(before = "itsu:")))
f <- function() {
cli_par(class = "xx")
cli_text("foo {.emph blah} bar")
}
# this has the marker
f()
# but this does not, because the .xx par was closed
cli_text("foo {.emph blah} bar")
}))
})
test_that("opt out of auto closing", {
expect_snapshot(local({
cli_div(theme = list(".xx .emph" = list(before = "itsu:")))
id <- NULL
f <- function() {
id <<- cli_par(class = "xx", .auto_close = FALSE)
cli_text("foo {.emph blah} bar")
}
f()
# Still active
cli_text("foo {.emph blah} bar")
## close explicitly
expect_false(is.null(id))
cli_end(id)
cli_text("foo {.emph blah} bar")
}))
})
test_that("auto closing with special env", {
expect_snapshot(local({
cli_div(theme = list(".xx .emph" = list(before = "itsu:")))
f <- function() {
g()
# Still active
cli_text("foo {.emph blah} bar")
}
g <- function() {
cli_par(class = "xx", .auto_close = TRUE, .envir = parent.frame())
cli_text("foo {.emph blah} bar")
}
f()
# Not active any more
cli_text("foo {.emph blah} bar")
}))
})
test_that("div with special style", {
expect_snapshot({
f <- function() {
cli_div(theme = list(".xx .emph" = list(before = "itsu:")))
cli_par(class = "xx")
cli_text("foo {.emph blah} bar")
}
f()
# Not active any more
cli_text("foo {.emph blah} bar")
})
})
test_that("margin is squashed", {
skip_if_not_installed("testthat", "3.1.2")
# expect_snapshot cuts off the trailing newline from the message it
# seems, so instead of 4 empty lines, there will be only three
expect_snapshot(local({
cli_div(theme = list(par = list("margin-top" = 4, "margin-bottom" = 4)))
cli_text("three lines")
cli_par()
cli_par()
cli_par()
cli_text("until here")
cli_end()
cli_end()
cli_end()
cli_par()
cli_par()
cli_par()
cli_text("no space, still")
cli_end()
cli_end()
cli_end()
cli_text("three lines again")
}))
})
test_that("before and after work properly", {
expect_snapshot(local({
cli_div(
theme = list(
"div.alert-success" = list(before ="!!!")
))
cli_alert_success("{.pkg foobar} is good")
}))
})
cli/tests/testthat/test-assertions.R 0000644 0001762 0000144 00000005422 14143453131 017317 0 ustar ligges users
test_that("is_string", {
strings <- list("foo", "", "111", "1", "-", "NA")
not_strings <- list(1, character(), NA_character_, NA,
c("foo", NA), c("1", "2"), NULL)
for (p in strings) {
expect_true(is_string(p))
expect_silent(stopifnot(is_string(p)))
}
for (n in not_strings) {
expect_false(is_string(n))
expect_error(
stopifnot(is_string(n)),
"is_string(n) is not TRUE",
fixed = TRUE
)
}
})
test_that("is_border_style", {
expect_true(is_border_style(rownames(box_styles())[1]))
expect_false(is_border_style("blahblahxxx"))
expect_silent(stopifnot(is_border_style(rownames(box_styles())[1])))
expect_error(
stopifnot(is_border_style("blahblahxxx")),
"is_border_style(\"blahblahxxx\") is not TRUE",
fixed = TRUE
)
})
test_that("is_padding_or_margin", {
good <- list(1, 0, 0L, 1L, 237, c(1,2,3,4), c(0,0,0,0), rep(1L, 4))
bad <- list(numeric(), integer(), c(1,2), c(1L, 2L, 3L), 1:5,
"1", c("1", "2", "3", "1"), NA, NA_real_, NA_integer_,
c(1,2,NA,1), c(1L,NA,3L))
for (g in good) {
expect_true(is_padding_or_margin(g))
expect_silent(stopifnot(is_padding_or_margin(g)))
}
for (b in bad) {
expect_false(is_padding_or_margin(b))
expect_error(
stopifnot(is_padding_or_margin(b)),
"is_padding_or_margin(b) is not TRUE",
fixed = TRUE
)
}
})
test_that("is_col", {
good <- list("red", "orange", NULL, col_red)
bad <- list(c("red", "orange"), character(), NA_character_)
for (g in good) {
expect_true(is_col(g))
expect_silent(stopifnot(is_col(g)))
}
for (b in bad) {
expect_false(is_col(b))
expect_error(
stopifnot(is_col(b)),
"is_col(b) is not TRUE",
fixed = TRUE
)
}
})
test_that("is_count", {
counts <- list(1, 1L, 0, 0L, 42, 42L)
not_counts <- list(c(1, 2), numeric(), NA_integer_, NA_real_, NA, 1.1,
NULL, "1")
for (c in counts) {
expect_true(is_count(c))
expect_silent(stopifnot(is_count(c)))
}
for (n in not_counts) {
expect_false(is_count(n))
expect_error(
stopifnot(is_count(n)),
"is_count(n) is not TRUE",
fixed = TRUE
)
}
})
test_that("is_tree_style", {
good <- list(
list(h = "1", v = "2", l = "3", j = "4"),
list(j = "4", v = "2", h = "1", l = "3")
)
bad <- list(
NULL,
1:4,
c(h = "1", v = "2", l = "3", j = "4"),
list(h = "1", v = "2", l = "3", j = "4", x = "10"),
list(h = "1", v = c("2", "3"), l = "3", j = "4"),
list(h = "1", v = "2", l = character(), j = "4"),
list(h = "1", v = "2", l = 3, j = "4"),
list("1", v = "2", l = "3", j = "4"),
list("1", "2", "3", "4")
)
for (x in good) expect_true (is_tree_style(x))
for (x in bad ) expect_false(is_tree_style(x))
})
cli/tests/testthat/test-app.R 0000644 0001762 0000144 00000000355 14317007616 015713 0 ustar ligges users
test_that("stop_app() errors", {
expect_snapshot(
error = TRUE,
stop_app(1:10)
)
})
test_that("warning if inactive app", {
app <- start_app(.auto_close = FALSE)
stop_app(app)
expect_snapshot(
stop_app(app)
)
})
cli/tests/testthat/test-console-width.R 0000644 0001762 0000144 00000000465 14313063767 017721 0 ustar ligges users
test_that("errors", {
withr::local_options(cli.width = letters)
expect_snapshot_error(
console_width()
)
withr::local_options(cli.width = NA_integer_)
expect_snapshot_error(
console_width()
)
withr::local_options(cli.width = -100L)
expect_snapshot_error(
console_width()
)
})
cli/tests/testthat/test-deep-lists.R 0000644 0001762 0000144 00000002015 14143453131 017171 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("deep lists ul", {
test_ul = function(n = 2) {
for(i in seq_len(n)) {
cli::cli_ul()
cli::cli_li(paste0("Level ",i))
}
}
expect_snapshot(
for (i in 1:4) test_ul(i)
)
})
test_that("deep lists ol", {
test_ol = function(n = 2) {
for(i in seq_len(n)) {
cli::cli_ol()
cli::cli_li(paste0("Level ",i))
}
}
expect_snapshot(
for (i in 1:4) test_ol(i)
)
})
test_that("deep lists ol ul", {
test_ol_ul = function(n = 2) {
for(i in seq_len(n)) {
cli::cli_ol()
cli::cli_li(paste0("Level ",2*i-1))
cli::cli_ul()
cli::cli_li(paste0("Level ",2*i))
}
}
expect_snapshot(
for (i in 1:4) test_ol_ul(i)
)
})
test_that("deep lists ul ol", {
test_ul_ol = function(n = 2) {
for(i in seq_len(n)) {
cli::cli_ul()
cli::cli_li(paste0("Level ",2*i-1))
cli::cli_ol()
cli::cli_li(paste0("Level ",2*i))
}
}
expect_snapshot(
for (i in 1:4) test_ul_ol(i)
)
})
cli/tests/testthat/test-prettycode.R 0000644 0001762 0000144 00000014025 14301763660 017315 0 ustar ligges users
col_seq <- list(function(x)
paste0("1", x),
function(x)
paste0("2", x),
function(x)
paste0("3", x))
test_that("bracket highlighting", {
# [](){}
expect_equal(color_brackets(c("[", "]", "(", ")", "{", "}"), col_seq),
c("1[", "1]", "1(", "1)", "1{", "1}"))
# [({[({})]})]
expect_equal(
color_brackets(c(
"[", "(", "{", "[", "(", "{", "}", ")", "]", "}", ")", "]"
),
col_seq),
c(
"1[",
"2(",
"3{",
"1[",
"2(",
"3{",
"3}",
"2)",
"1]",
"3}",
"2)",
"1]"
)
)
# [[ [] ]][[ ()() ]]
expect_equal(
color_brackets(
c("[[", "[", "]", "]", "]", "[[", "(", ")", "(", ")", "]", "]"),
col_seq
),
c(
"1[[",
"2[",
"2]",
"1]",
"1]",
"1[[",
"2(",
"2)",
"2(",
"2)",
"1]",
"1]"
)
)
})
test_that_cli(configs = c("plain", "ansi"), "reserved", {
expect_snapshot({
cat(code_highlight("function () { }", list(reserved = "bold")))
cat(code_highlight("if (1) NULL else NULL", list(reserved = "bold")))
cat(code_highlight("repeat {}", list(reserved = "bold")))
cat(code_highlight("while (1) {}", list(reserved = "bold")))
cat(code_highlight("for (i in x) next", list(reserved = "bold")))
cat(code_highlight("for (i in x) break", list(reserved = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "number", {
expect_snapshot({
cat(code_highlight("1 + 1.0 + -1 + 2L + Inf", list(number = "bold")))
cat(code_highlight(
"NA + NA_real_ + NA_integer_ + NA_character_",
list(number = "bold")
))
cat(code_highlight("TRUE + FALSE", list(number = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "null", {
expect_snapshot({
cat(code_highlight("NULL", list(null = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "operator", {
expect_snapshot({
cat(code_highlight("~ ! 1 - 2 + 3:4 * 5 / 6 ^ 7", list(operator = "bold")))
cat(code_highlight(
"? 1 %% 2 %+% 2 < 3 & 4 > 5 && 6 == 7 | 8 <= 9 || 10 >= 11",
list(operator = "bold")
))
cat(code_highlight(
"a <- 10; 20 -> b; c = 30; a$b; a@b",
list(operator = "bold")
))
})
})
test_that_cli(configs = c("plain", "ansi"), "call", {
expect_snapshot({
cat(code_highlight("ls(2)", list(call = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "string", {
expect_snapshot({
cat(code_highlight("'s' + \"s\"", list(string = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "comment", {
expect_snapshot({
cat(code_highlight(c("# COM", " ls() ## ANOT"), list(comment = "bold")))
})
})
test_that_cli(configs = c("plain", "ansi"), "bracket", {
expect_snapshot({
cat(code_highlight("foo <- function(x){x}", list(bracket = list("bold"))))
})
})
test_that("replace_in_place", {
expect_equal(
replace_in_place("1234567890", c(2, 6), c(5, 8), c("foobar", "xxx")),
"1foobarxxx90"
)
expect_equal(
replace_in_place("1234567890", c(1, 5), c(6, 10), c("A", "B")),
"AB"
)
})
test_that("replace_in_place corner cases", {
expect_equal(
replace_in_place("foobar", integer(), integer(), character()),
"foobar"
)
expect_equal(
replace_in_place("12345", 1L, 5L, "no!"),
"no!"
)
expect_equal(
replace_in_place("12345", 1:5, 1:5, letters[1:5]),
"abcde"
)
})
test_that_cli(configs = c("plain", "ansi"), "parse errors", {
expect_equal(
code_highlight("not good!!!"), "not good!!!"
)
cnd <- NULL
withCallingHandlers(
expect_equal(
code_highlight("not good!!!"), "not good!!!"
),
cli_parse_failure = function(e) cnd <<- e
)
expect_s3_class(cnd, "cli_parse_failure")
expect_s3_class(cnd, "condition")
expect_equal(cnd$code, "not good!!!")
})
test_that("code themes", {
withr::local_options(cli.code_theme = "solarized_dark")
expect_equal(code_theme_default()$reserved, "#859900")
withr::local_options(cli.code_theme = NULL)
withr::local_envvar(RSTUDIO = "0")
withr::local_options(cli.code_theme_terminal = "solarized_light")
expect_equal(code_theme_default()$reserved, "#859900")
mockery::stub(
code_theme_default,
"rstudio_detect",
list(type = "rstudio_console")
)
withr::local_options(cli.code_theme_rstudio = "Xcode")
expect_equal(code_theme_default()$reserved, "#C800A4")
withr::local_options(cli.code_theme_rstudio = NULL)
mockery::stub(code_theme_default, "code_theme_default_rstudio", "foo")
expect_equal(code_theme_default(), "foo")
})
test_that("code themes 2", {
withr::local_options(cli.code_theme = "nope!!")
expect_warning(code_theme_default(), "Unknown cli code theme")
withr::local_options(cli.code_theme = 111)
expect_warning(code_theme_default(), "Invalid cli code theme")
})
test_that("code_theme_default_rstudio", {
mockery::stub(
code_theme_default_rstudio,
"get_rstudio_theme",
list(editor = "Solarized Dark")
)
expect_equal(code_theme_default_rstudio()$reserved, "#859900")
mockery::stub(
code_theme_default_rstudio,
"get_rstudio_theme",
list(editor = "Not really")
)
expect_warning(
cth <- code_theme_default_rstudio(),
"cli does not know this RStudio theme"
)
expect_equal(cth, code_theme_default_term())
})
test_that("code_theme_list", {
expect_snapshot(code_theme_list())
})
test_that_cli(configs = "ansi", "new language features, raw strings", {
if (getRversion() < "4.0.1") { expect_true(TRUE); return() }
expect_snapshot(
cat(code_highlight(
'"old" + r"("new""")"',
list(string = "bold", reserved = "italic")
))
)
})
test_that_cli(configs = "ansi", "new language features, pipe", {
if (getRversion() < "4.1.0") { expect_true(TRUE); return() }
expect_snapshot(
cat(code_highlight('dir() |> toupper()', list(operator = "bold")))
)
})
test_that_cli(configs = "ansi", "new language features, lambda functions", {
if (getRversion() < "4.1.0") { expect_true(TRUE); return() }
expect_snapshot(
cat(code_highlight('\\(x) x * 2', list(reserved = "bold")))
)
})
cli/tests/testthat/test-utf8.R 0000644 0001762 0000144 00000004662 14313063767 016033 0 ustar ligges users
# We need an UTF-8 platform or a recent R version on Windows
utf8 <- l10n_info()$`UTF-8`
newwin <- .Platform$OS.type == "windows" && getRversion() >= "4.0.0"
if (!utf8 && !newwin) return()
test_that("UTF-8 output on Windows", {
skip_on_cran()
skip_on_covr()
out <- r_utf8(function() {
library(cli)
options(cli.unicode = TRUE)
options(cli.num_colors = 1)
options(cli.width = 70)
options(cli.dynamic = FALSE)
Sys.setenv(RSTUDIO = NA)
s1 <- "\u30DE\u30EB\u30C1\u30D0\u30A4\u30C8\u306E\u30BF\u30A4\u30C8\u30EB"
s2 <- "\u00e1rv\u00edzt\u0171r\u0151 t\u00fck\u00f6rf\u00far\u00f3g\u00e9p"
cli_h1("Alerts")
cli_alert(s1)
cli_alert_danger(s2)
cli_alert_info(s1)
cli_alert_success(s1)
cli_alert_warning(s1)
cli_h1("Block quote")
cli_blockquote(s1, s2)
cli_h1("Bullets")
cli_bullets(c("*" = s1, "!" = s2))
cli_h1("Code")
cli_code(c(s1, s2))
cli_h1("Lists")
cli_dl(c(s1 = s1, s2 = s2))
cli_ol(c(s1, s2))
cli_ul(c(s1, s2))
cli_h1("Headers")
cli_h1(s1)
cli_h2(s2)
cli_h3(s1)
cli_h1("Progress bars")
cli_progress_step(s1)
cli_progress_step(s2)
cli_progress_done()
cli_h1("Text")
idx <- c(1L, 2L, 1L, 2L, 1L, 1L, 1L, 1L, 2L, 1L, 2L, 1L, 1L, 1L, 1L)
cli_text(paste(c(s1, s2)[idx], collapse = " "))
cli_h1("Verbatim")
cli_verbatim(c(s1, s2))
})
out$stdout <- gsub("\\[[.0-9]+m?s\\]", "[1s]", out$stdout)
tmp <- tempfile(fileext = ".txt")
writeBin(charToRaw(out$stdout), tmp)
expect_snapshot_file(tmp, name = "utf8-output.txt")
})
test_that("utf8_graphemes", {
expect_equal(utf8_graphemes(character()), list())
expect_equal(utf8_graphemes(""), list(character()))
str <- c(
NA,
"",
"alpha",
"\U0001f477\U0001f3ff\u200d\u2640\ufe0f",
"\U0001f477\U0001f3ff",
"\U0001f477\u200d\u2640\ufe0f",
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3ff"
)
exp <- list(
NA_character_,
character(),
c("a", "l", "p", "h", "a"),
"\U0001f477\U0001f3ff\u200d\u2640\ufe0f",
"\U0001f477\U0001f3ff",
"\U0001f477\u200d\u2640\ufe0f",
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3ff"
)
expect_equal(utf8_graphemes(str), exp)
str2 <- paste0(na.omit(str), collapse = "")
exp2 <- list(na.omit(unlist(exp)))
expect_equal(utf8_graphemes(str2), exp2)
})
test_that("errors", {
expect_snapshot_error(
fix_r_utf8_output("\x02\xff\xfe \x03\xff\xfe \x03\xff\xfe")
)
})
cli/tests/testthat/test-subprocess.R 0000644 0001762 0000144 00000007741 14277512450 017333 0 ustar ligges users
test_that("events are properly generated", {
## This needs callr >= 3.0.0.90001, which is not yet on CRAN
if (packageVersion("callr") < "3.0.0.9001") skip("Need newer callr")
do <- function() {
options(cli.message_class = "callr_message")
cli::cli_div()
cli::cli_h1("title")
cli::cli_text("text")
}
rs <- callr::r_session$new()
on.exit(rs$kill(), add = TRUE)
msgs <- list()
handler <- function(msg) {
msgs <<- c(msgs, list(msg))
if (!is.null(findRestart("cli_message_handled"))) {
invokeRestart("cli_message_handled")
}
if (!is.null(findRestart("callr_r_session_muffle"))) {
invokeRestart("callr_r_session_muffle")
}
}
withCallingHandlers(
rs$run(do),
cli_message = handler)
expect_equal(length(msgs), 4)
lapply(msgs, expect_s3_class, "cli_message")
expect_equal(msgs[[1]]$type, "div")
expect_equal(msgs[[2]]$type, "h1")
expect_equal(msgs[[3]]$type, "text")
expect_equal(msgs[[4]]$type, "end")
rs$close()
})
test_that("subprocess with default handler", {
## This needs callr >= 3.0.0.90001, which is not yet on CRAN
if (packageVersion("callr") < "3.0.0.9001") skip("Need newer callr")
do <- function() {
options(cli.message_class = "callr_message")
cli::cli_div()
cli::cli_h1("title")
cli::cli_text("text")
}
rs <- callr::r_session$new()
on.exit(rs$kill(), add = TRUE)
msgs <- list()
withr::with_options(list(
cli.default_handler = function(msg) {
msgs <<- c(msgs, list(msg))
if (!is.null(findRestart("cli_message_handled"))) {
invokeRestart("cli_message_handled")
}
}),
rs$run(do)
)
expect_equal(length(msgs), 4)
lapply(msgs, expect_s3_class, "cli_message")
expect_equal(msgs[[1]]$type, "div")
expect_equal(msgs[[2]]$type, "h1")
expect_equal(msgs[[3]]$type, "text")
expect_equal(msgs[[4]]$type, "end")
rs$close()
})
test_that("output in child process", {
## This needs callr >= 3.0.0.90001, which is not yet on CRAN
if (packageVersion("callr") < "3.0.0.9001") skip("Need newer callr")
# We need to do our own condition handling, otherwise callr will
# handle `cli_message` and copy it to the main process.
# So on `cli_message` we just call the default handler, which will
# call `message()`, and on `message` we'll copy the formatted message
# to the main process.
do <- function() {
options(cli.num_colors = 256)
withCallingHandlers({
cli::start_app(theme = cli::simple_theme())
cli::cli_h1("Title")
cli::cli_text("This is generated in the {.emph subprocess}.")
"foobar"
},
cli_message = function(msg) {
withCallingHandlers({
cli:::cli_server_default(msg)
invokeRestart("cli_message_handled") },
message = function(mmsg) {
class(mmsg) <- c("callr_message", "message", "condition")
signalCondition(mmsg)
})
}
)
}
rs <- callr::r_session$new()
on.exit(rs$kill(), add = TRUE)
# Store the formatted messages from callr
# We also need to muffle the default handler here
msgs <- list()
result <- withCallingHandlers(
rs$run_with_output(do),
callr_message = function(msg) {
msgs <<- c(msgs, list(msg))
if (!is.null(msg$muffle) && !is.null(findRestart(msg$muffle))) {
invokeRestart(msg$muffle)
}
}
)
expect_equal(result$stdout, "")
expect_equal(result$stderr, "")
expect_identical(result$result, "foobar")
expect_null(result$error)
str <- paste(vcapply(msgs, "[[", "message"), collapse = "")
expect_true(ansi_has_any(str))
expect_match(str, "Title")
expect_match(str, "This is generated")
rs$close()
})
test_that("substitution in child process", {
do <- function() {
options(cli.message_class = "callr_message")
cli::cli_text("This is process {Sys.getpid()}.")
}
rs <- callr::r_session$new()
on.exit(rs$kill(), add = TRUE)
out <- capt0(rs$run(do))
expect_match(out, glue::glue("This is process {rs$get_pid()}"))
rs$close()
})
cli/tests/testthat/test-cat.R 0000644 0001762 0000144 00000000244 14143453131 015671 0 ustar ligges users
test_that("cat_line appends to file", {
tmp <- tempfile()
cat_line("a", file = tmp)
cat_line("b", file = tmp)
expect_equal(readLines(tmp), c("a", "b"))
})
cli/tests/testthat/test-progress-along.R 0000644 0001762 0000144 00000007306 14313063767 020105 0 ustar ligges users
test_that("cli_progress_along crud", {
fun <- function() {
sapply(cli_progress_along(letters), function(i) i)
}
capture_cli_messages(ret <- fun())
expect_identical(ret, seq_along(letters))
})
test_that("progress bar terminated at mapping function exit", {
fun <- function() {
snap <- as.character(names(clienv$progress))
sapply(cli_progress_along(letters), function(i) i)
expect_identical(as.character(names(clienv$progress)), snap)
}
capture_cli_messages(fun())
})
test_that("interpolation uses the right env", {
if (getRversion() < "3.5.0") skip("Needs ALTREP")
fun <- function() {
withr::local_options(
cli.ansi = TRUE,
cli.dynamic = TRUE,
cli.progress_show_after = 0,
cli.progress_handlers_only = "cli"
)
x <- 10
sapply(cli_progress_along(1:5, format = "x: {x}"), function(i) i)
}
out <- capture_cli_messages(cli_with_ticks(fun()))
expect_snapshot(out)
})
test_that("cli_progress_along", {
if (getRversion() < "3.5.0") skip("Needs ALTREP")
withr::local_envvar(CLI_NO_THREAD = "1")
fun <- function() {
withr::local_options(
cli.ansi = TRUE,
cli.dynamic = TRUE,
cli.progress_show_after = 0,
cli.progress_handlers_only = "logger"
)
vapply(cli::cli_progress_along(1:10), function(i) i, integer(1))
}
lines <- fix_logger_output(capture.output(cli_with_ticks(fun())))
expect_snapshot(lines)
})
test_that("cli_progress_along error", {
if (getRversion() < "3.5.0") skip("Needs ALTREP")
withr::local_envvar(CLI_NO_THREAD = "1")
fun <- function() {
withr::local_options(
cli.ansi = TRUE,
cli.dynamic = TRUE,
cli.progress_show_after = 0,
cli.progress_handlers_only = "logger"
)
suppressWarnings(testthat::local_reproducible_output())
lapply(
cli::cli_progress_along(1:10, clear = FALSE),
function(i) { if (i == 5) stop("oops") }
)
}
outfile <- tempfile()
expect_error(callr::r(fun, stdout = outfile, stderr = outfile))
lines <- fix_logger_output(readLines(outfile))
expect_snapshot(lines)
})
test_that("old R is just seq_along", {
# It is tricky to check that we get seq_along(), because
# identical(cli_progress_along(1:10), seq_along(1:10)) holds,
# so we just check that no progress bar is created.
mockery::stub(cli_progress_along, "getRversion", package_version("3.4.0"))
snapshot <- names(clienv$progress)
it <- cli_progress_along(1:10)
expect_identical(snapshot, names(clienv$progress))
expect_identical(it, seq_along(1:10))
})
test_that("error in handler is a single warning", {
if (getRversion() < "3.5.0") skip("Needs ALTREP")
fun <- function() {
withr::local_options(
cli.ansi = TRUE,
cli.dynamic = TRUE,
cli.progress_show_after = 0,
cli.progress_handlers_only = "cli"
)
x <- 10
sapply(cli_progress_along(1:5, format = "{1+''}"), function(i) i)
}
expect_snapshot(
cli_with_ticks(fun()),
transform = sanitize_srcref
)
})
test_that("length 1 seq", {
fun <- function() {
sapply(cli_progress_along(1L), function(i) i)
}
capture_cli_messages(ret <- cli_with_ticks(fun()))
expect_identical(ret, 1L)
})
test_that("ALTREP methods", {
if (getRversion() < "3.5.0") skip("Needs ALTREP")
seq <- cli_progress_along(1:10)
expect_output(.Internal(inspect(seq)), "progress_along")
expect_equal(is.unsorted(seq), FALSE)
expect_equal(sum(seq), sum(1:10))
seq <- cli_progress_along(letters)
expect_equal(min(seq), 1L)
expect_equal(max(seq), length(letters))
z <- cli_progress_along(character())
expect_equal(min(z), Inf)
seq <- cli_progress_along(letters)
expect_equal(.Call(clic_dataptr, seq), seq_along(letters) * 2)
seq2 <- seq
expect_silent(seq2[1] <- 100)
})
cli/tests/testthat/test-inline-2.R 0000644 0001762 0000144 00000012272 14500302326 016537 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli(
config = c("plain", "ansi"),
"quoting phrases that don't start or end with letter or number", {
expect_snapshot(local({
x0 <- "good-name"
cli_text("The name is {.file {x0}}.")
x <- "weird-name "
cli_text("The name is {.file {x}}.")
cli_text("The name is {.path {x}}.")
cli_text("The name is {.email {x}}.")
}))
}
)
test_that_cli(config = c("plain", "ansi"), "quoting weird names, still", {
nb <- function(x) gsub("\u00a0", " ", x, fixed = TRUE)
expect_snapshot(local({
cat_line(nb(quote_weird_name("good")))
cat_line(nb(quote_weird_name(" bad")))
cat_line(nb(quote_weird_name("bad ")))
cat_line(nb(quote_weird_name(" bad ")))
}))
})
test_that_cli(config = c("ansi"), "~/ files are not weird", {
nb <- function(x) gsub("\u00a0", " ", x, fixed = TRUE)
expect_snapshot(local({
cat_line(nb(quote_weird_name("~/good")))
cat_line(nb(quote_weird_name("~~bad")))
cat_line(nb(quote_weird_name("bad~ ")))
cat_line(nb(quote_weird_name(" ~ bad ~ ")))
}))
})
test_that_cli("custom truncation", {
expect_snapshot({
x <- cli_vec(1:100, list("vec-trunc" = 5))
cli_text("Some numbers: {x}.")
cli_text("Some numbers: {.val {x}}.")
})
})
test_that_cli(configs = c("plain", "ansi"), "collapsing class names", {
expect_snapshot(local({
cc <- c("one", "two")
cli_text("this is a class: {.cls myclass}")
cli_text("multiple classes: {.cls {cc}}")
}))
})
test_that_cli(configs = c("plain", "ansi"), "transform", {
expect_snapshot(local({
cli_text("This is a {.field field} (before)")
foo <- function(x) toupper(x)
cli_div(theme = list(span.field = list(transform = foo)))
cli_text("This is a {.field field} (during)")
cli_end()
cli_text("This is a {.field field} (after)")
}))
})
test_that("cli_format", {
expect_snapshot(
cli_format(1:4/7, list(digits = 2))
)
})
test_that("cli_format() is used for .val", {
withr::local_options(cli.width = 60)
withr::local_rng_version("3.3.0")
set.seed(42)
expect_snapshot(local({
cli_div(theme = list(.val = list(digits = 2)))
cli_text("Some random numbers: {.val {runif(4)}}.")
}))
})
test_that(".q always double quotes", {
expect_snapshot(
cli_text("just a {.q string}, nothing more")
)
})
test_that(".or", {
expect_snapshot(
cli_text("{.or {letters[1:5]}}")
)
expect_snapshot(
cli_text("{.or {letters[1:2]}}")
)
})
test_that("line breaks", {
txt <- paste(
"Cupidatat deserunt culpa enim deserunt minim aliqua tempor fugiat",
"cupidatat laboris officia esse ex aliqua. Ullamco mollit adipisicing",
"anim."
)
txt2 <- paste0(txt, "\f", txt)
expect_snapshot(ansi_strwrap(txt2, width = 60))
})
test_that_cli(config = "ansi", "double ticks", {
x <- c("a", "`x`", "b")
cli_div(theme = list(
.code = list(color = "red"),
.fun = list(color = "red")
))
expect_snapshot(format_inline("{.code {x}}"))
expect_snapshot(format_inline("{.fun {x}}"))
})
test_that("do not inherit 'transform' issue #422", {
expect_snapshot({
d <- deparse(c("cli", "glue"))
cli::cli_alert_info("To install, run {.code install.packages({d})}")
})
expect_snapshot({
cli::cli_text("{.code foo({1+1})}")
})
})
test_that_cli(config = c("ansi", "plain"), "no inherit color, issue #474", {
expect_snapshot({
cli::cli_text("pre {.val x {'foo'} y} post")
})
})
test_that_cli(config = c("ansi", "plain"), "\\f at the end, issue #491", {
expect_snapshot({
cli_fmt(cli::cli_text("{.val a}{.val b}"))
cli_fmt(cli::cli_text("\f{.val a}{.val b}"))
cli_fmt(cli::cli_text("\f\f{.val a}{.val b}"))
cli_fmt(cli::cli_text("{.val a}\f{.val b}"))
cli_fmt(cli::cli_text("{.val a}\f\f{.val b}"))
cli_fmt(cli::cli_text("{.val a}{.val b}\f"))
cli_fmt(cli::cli_text("{.val a}{.val b}\f\f"))
cli_fmt(cli::cli_text("\f\f\f{.val a}\f\f\f{.val b}\f\f\f"))
})
})
test_that("truncate vectors at 20", {
expect_snapshot(
cli::cli_text("Some letters: {letters}")
)
})
test_that_cli(config = "ansi", "brace expresssion edge cases", {
foo <- "foo"
bar <- "bar"
expect_snapshot({
cli_text("{.code {foo} and {bar}}")
cli_text("{.emph {foo} and {bar}}")
cli_text("{.q {foo} and {bar}}")
})
})
test_that("various errors", {
expect_snapshot_error(
cli_text("xx {.foobar} yy")
)
expect_snapshot_error(
cli_text("xx {.someverylong+expression} yy")
)
expect_snapshot(
error = TRUE,
cli_text("xx {__cannot-parse-this__} yy"),
transform = sanitize_srcref,
variant = if (getRversion() < "4.2.0") "old-r" else "new-r"
)
expect_snapshot(
error = TRUE,
cli_text("xx {1 + 'a'} yy"),
transform = function(x) sanitize_call(sanitize_srcref(x))
)
})
test_that("format_inline and newlines", {
expect_snapshot({
format_inline("foo\nbar")
format_inline("\nfoo\n\nbar\n")
format_inline("foo\fbar")
format_inline("\ffoo\f\fbar\f")
})
expect_snapshot({
format_inline("foo\nbar", keep_whitespace = FALSE)
format_inline("\nfoo\n\nbar\n", keep_whitespace = FALSE)
format_inline("foo\fbar", keep_whitespace = FALSE)
format_inline("\ffoo\f\fbar\f", keep_whitespace = FALSE)
})
})
cli/tests/testthat/test-ansi-utils.R 0000644 0001762 0000144 00000002662 14317007616 017226 0 ustar ligges users
test_that("re_table", {
withr::local_options(
cli.num_colors = 256,
cli.hyperlink = TRUE
)
txt <- paste0(
"this is some text ",
col_red("red"),
" some more text ",
col_green("green"),
" then some ",
style_hyperlink("text", "https://example.com")
)
tbl <- re_table(ansi_regex(), txt)[[1]]
tbl2 <- cbind(tbl, c(text = substring(txt, tbl[, "start"], tbl[, "end"])))
expect_snapshot(tbl2)
expect_snapshot(non_matching(list(tbl), txt))
})
test_that("re_table special cases", {
withr::local_options(
cli.num_colors = 256,
cli.hyperlink = TRUE
)
txt <- "foobar"
tbl <- re_table(ansi_regex(), txt)[[1]]
expect_snapshot(tbl)
expect_snapshot(non_matching(list(tbl), txt))
expect_snapshot(non_matching(list(tbl), txt, empty = TRUE))
txt <- col_red("foobar")
tbl <- re_table(ansi_regex(), txt)[[1]]
expect_snapshot(tbl)
expect_snapshot(non_matching(list(tbl), txt))
expect_snapshot(non_matching(list(tbl), txt, empty = TRUE))
txt <- paste0("foo ", col_red(""), " bar")
tbl <- re_table(ansi_regex(), txt)[[1]]
expect_snapshot(tbl)
expect_snapshot(non_matching(list(tbl), txt))
expect_snapshot(non_matching(list(tbl), txt, empty = TRUE))
})
test_that("myseq", {
expect_snapshot({
myseq(1, 5)
myseq(1, 1)
myseq(1, 0)
myseq(1, 5, 2)
myseq(1, 6, 2)
myseq(1, 1, 2)
myseq(1, 2, -1)
myseq(10, 1, -1)
myseq(10, 1, -2)
myseq(1, 5, -2)
})
})
cli/tests/testthat/test-progress-message.R 0000644 0001762 0000144 00000005026 14230006710 020405 0 ustar ligges users
test_that("cli_progress_message", {
withr::local_options(cli.dynamic = FALSE, cli.ansi = FALSE)
fun <- function() {
cli_progress_message("Simplest progress 'bar', {.fun fn} {2} two{?s}")
}
expect_snapshot(capture_cli_messages(fun()))
})
test_that("cli_progress_message error", {
# we need the env var as well, because the on.exit handler of the progress
# bar might run after the on.exit handler that removes the `cli.dynamic`
# option.
withr::local_envvar(R_CLI_DYNAMIC = "false")
fun <- function() {
suppressWarnings(testthat::local_reproducible_output())
options(cli.dynamic = FALSE, cli.ansi = FALSE)
cli::cli_progress_message("Simplest progress 'bar', {.fun fn} {2} two{?s}")
stop("oopsie")
}
outfile <- tempfile()
on.exit(unlink(outfile), add = TRUE)
expect_error(callr::r(fun, stdout = outfile, stderr = outfile), "oopsie")
expect_snapshot(readLines(outfile))
# we need the env var as well, because the on.exit handler of the progress
# bar might run after the on.exit handler that removes the `cli.dynamic`
# option.
withr::local_envvar(R_CLI_DYNAMIC = "true")
fun2 <- function() {
suppressWarnings(testthat::local_reproducible_output())
options(cli.dynamic = TRUE, cli.ansi = TRUE)
cli::cli_progress_message("Simplest progress 'bar', {.fun fn} {2} two{?s}")
stop("oopsie")
}
outfile <- tempfile()
on.exit(unlink(outfile), add = TRUE)
expect_error(callr::r(fun2, stdout = outfile, stderr = outfile), "oopsie")
out <- rawToChar(readBin(outfile, "raw", 1000))
expect_snapshot(win2unix(out))
})
start_app()
on.exit(stop_app(), add = TRUE)
test_that("cli_progress_step", {
withr::local_options(cli.dynamic = TRUE, cli.ansi = TRUE)
suppressWarnings(testthat::local_reproducible_output())
fun <- function() {
cli_progress_step("First step")
cli_progress_step("Second step")
}
msgs <- fix_times(capture_cli_messages(fun()))
expect_snapshot(msgs)
})
test_that("cli_progress_step error", {
if (getRversion() < "3.5.0") skip("Needs R 3.5.0")
fun <- function() {
options(
cli.dynamic = FALSE,
cli.ansi = FALSE,
cli.unicode = FALSE,
cli.width = 80,
width = 80,
cli.num_colors = 1
)
cli::cli_progress_step("First step")
cli::cli_progress_step("Second step")
stop("oopsie")
}
outfile <- tempfile()
on.exit(unlink(outfile), add = TRUE)
expect_error(callr::r(fun, stdout = outfile, stderr = "2>&1"), "oopsie")
out <- fix_times(rawToChar(readBin(outfile, "raw", 1000)))
expect_snapshot(win2unix(out))
})
cli/tests/testthat/test-vt.R 0000644 0001762 0000144 00000006772 14312603722 015570 0 ustar ligges users
test_that("empty input", {
expect_snapshot(
vt_output("", width = 20, height = 2)$segment
)
})
test_that("raw input", {
expect_snapshot(
vt_output(charToRaw("foobar"), width = 20, height = 2)$segment
)
})
test_that("overflow", {
expect_snapshot(
vt_output(strrep("1234567890", 2), width = 19, height = 2)$segment
)
})
test_that("control characters", {
expect_snapshot(
vt_output("foo\nbar", width = 20, height = 2)$segment
)
expect_snapshot(
vt_output("foobar\rbaz", width = 20, height = 2)$segment
)
})
test_that("scroll up", {
expect_snapshot(
vt_output(strrep("1234567890", 5), width = 20, height = 2)$segment
)
expect_snapshot(
vt_output(paste0(1:10, "\n"), width = 10, height = 5)$segment
)
})
test_that_cli(config = "ansi", "ANSI SGR", {
expect_snapshot(
vt_output("12\033[31m34\033[1m56\033[39m78\033[21m90", width = 20, height = 2)
)
expect_snapshot(
vt_output(style_bold("I'm bold"), width = 20, height = 2)
)
expect_snapshot(
vt_output(style_italic("I'm italic"), width = 20, height = 2)
)
expect_snapshot(
vt_output(style_underline("I'm underlined"), width = 20, height = 2)
)
expect_snapshot(
vt_output(style_strikethrough("I'm strikethrough"), width = 20, height = 2)
)
expect_snapshot(
vt_output(style_inverse("I'm inverse"), width = 20, height = 2)
)
})
test_that("hyperlinks", {
withr::local_options(cli.hyperlink = TRUE)
expect_snapshot({
link <- style_hyperlink("text", "url")
vt_output(c("pre ", st_from_bel(link), " post"), width = 20, height = 2)
})
expect_snapshot({
link <- style_hyperlink("text", "url", params = c("f" = "x", "g" = "y"))
vt_output(c("pre ", st_from_bel(link), " post"), width = 20, height = 2)
})
})
test_that("erase in line", {
expect_snapshot({
vt_output("foobar\033[3D\033[K", width = 10, height = 2)$segment
vt_output("foobar\033[3D\033[0K", width = 10, height = 2)$segment
vt_output("foobar\033[3D\033[1K", width = 10, height = 2)$segment
vt_output("foobar\033[3D\033[2K", width = 10, height = 2)$segment
})
})
test_that("erase in screen", {
expect_snapshot({
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[J", width = 10, height = 4)$segment
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[0J", width = 10, height = 4)$segment
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[1J", width = 10, height = 4)$segment
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[2Jx", width = 10, height = 4)$segment
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[3Jx", width = 10, height = 4)$segment
})
})
test_that("colors", {
expect_equal(vt_output("\033[30mcolored\033[39m")$color[1], "0")
expect_equal(vt_output("\033[37mcolored\033[39m")$color[1], "7")
expect_equal(vt_output("\033[90mcolored\033[39m")$color[1], "8")
expect_equal(vt_output("\033[97mcolored\033[39m")$color[1], "15")
expect_equal(vt_output("\033[40mcolored\033[39m")$background_color[1], "0")
expect_equal(vt_output("\033[47mcolored\033[39m")$background_color[1], "7")
expect_equal(vt_output("\033[100mcolored\033[39m")$background_color[1], "8")
expect_equal(vt_output("\033[107mcolored\033[39m")$background_color[1], "15")
expect_equal(vt_output("\033[38;5;100mcolored\033[39m")$color[1], "100")
expect_equal(vt_output("\033[48;5;110mcolored\033[39m")$background_color[1], "110")
expect_equal(vt_output("\033[38;2;1;2;3mcolored\033[39m")$color[1], "#010203")
expect_equal(vt_output("\033[48;2;4;5;6mcolored\033[39m")$background_color[1], "#040506")
})
cli/tests/testthat/test-ansiex-2.R 0000644 0001762 0000144 00000031406 14301737210 016553 0 ustar ligges users
test_that("very long strings", {
withr::local_options(cli.num_colors = 256)
str <- strrep("1234 ", 1000)
expect_equal(
ansi_simplify(col_red(col_red(str))),
col_red(str)
)
str2 <- paste0(col_green(str), col_red(str))
expect_equal(
ansi_simplify(col_green(str2)),
ansi_string(str2)
)
})
test_that("RGB colors", {
cases <- list(
list("\033[38;5;123mfoo\033[39m", "\033[38;5;123mfoo\033[39m"),
list("\033[38;2;1;2;3mfoo\033[39m", "\033[38;2;1;2;3mfoo\033[39m"),
list("\033[38;2;mfoo\033[39m", "\033[38;2;0;0;0mfoo\033[39m"),
list("\033[48;5;123mfoo\033[49m", "\033[48;5;123mfoo\033[49m"),
list("\033[48;2;1;2;3mfoo\033[49m", "\033[48;2;1;2;3mfoo\033[49m"),
list("\033[48;2;mfoo\033[49m", "\033[48;2;0;0;0mfoo\033[49m"),
## bad tags are skipped completely
list("\033[48;4;12mfoo\033[49m", "foo")
)
for (c in cases) {
expect_equal(ansi_simplify(c[[1]]), ansi_string(c[[2]]))
}
})
test_that("0m closing tag", {
cases <- list(
list("\033[1mfoo\033[0m", "\033[1mfoo\033[22m"),
list("\033[1mfoo\033[m", "\033[1mfoo\033[22m")
)
for (c in cases) {
expect_equal(ansi_simplify(c[[1]]), ansi_string(c[[2]]))
}
})
test_that("various tags", {
cases <- list(
list("\033[1m\033[22m\033[1mfoo", "\033[1mfoo\033[22m"),
list("\033[2m\033[22m\033[2mfoo", "\033[2mfoo\033[22m"),
list("\033[3m\033[23m\033[3mfoo", "\033[3mfoo\033[23m"),
list("\033[4m\033[24m\033[4mfoo", "\033[4mfoo\033[24m"),
list("\033[5m\033[25m\033[5mfoo", "\033[5mfoo\033[25m"),
list("\033[7m\033[27m\033[7mfoo", "\033[7mfoo\033[27m"),
list("\033[8m\033[28m\033[8mfoo", "\033[8mfoo\033[28m"),
list("\033[9m\033[29m\033[9mfoo", "\033[9mfoo\033[29m"),
list("\033[30m\033[39m\033[30mfoo", "\033[30mfoo\033[39m"),
list("\033[31m\033[39m\033[31mfoo", "\033[31mfoo\033[39m"),
list("\033[32m\033[39m\033[32mfoo", "\033[32mfoo\033[39m"),
list("\033[33m\033[39m\033[33mfoo", "\033[33mfoo\033[39m"),
list("\033[34m\033[39m\033[34mfoo", "\033[34mfoo\033[39m"),
list("\033[35m\033[39m\033[35mfoo", "\033[35mfoo\033[39m"),
list("\033[36m\033[39m\033[36mfoo", "\033[36mfoo\033[39m"),
list("\033[37m\033[39m\033[37mfoo", "\033[37mfoo\033[39m"),
list("\033[90m\033[39m\033[90mfoo", "\033[90mfoo\033[39m"),
list("\033[91m\033[39m\033[91mfoo", "\033[91mfoo\033[39m"),
list("\033[92m\033[39m\033[92mfoo", "\033[92mfoo\033[39m"),
list("\033[93m\033[39m\033[93mfoo", "\033[93mfoo\033[39m"),
list("\033[94m\033[39m\033[94mfoo", "\033[94mfoo\033[39m"),
list("\033[95m\033[39m\033[95mfoo", "\033[95mfoo\033[39m"),
list("\033[96m\033[39m\033[96mfoo", "\033[96mfoo\033[39m"),
list("\033[97m\033[39m\033[97mfoo", "\033[97mfoo\033[39m"),
list("\033[40m\033[49m\033[40mfoo", "\033[40mfoo\033[49m"),
list("\033[41m\033[49m\033[41mfoo", "\033[41mfoo\033[49m"),
list("\033[42m\033[49m\033[42mfoo", "\033[42mfoo\033[49m"),
list("\033[43m\033[49m\033[43mfoo", "\033[43mfoo\033[49m"),
list("\033[44m\033[49m\033[44mfoo", "\033[44mfoo\033[49m"),
list("\033[45m\033[49m\033[45mfoo", "\033[45mfoo\033[49m"),
list("\033[46m\033[49m\033[46mfoo", "\033[46mfoo\033[49m"),
list("\033[47m\033[49m\033[47mfoo", "\033[47mfoo\033[49m"),
list("\033[100m\033[49m\033[100mfoo", "\033[100mfoo\033[49m"),
list("\033[101m\033[49m\033[101mfoo", "\033[101mfoo\033[49m"),
list("\033[102m\033[49m\033[102mfoo", "\033[102mfoo\033[49m"),
list("\033[103m\033[49m\033[103mfoo", "\033[103mfoo\033[49m"),
list("\033[104m\033[49m\033[104mfoo", "\033[104mfoo\033[49m"),
list("\033[105m\033[49m\033[105mfoo", "\033[105mfoo\033[49m"),
list("\033[106m\033[49m\033[106mfoo", "\033[106mfoo\033[49m"),
list("\033[107m\033[49m\033[107mfoo", "\033[107mfoo\033[49m")
)
for (c in cases) {
expect_equal(ansi_simplify(c[[1]]), ansi_string(c[[2]]))
}
})
test_that("unknown tags are kept as is, and [0m is also kept for then", {
cases <- list(
list("\033[11mfoo\033[0m", "\033[11mfoo\033[0m")
)
for (c in cases) {
expect_equal(ansi_simplify(c[[1]]), ansi_string(c[[2]]))
}
})
test_that("simplify w/o tags", {
cases <- list(
list(c("", "foo", "\033[1mbold"), c("", "foo", "\033[1mbold\033[22m"))
)
for (c in cases) {
expect_equal(ansi_simplify(c[[1]]), ansi_string(c[[2]]))
}
})
test_that("CSI sequences", {
expect_equal(
ansi_simplify("foo\033[10Abar", csi = "drop"),
ansi_string("foobar")
)
expect_equal(
ansi_simplify("\033[1mfoo\033[0m\033[10Abar", csi = "drop"),
ansi_string("\033[1mfoo\033[22mbar")
)
expect_equal(
ansi_simplify("foo\033[10Abar", csi = "keep"),
ansi_string("foo\033[10Abar")
)
expect_equal(
ansi_simplify("\033[1mfoo\033[0m\033[10Abar", csi = "keep"),
ansi_string("\033[1mfoo\033[10A\033[22mbar")
)
expect_equal(
ansi_strip("\033[1mfoo\033[10Abar\033[0m", csi = TRUE, sgr = FALSE),
"\033[1mfoobar\033[0m"
)
expect_equal(
ansi_strip("\033[1mfoo\033[10Abar\033[0m", csi = FALSE, sgr = TRUE),
"foo\033[10Abar"
)
})
test_that("ansi_has_any", {
T <- TRUE
F <- FALSE
expect_false(ansi_has_any("foobar", sgr = T, csi = T))
expect_true (ansi_has_any("\033[1mfoobar", sgr = T, csi = T))
expect_true (ansi_has_any("\033[10Afoobar", sgr = T, csi = T))
expect_true (ansi_has_any("\033[10A\033[1mfoobar", sgr = T, csi = T))
expect_false(ansi_has_any("foobar", sgr = T, csi = F))
expect_true (ansi_has_any("\033[1mfoobar", sgr = T, csi = F))
expect_false(ansi_has_any("\033[10Afoobar", sgr = T, csi = F))
expect_true (ansi_has_any("\033[10A\033[1mfoobar", sgr = T, csi = F))
expect_false(ansi_has_any("foobar", sgr = F, csi = T))
expect_false(ansi_has_any("\033[1mfoobar", sgr = F, csi = T))
expect_true (ansi_has_any("\033[10Afoobar", sgr = F, csi = T))
expect_true (ansi_has_any("\033[10A\033[1mfoobar", sgr = F, csi = T))
expect_false(ansi_has_any("foobar", sgr = F, csi = F))
expect_false(ansi_has_any("\033[1mfoobar", sgr = F, csi = F))
expect_false(ansi_has_any("\033[10Afoobar", sgr = F, csi = F))
expect_false(ansi_has_any("\033[10A\033[1mfoobar", sgr = F, csi = F))
})
test_that("NA", {
T <- TRUE
F <- FALSE
s <- c("foo", NA, "bar", "\033[1mfoobar")
expect_equal(
ansi_simplify(s),
ansi_string(c("foo", NA, "bar", "\033[1mfoobar\033[22m"))
)
expect_equal(is.na(ansi_simplify(s)), c(F, T, F, F))
expect_equal(
ansi_substr(s, 1, 2),
ansi_string(c("fo", NA, "ba", "\033[1mfo\033[22m"))
)
expect_equal(is.na(ansi_substr(s, 1, 2)), c(F, T, F, F))
expect_snapshot(ansi_html(s))
expect_equal(is.na(ansi_html(s)), c(F, T, F, F))
expect_equal(ansi_has_any(s), c(F, NA, F, T))
expect_equal(ansi_strip(s), c("foo", NA, "bar", "foobar"))
expect_equal(is.na(ansi_strip(s)), c(F, T, F, F))
})
test_that("strrep", {
expect_equal(strrep(character(), 5), character())
expect_equal(strrep("a", 5), "aaaaa")
})
test_that("convert to character", {
expect_false(ansi_has_any(123))
expect_equal(ansi_strip(123), "123")
expect_equal(ansi_substr(1234, 2, 3), ansi_string("23"))
expect_equal(ansi_substring(1234, 2, 3), ansi_string("23"))
expect_equal(ansi_strsplit(1234, 2), list(ansi_string(c("1", "34"))))
expect_equal(ansi_trimws(123), ansi_string("123"))
expect_equal(ansi_strwrap(123), ansi_string("123"))
expect_equal(ansi_simplify(123), ansi_string("123"))
expect_equal(ansi_html(123), "123")
expect_equal(ansi_nchar(123), 3)
})
test_that("ansi_nchar", {
b <- col_red(c(
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3fc\u200d\u2642\ufe0f",
"\U0001f477\U0001f3fd\u200d\u2640\ufe0f",
"\U0001f477",
"\U0001f477\U0001f3fe\u200d\u2640\ufe0f"
))
expect_equal(ansi_nchar(b), rep(1L, 5))
expect_equal(ansi_nchar(b, "chars"), rep(1L, 5))
expect_equal(ansi_nchar(b, "bytes"), c(8L, 17L, 17L, 4L, 17L))
expect_equal(ansi_nchar(b, "width"), rep(2L, 5))
expect_equal(ansi_nchar(b, "graphemes"), rep(1L, 5))
expect_equal(ansi_nchar(b, "codepoints"), c(2L, 5L, 5L, 1L, 5L))
bb <- paste0(b, collapse = "")
expect_equal(ansi_nchar(bb), sum(rep(1L, 5)))
expect_equal(ansi_nchar(bb, "chars"), sum(rep(1L, 5)))
expect_equal(ansi_nchar(bb, "bytes"), sum(c(8L, 17L, 17L, 4L, 17L)))
expect_equal(ansi_nchar(bb, "width"), sum(rep(2L, 5)))
expect_equal(ansi_nchar(bb, "graphemes"), sum(rep(1L, 5)))
expect_equal(ansi_nchar(bb, "codepoints"), sum(c(2L, 5L, 5L, 1L, 5L)))
expect_equal(ansi_nchar(character(), "chars"), integer())
expect_equal(ansi_nchar(character(), "bytes"), integer())
expect_equal(ansi_nchar(character(), "width"), integer())
expect_equal(ansi_nchar(character(), "graphemes"), integer())
expect_equal(ansi_nchar(character(), "codepoints"), integer())
expect_equal(ansi_nchar("", "chars"), 0L)
expect_equal(ansi_nchar("", "bytes"), 0L)
expect_equal(ansi_nchar("", "width"), 0L)
expect_equal(ansi_nchar("", "graphemes"), 0L)
expect_equal(ansi_nchar("", "codepoints"), 0L)
})
test_that("ansi_align with graphemes", {
withr::local_options(cli.num_colors = 256)
b <- col_red(c(
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3fc\u200d\u2642\ufe0f",
"\U0001f477\U0001f3fd\u200d\u2640\ufe0f",
"\U0001f477",
"\U0001f477\U0001f3fe\u200d\u2640\ufe0f"
))
expect_equal(
ansi_align(b, width = 10, align = "left"),
ansi_string(paste0(b, strrep(" ", 8)))
)
expect_equal(
ansi_align(b, width = 10, align = "center"),
ansi_string(paste0(strrep(" ", 4), b, strrep(" ", 4)))
)
expect_equal(
ansi_align(b, width = 10, align = "right"),
ansi_string(paste0(strrep(" ", 8), b))
)
})
test_that("ansi_columns with graphemes", {
withr::local_options(cli.num_colors = 256)
b <- col_red(c(
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3fc\u200d\u2642\ufe0f",
"\U0001f477\U0001f3fd\u200d\u2640\ufe0f",
"\U0001f477",
"\U0001f477\U0001f3fe\u200d\u2640\ufe0f"
))
expect_equal(
ansi_columns(b, width = 6),
ansi_string(c(
paste0(b[1], " ", b[2], " "),
paste0(b[3], " ", b[4], " "),
paste0(b[5], " ")
))
)
})
test_that("ansi_substr with graphemes", {
withr::local_options(cli.num_colors = 256)
b <- col_red(c(
"\U0001f477\U0001f3fb",
"\U0001f477\U0001f3fc\u200d\u2642\ufe0f",
"\U0001f477\U0001f3fd\u200d\u2640\ufe0f",
"\U0001f477",
"\U0001f477\U0001f3fe\u200d\u2640\ufe0f"
))
bb <- paste0(b, collapse = "")
expect_equal(
ansi_substr(bb, 2, 4),
col_red(paste0(
"\U0001f477\U0001f3fc\u200d\u2642\ufe0f",
"\U0001f477\U0001f3fd\u200d\u2640\ufe0f",
"\U0001f477"
))
)
})
test_that("ansi_grep", {
withr::local_options(cli.num_colors = 256, cli.hyperlink = TRUE)
red_needle <- col_red("needle")
haystack <- c("foo", "needle", "foo")
green_haystack <- col_green(haystack)
expect_equal(
ansi_grep(red_needle, green_haystack),
2L
)
expect_equal(
ansi_grep(red_needle, haystack),
2L
)
expect_equal(
ansi_grep(red_needle, green_haystack, value = TRUE),
ansi_string(green_haystack[2])
)
expect_equal(
ansi_grep("nope", haystack),
integer()
)
expect_equal(
ansi_grep("nope", haystack, value = TRUE),
ansi_string(character())
)
expect_equal(
ansi_grep("nope", character()),
integer()
)
expect_equal(
ansi_grep("nope", character(), value = TRUE),
ansi_string(character())
)
})
test_that("ansi_grepl", {
withr::local_options(cli.num_colors = 256, cli.hyperlink = TRUE)
red_needle <- col_red("needle")
haystack <- c("foo", "needle", "foo")
green_haystack <- col_green(haystack)
expect_equal(
ansi_grepl(red_needle, green_haystack),
c(FALSE, TRUE, FALSE)
)
expect_equal(
ansi_grepl(red_needle, haystack),
c(FALSE, TRUE, FALSE)
)
expect_equal(
ansi_grepl("nope", haystack),
c(FALSE, FALSE, FALSE)
)
expect_equal(
ansi_grepl("nope", character()),
logical()
)
})
test_that("ansi_nzchar", {
withr::local_options(cli.num_colors = 256, cli.hyperlink = TRUE)
expect_equal(ansi_nzchar(""), FALSE)
expect_equal(ansi_nzchar(c("", "")), c(FALSE, FALSE))
expect_equal(ansi_nzchar(c("", "yes")), c(FALSE, TRUE))
expect_equal(ansi_nzchar(c("yes", "")), c(TRUE, FALSE))
expect_equal(ansi_nzchar(c("yes", "yes")), c(TRUE, TRUE))
expect_equal(ansi_nzchar(col_red("")), FALSE)
expect_equal(ansi_nzchar(col_red(c("", ""))), c(FALSE, FALSE))
expect_equal(ansi_nzchar(col_red(c("", "yes"))), c(FALSE, TRUE))
expect_equal(ansi_nzchar(col_red(c("yes", ""))), c(TRUE, FALSE))
expect_equal(ansi_nzchar(col_red(c("yes", "yes"))), c(TRUE, TRUE))
expect_equal(ansi_nzchar(style_hyperlink("text", "https://x.xom")), TRUE)
expect_equal(ansi_nzchar(style_hyperlink("", "https://x.xom")), FALSE)
expect_equal(ansi_nzchar(NA), nzchar(NA))
expect_equal(ansi_nzchar(NA, keepNA = TRUE), nzchar(NA, keepNA = TRUE))
})
cli/tests/testthat/test-sitrep.R 0000644 0001762 0000144 00000000773 14143453131 016437 0 ustar ligges users
test_that("sitrep runs", {
expect_true(is.list(cli_sitrep()))
expect_true(is.character(format(cli_sitrep())))
out <- capture_output(print(cli_sitrep()))
expect_true(all(grepl("^- ", out)))
})
test_that("get_active_symbol_set", {
withr::with_options(list(cli.unicode = TRUE), {
expect_true(get_active_symbol_set() %in% c("UTF-8", "RStudio (UTF-8)"))
})
withr::with_options(list(cli.unicode = FALSE), {
set <- get_active_symbol_set()
expect_equal(set, "ASCII (non UTF-8)")
})
})
cli/tests/testthat/test-code.R 0000644 0001762 0000144 00000000200 14143453131 016024 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli("issue #154", {
expect_snapshot({
cli_code("a\nb\nc")
})
})
cli/tests/testthat/setup.R 0000644 0001762 0000144 00000000264 14143453131 015307 0 ustar ligges users
unlink(dir(
file.path(dirname(dirname(normalizePath(test_path()))), "src"),
pattern = "[.]gcda$",
full.names = TRUE
))
withr::defer(.Call(clic__gcov_flush), teardown_env())
cli/tests/testthat/test-bullets.R 0000644 0001762 0000144 00000001554 14200722245 016600 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli("bullets", {
expect_snapshot(cli_bullets(c(
"noindent",
" " = "space",
"v" = "success",
"x" = "danger",
"!" = "warning",
"i" = "info",
"*" = "bullet",
">" = "arrow"
)))
})
test_that_cli("bullets glue", {
expect_snapshot(cli_bullets(c(
"noindent {.key {1:3}}",
" " = "space {.key {1:3}}",
"v" = "success {.key {1:3}}",
"x" = "danger {.key {1:3}}",
"!" = "warning {.key {1:3}}",
"i" = "info {.key {1:3}}",
"*" = "bullet {.key {1:3}}",
">" = "arrow {.key {1:3}}"
)))
})
test_that_cli("bullets wrapping", {
txt <- strrep("This is some text that is longer than the width. ", 3)
expect_snapshot(cli_bullets(c(
txt,
" " = txt,
"v" = txt,
"x" = txt,
"!" = txt,
"i" = txt,
"*" = txt,
">" = txt
)))
})
cli/tests/testthat/test-diff.R 0000644 0001762 0000144 00000004355 14313063767 016054 0 ustar ligges users
test_that("diff_chr", {
# Something simple first
a <- as.character(c(1,1,1,1,1,1,1,2,3,4,4,4,4,4,4,4,5))
b <- as.character(c(1,1,1,1,1,1,1,2,10,4,4,4,4,4,4,4,6,7,5))
d <- diff_chr(a, b)
expect_snapshot(d$lcs)
d <- diff_chr(b, a)
expect_snapshot(d$lcs)
})
test_that_cli(configs = c("plain", "ansi"), "diff_chr", {
# Something simple first
a <- as.character(c(1,1,1,1,1,1,1,2,3,4,4,4,4,4,4,4,5))
b <- as.character(c(1,1,1,1,1,1,1,2,10,4,4,4,4,4,4,4,6,7,5))
d <- diff_chr(a, b)
expect_snapshot(d)
expect_snapshot(d$lcs)
})
test_that("diff_chr edge cases", {
expect_snapshot(diff_chr(character(), character()))
expect_snapshot(diff_chr(character(), character())$lcs)
expect_snapshot(diff_chr("a", character()))
expect_snapshot(diff_chr(character(), "b"))
expect_snapshot(diff_chr("a", "a"))
expect_snapshot(diff_chr(letters, letters))
expect_snapshot(diff_chr(c("a", NA, "a2"), "b"))
expect_snapshot(diff_chr(NA_character_, "NA"))
})
test_that("format.cli_diff_chr context", {
# Something simple first
a <- as.character(c(1,1,1,1,1,1,1,2,3,4,4,4,4,4,4,4,5))
b <- as.character(c(1,1,1,1,1,1,1,2,10,4,4,4,4,4,4,4,6,7,5))
d <- diff_chr(a, b)
expect_snapshot(print(d, context = 1))
expect_snapshot(print(d, context = 0))
expect_snapshot(print(d, context = Inf))
d2 <- diff_chr(c("foo", "bar"), c("foo", "bar"))
expect_snapshot(print(d2, context = Inf))
})
test_that_cli(config = c("plain", "ansi"), "diff_str", {
str1 <- "abcdefghijklmnopqrstuvwxyz"
str2 <- "PREabcdefgMIDDLEnopqrstuvwxyzPOST"
d <- diff_str(str1, str2)
expect_snapshot(d)
})
test_that("warnings and errors", {
expect_error(diff_chr(1:10, 1:10), "is.character")
expect_error(
format(diff_chr("foo", "bar"), context = -1),
"is_count"
)
expect_warning(
format(diff_chr("foo", "bar"), what = 1, is = 2, this = 3),
"Extra arguments"
)
expect_warning(
format(diff_str("foo", "bar"), what = 1, is = 2, this = 3),
"Extra arguments"
)
})
test_that("max_diff", {
expect_snapshot_error(
class = "cli_diff_max_dist",
diff_chr("a", c("a", "b"), 0)
)
expect_silent(diff_chr(c("a", "c"), c("a", "b"), 2))
expect_snapshot_error(
class = "cli_diff_max_dist",
diff_chr(c("a", "c"), c("a", "b"), 1)
)
})
cli/tests/testthat/test-meta.R 0000644 0001762 0000144 00000003062 14301737210 016050 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli("meta basics", {
expect_snapshot(
cli::cli({
message("This is before")
cli_alert_info("First message")
message("This as well")
cli_alert_success("Success!")
})
)
})
test_that_cli("meta is single cli_message", {
msgs <- list()
withCallingHandlers(
cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}),
cli_message = function(msg) {
msgs <<- c(msgs, list(msg))
invokeRestart("cli_message_handled")
}
)
expect_equal(length(msgs), 1L)
expect_snapshot(cli_server_default(msgs[[1]]))
})
test_that_cli("meta is single cliMessage", {
msgs <- list()
expect_snapshot(
withCallingHandlers(
cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}),
cliMessage = function(msg) {
msgs <<- c(msgs, list(msg))
}
)
)
expect_equal(length(msgs), 1L)
})
test_that_cli("substitution", {
expect_snapshot(local({
x <- 1:3
cli({
title <- "My title"
cli_h1("Title: {.emph {title}}")
cli_text("And {.emph some} more: {.val {x}}")
})
}))
})
test_that("return values are ok when recording (#496)", {
expect_snapshot(
cli::cli({
lid <- cli::cli_ul()
cli::cli_li("a bullet")
cli::cli_end(lid)
})
)
})
test_that("nested cli() (#497)", {
expect_snapshot(
cli::cli({
cli::cli_h1("Header")
cli::cli(cli::cli_text("Some text"))
cli::cli_text("Some more text")
})
)
})
cli/tests/testthat/test-timer.R 0000644 0001762 0000144 00000000436 14143453131 016245 0 ustar ligges users
test_that("ALTREP methods", {
expect_equal(length(`__cli_update_due`), 1L)
expect_silent({
tim <- `__cli_update_due`
tim[1] <- FALSE
})
expect_silent({
`__cli_update_due`[1]
})
})
test_that("cli_tick_set", {
skip_on_cran()
expect_silent(cli_tick_set())
})
cli/tests/testthat/test-glue.R 0000644 0001762 0000144 00000002031 14315310046 016050 0 ustar ligges users
# https://github.com/r-lib/cli/issues/370
test_that("glue quotes and comments", {
expect_snapshot({
cli_dl(
c(
"test_1" = "all good",
"test_2" = "not #good"
)
)
cli::cli_dl(c("test_3" = "no' good either"))
cli::cli_dl(c("test_4" = "no\" good also"))
cli::cli_text("{.url https://example.com/#section}")
cli::cli_alert_success("Qapla'")
})
})
test_that("quotes, etc. within expressions are still OK", {
expect_snapshot({
cli::cli_text("{.url URL} {x <- 'foo'; nchar(x)}")
cli::cli_text("{.url URL} {x <- \"foo\"; nchar(x)}")
cli::cli_text("{.url URL} {1 + 1 # + 1} {1 + 1}")
})
})
test_that("{. } is always a style", {
cmd <- paste0("{.", basename(tempfile()), " }")
expect_silent(glue_cmd(cmd, .envir = environment()))
.foo <- 100
vals <- glue_cmd("{.foo }", .envir = environment())$values
expect_false(any(grepl("^v[0-9]+$", names(vals))))
})
test_that("{ } is parsed with literal = FALSE", {
expect_snapshot(
format_message("{.emph {'{foo {}'}}")
)
})
cli/tests/testthat/test-spark.R 0000644 0001762 0000144 00000000447 14143453131 016247 0 ustar ligges users
test_that_cli(configs = c("plain", "unicode"), "spark_bar", {
expect_snapshot({
spark_bar(seq(0, 1, length = 8))
spark_bar(c(0, NA, 0.5, NA, 1))
})
})
test_that_cli(configs = c("plain", "unicode"), "spark_line", {
expect_snapshot({
spark_line(seq(0, 1, length = 10))
})
})
cli/tests/testthat/test-cliapp-output.R 0000644 0001762 0000144 00000010323 14143453131 017727 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("cliapp output auto", {
skip_on_cran()
txt <- "Stay calm. This is a test."
script <- tempfile(fileext = ".R")
on.exit(unlink(script, recursive = TRUE), add = TRUE)
# stderr if not interactive ----------------
code <- substitute(env = list(txt = txt), {
options(rlib_interactive = FALSE, cli.num_colors = 1L)
cli::cli_text(txt)
})
cat(deparse(code), file = script, sep = "\n")
out <- callr::rscript(script, show = FALSE, fail_on_status = FALSE)
expect_true(out$stderr %in% paste0(txt, c("\n", "\r\n")))
expect_equal(out$stdout, "")
# stdout if interactive --------------------
code <- substitute(env = list(txt = txt), {
options(rlib_interactive = TRUE, cli.num_colors = 1L)
cli::cli_text(txt)
})
cat(deparse(code), file = script, sep = "\n")
out <- callr::rscript(script, show = FALSE, fail_on_status = FALSE)
expect_true(out$stdout %in% paste0(txt, c("\n", "\r\n")))
expect_equal(out$stderr, "")
# choose explicitly -----------------------
txt2 <- "Don't move"
code <- substitute(env = list(txt = txt, txt2 = txt2), {
options(rlib_interactive = FALSE, cli_num_colors = 1L)
cli::start_app(output = "stderr")
cli::cli_text(txt)
cli::stop_app()
options(rlib_interactive = TRUE)
cli::start_app(output = "stdout")
cli::cli_text(txt2)
cli::stop_app()
})
cat(deparse(code), file = script, sep = "\n")
out <- callr::rscript(script, show = FALSE, fail_on_status = FALSE)
expect_true(out$stderr %in% paste0(txt, c("\n", "\r\n")))
expect_true(out$stdout %in% paste0(txt2, c("\n", "\r\n")))
})
test_that("can also use a connection", {
skip_on_cran()
txt <- "Stay calm. This is a test."
script <- tempfile(fileext = ".R")
on.exit(unlink(script, recursive = TRUE), add = TRUE)
code <- substitute(env = list(txt = txt), {
options(cli.num_colors = 1L)
con <- textConnection(NULL, open = "w", local = TRUE)
cli::start_app(output = con)
cli::cli_text(txt)
cli::stop_app()
flush(con)
cat("output:", textConnectionValue(con), "\n", sep = "")
})
cat(deparse(code), file = script, sep = "\n")
out <- callr::rscript(script, show = FALSE, fail_on_status = FALSE)
expect_true(out$stdout %in% paste0("output:", txt, c("\n", "\r\n")))
expect_equal(out$stderr, "")
})
test_that("message if there is a sink", {
# if there is an output sink, non-interactive
msgs <- NULL
tmp <- NULL
fun <- function() {
sink(tmp <<- tempfile())
on.exit(sink(NULL), add = TRUE)
cli_text("Hola")
}
withCallingHandlers(
fun(),
cliMessage = function(m) {
msgs <<- c(msgs, list(m))
invokeRestart("muffleMessage")
}
)
expect_equal(msgs[[1]]$message, "Hola\n")
expect_equal(length(readLines(tmp)), 0)
# if there is a message sink, non-interactive
msgs <- NULL
tmp <- tempfile()
con <- file(tmp, open = "w+")
fun <- function() {
sink(con, type = "message")
on.exit(sink(NULL, type = "message"), add = TRUE)
cat("this\n", file = stderr())
cli_text("Hola")
}
withCallingHandlers(
fun(),
cliMessage = function(m) {
msgs <<- c(msgs, list(m))
invokeRestart("muffleMessage")
}
)
expect_equal(msgs[[1]]$message, "Hola\n")
expect_equal(readLines(tmp), "this")
withr::local_options(rlib_interactive = TRUE)
# if there is an output sink, interactive
msgs <- NULL
tmp <- NULL
fun <- function() {
sink(tmp <<- tempfile())
on.exit(sink(NULL), add = TRUE)
cli_text("Hola")
}
withCallingHandlers(
fun(),
cliMessage = function(m) {
msgs <<- c(msgs, list(m))
invokeRestart("muffleMessage")
}
)
expect_equal(msgs[[1]]$message, "Hola\n")
expect_equal(length(readLines(tmp)), 0)
# if there is a message sink, interactive
msgs <- NULL
tmp <- tempfile()
con <- file(tmp, open = "w+")
fun <- function() {
sink(con, type = "message")
on.exit(sink(NULL, type = "message"), add = TRUE)
cat("this\n", file = stderr())
cli_text("Hola")
}
withCallingHandlers(
fun(),
cliMessage = function(m) {
msgs <<- c(msgs, list(m))
invokeRestart("muffleMessage")
}
)
expect_equal(msgs[[1]]$message, "Hola\n")
expect_equal(readLines(tmp), "this")
})
cli/tests/testthat/test-spinners.R 0000644 0001762 0000144 00000000467 14143453131 016772 0 ustar ligges users
test_that("get_spinner", {
if (is_utf8_output()) {
expect_equal(get_spinner()$name, "dots")
} else {
expect_equal(get_spinner()$name, "line")
}
})
test_that("list_spinners", {
ls <- list_spinners()
expect_true(is.character(ls))
expect_true("dots" %in% ls)
expect_true("line" %in% ls)
})
cli/tests/testthat/test-ansiex.R 0000644 0001762 0000144 00000043242 14535114677 016434 0 ustar ligges users
test_that("cli_ansi_string", {
right <- c("cli_ansi_string", "ansi_string", "character")
expect_equal(class(ansi_string("foobar")), right)
expect_equal(class(ansi_string(133)), right)
expect_equal(class(ansi_string(ansi_string(134))), right)
})
test_that("ansi_regex", {
# somewhat special sequences
cases <- list(
list("foo\033[39;49mbar", "foobar"),
list("foo\033[1;3;4mbar", "foobar"),
list("foo\033[1;;4mbar", "foobar"),
list("foo\033[mbar", "foobar")
)
for (case in cases) {
expect_equal(gsub(ansi_regex(), "", case[[1]], perl = TRUE), case[[2]])
}
})
test_that("ansi_has_any works", {
withr::local_options(list(
cli.num_colors = 256L,
cli.hyperlink = TRUE
))
expect_false(ansi_has_any("foobar"))
funcs <- ls(asNamespace("cli"), pattern = "^col_|^bg_|^style_")
for (sym in setdiff(funcs, "style_hyperlink")) {
fun <- get(sym, envir = asNamespace("cli"))
expect_true(ansi_has_any(fun("foo", "bar")), label = sym)
}
})
test_that("ansi_strip works", {
withr::local_options(list(
cli.num_colors = 256L,
cli.hyperlink = TRUE
))
expect_equal("", ansi_strip(""))
expect_equal("foobar", ansi_strip("foobar"))
expect_equal(
"foobar",
ansi_strip(col_red(style_underline(style_bold("foobar"))))
)
funcs <- ls(asNamespace("cli"), pattern = "^col_|^bg_|^style_")
for (sym in setdiff(funcs, "style_hyperlink")) {
fun <- get(sym, envir = asNamespace("cli"))
ans <- if (sym == "style_hyperlink") "foo" else "foobar"
expect_equal(ans, ansi_strip(fun("foo", "bar")))
}
})
str <- c("",
"plain",
"\033[31m",
"\033[39m",
"\033[31mred\033[39m",
"\033[31mred\033[39m\033[31mred\033[39m",
"foo\033[31mred\033[39m",
"\033[31mred\033[39mfoo")
test_that("ansi_nchar", {
withr::local_options(list(cli.num_colors = 256L))
for (s in str) {
expect_equal(ansi_nchar(s), nchar(ansi_strip(s)), info = s)
}
})
test_that("ansi_nchar wide characters", {
expect_equal(ansi_nchar("\u231a", "width"), 2L)
})
test_that("ansi_substr bad input", {
expect_snapshot(
error = TRUE,
ansi_substr("foobar", NULL, 10)
)
expect_snapshot(
error = TRUE,
ansi_substr("foobar", 10, NULL)
)
expect_snapshot(
error = TRUE,
ansi_substr("foobar", "bad", "bad")
)
})
test_that("ansi_substr", {
withr::local_options(list(cli.num_colors = 256L))
for (s in str) {
for (i in 1 %:% ansi_nchar(s)) {
for (j in i %:% ansi_nchar(s)) {
expect_equal(ansi_strip(ansi_substr(s, i, j)),
substr(ansi_strip(s), i, j), info = paste(s, i, j))
}
}
}
})
test_that("ansi_substr keeps color", {
withr::local_options(list(cli.num_colors = 256L))
expect_equal(
ansi_substr("\033[31mred\033[39m", 1, 1),
ansi_string("\033[31mr\033[39m")
)
expect_equal(
ansi_substr("foo\033[31mred\033[39m", 4, 4),
ansi_string("\033[31mr\033[39m")
)
expect_equal(
ansi_substr("foo\033[31mred\033[39mbar", 4, 4),
ansi_string("\033[31mr\033[39m")
)
expect_equal(
ansi_substr("\033[31mred\033[39mfoo\033[31mred\033[39mbar", 7, 7),
ansi_string("\033[31mr\033[39m")
)
})
test_that("ansi_substr, start after string end", {
withr::local_options(list(cli.num_colors = 256L))
expect_equal(ansi_substr("red", 4, 4), ansi_string(""))
expect_equal(ansi_substr("red", 4, 5), ansi_string(""))
expect_equal(ansi_strip(ansi_substr("\033[31mred\033[39m", 4, 4)), "")
expect_equal(ansi_strip(ansi_substr("\033[31mred\033[39m", 4, 5)), "")
expect_equal(ansi_substr("red", 3, 4), ansi_string("d"))
expect_equal(ansi_substr("red", 3, 5), ansi_string("d"))
expect_equal(ansi_strip(ansi_substr("\033[31mred\033[39m", 3, 4)), "d")
expect_equal(ansi_strip(ansi_substr("\033[31mred\033[39m", 3, 5)), "d")
})
test_that("ansi_substr, multiple strings", {
withr::local_options(list(cli.num_colors = 256L))
set.seed(42)
for (i in 1:100) {
strs <- sample(str, 4)
num_starts <- sample(1:5, 1)
num_stops <- sample(1:5, 1)
starts <- sample(1:5, num_starts, replace = TRUE)
stops <- sample(1:5, num_stops, replace = TRUE)
r1 <- ansi_strip(ansi_substr(strs, starts, stops))
r2 <- substr(ansi_strip(strs), starts, stops)
expect_equal(r1, r2)
}
})
test_that("ansi_substr corner cases", {
withr::local_options(list(cli.num_colors = 256L))
# Zero length input
c0 <- character(0L)
o0 <- structure(list(), class="abc")
co0 <- structure(character(0L), class="abc")
expect_identical(ansi_substr(c0, 1, 1), ansi_string(substr(c0, 1, 1)))
expect_identical(ansi_substr(o0, 1, 1), ansi_string(substr(o0, 1, 1)))
expect_identical(ansi_substr(co0, 1, 1), ansi_string(substr(co0, 1, 1)))
expect_identical(
ansi_substring(c0, 1, 1),
ansi_string(substring(c0, 1, 1))
)
expect_identical(
ansi_substring(o0, 1, 1),
ansi_string(substring(o0, 1, 1))
)
expect_identical(
ansi_substring(co0, 1, 1),
ansi_string(substring(co0, 1, 1))
)
# Character start/stop
expect_identical(
ansi_substr("abc", "1", 1),
ansi_string(substr("abc", "1", 1))
)
expect_identical(
ansi_substr("abc", 1, "1"),
ansi_string(substr("abc", 1, "1"))
)
# non-numeric arguments cause errors; NOTE: this actually "works"
# with 'substr' but not implemented in 'ansi_substr'
expect_snapshot(
error = TRUE,
ansi_substr("abc", "hello", 1)
)
})
test_that("ansi_substring", {
withr::local_options(list(cli.num_colors = 256L))
for (s in str) {
for (i in 1 %:% ansi_nchar(s)) {
for (j in i %:% ansi_nchar(s)) {
expect_equal(ansi_strip(ansi_substring(s, i, j)),
substring(ansi_strip(s), i, j), info = paste(s, i, j))
}
}
}
})
test_that("ansi_substring, multiple strings", {
withr::local_options(list(cli.num_colors = 256L))
set.seed(42)
for (i in 1:100) {
strs <- sample(str, 4)
num_starts <- sample(1:5, 1)
num_stops <- sample(1:5, 1)
starts <- sample(1:5, num_starts, replace = TRUE)
stops <- sample(1:5, num_stops, replace = TRUE)
r1 <- ansi_strip(ansi_substring(strs, starts, stops))
r2 <- substring(ansi_strip(strs), starts, stops)
expect_equal(r1, r2)
}
})
test_that("ansi_substring corner cases", {
withr::local_options(list(cli.num_colors = 256L))
# Zero length input
c0 <- character(0L)
o0 <- structure(list(), class="abc")
co0 <- structure(character(0L), class="abc")
expect_identical(
ansi_substring(c0, 1, 1),
ansi_string(substring(c0, 1, 1))
)
expect_identical(
ansi_substring(o0, 1, 1),
ansi_string(substring(o0, 1, 1))
)
expect_identical(
ansi_substring(co0, 1, 1),
ansi_string(substring(co0, 1, 1))
)
})
test_that("ansi_strsplit", {
withr::local_options(list(cli.num_colors = 256L))
red <- "\033[31mred\033[39m"
str <- "plain-plain"
expect_equal(
ansi_strsplit(str, "-"),
lapply(strsplit(str, "-"), ansi_string)
)
str <- paste0(red, "-plain")
expect_equal(
ansi_strip(ansi_strsplit(str, "-")[[1]]),
strsplit(ansi_strip(str), "-")[[1]]
)
expect_equal(
ansi_strsplit(str, "e"),
list(ansi_string(c("\033[31mr\033[39m", "\033[31md\033[39m-plain")))
)
str <- paste0(red, "-", red, "-", red)
expect_equal(
ansi_strip(ansi_strsplit(str, "-")[[1]]),
strsplit(ansi_strip(str), "-")[[1]]
)
# with leading and trailing separators
str.2 <- paste0("-", red, "-", red, "-", red, "-")
expect_equal(ansi_strip(ansi_strsplit(str.2, "-")[[1]]),
strsplit(ansi_strip(str.2), "-")[[1]])
# greater than length 1
str.3 <- paste0("-", c(col_green("hello"), col_red("goodbye")), "-world-")
expect_equal(ansi_strip(unlist(ansi_strsplit(str.3, "-"))),
unlist(strsplit(ansi_strip(str.3), "-")))
})
test_that("ansi_strsplit multiple strings", {
withr::local_options(list(cli.num_colors = 256L))
red <- "\033[31mred\033[39m"
str <- c(
paste0("plain-plain-", red, "-plain-", red),
paste0(red, "-", red),
red
)
r1 <- lapply(ansi_strsplit(str, "-"), ansi_strip)
r2 <- strsplit(ansi_strip(str), "-")
expect_equal(r1, r2)
})
test_that("ansi_strsplit edge cases", {
withr::local_options(list(cli.num_colors = 256L))
expect_equal(ansi_strsplit("", "-"), list(ansi_string(character(0L))))
expect_equal(
ansi_strip(ansi_strsplit("\033[31m\033[39m", "-")[[1]]), character(0L)
)
# special cases
expect_equal(ansi_strsplit("", ""), lapply(strsplit("", ""), ansi_string))
expect_equal(
ansi_strsplit("a", "a"),
lapply(strsplit("a", "a"), ansi_string)
)
# this following test isn't working yet
expect_equal(
ansi_strsplit("a", ""),
lapply(strsplit("a", ""), ansi_string)
)
expect_equal(
ansi_strsplit("", "a"),
lapply(strsplit("", "a"), ansi_string)
)
# Longer strings
expect_identical(
ansi_strsplit(c("", "a", "aa"), "a"),
lapply(strsplit(c("", "a", "aa"), "a"), ansi_string)
)
expect_identical(
ansi_strsplit(c("abaa", "ababza"), "b."),
lapply(strsplit(c("abaa", "ababza"), "b."), ansi_string)
)
})
test_that("Weird length 'split'", {
withr::local_options(list(cli.num_colors = 256L))
expect_snapshot(
error = TRUE,
ansi_strsplit(c("ab", "bd"), c("b", "d"))
)
expect_identical(
ansi_strsplit("ab", NULL),
lapply(strsplit("ab", NULL), ansi_string)
)
expect_identical(
ansi_strsplit("ab", character(0L)),
lapply(strsplit("ab", character(0L)), ansi_string)
)
})
test_that("ansi_align", {
withr::local_options(list(cli.num_colors = 256L))
expect_equal(ansi_align(character()), ansi_string(character()))
expect_equal(ansi_align("", 0), ansi_string(""))
expect_equal(ansi_align(" ", 0), ansi_string(" "))
expect_equal(ansi_align(" ", 1), ansi_string(" "))
expect_equal(ansi_align(" ", 2), ansi_string(" "))
expect_equal(ansi_align("a", 1), ansi_string("a"))
expect_equal(ansi_align(letters, 1), ansi_string(letters))
expect_equal(ansi_align(letters, 0), ansi_string(letters))
expect_equal(ansi_align(letters, -1), ansi_string(letters))
expect_equal(ansi_align(letters, 2), ansi_string(paste0(letters, " ")))
expect_equal(
ansi_align(letters, 3, "center"),
ansi_string(paste0(" ", letters, " "))
)
expect_equal(
ansi_align(letters, 2, "right"),
ansi_string(paste0(" ", letters))
)
expect_equal(
ansi_align(c("foo", "foobar", "", "a"), 6, "left"),
ansi_string(c("foo ", "foobar", " ", "a ")))
expect_equal(
ansi_align(c("foo", "foobar", "", "a"), 6, "center"),
ansi_string(c(" foo ", "foobar", " ", " a ")))
expect_equal(
ansi_align(c("foo", "foobar", "", "a"), 6, "right"),
ansi_string(c(" foo", "foobar", " ", " a")))
# #54: alignment of wide characters
expect_equal(
ansi_align(c("foo", "\u6210\u4ea4\u65e5", "", "a"), 6, "left"),
ansi_string(c("foo ", "\u6210\u4ea4\u65e5", " ", "a ")))
expect_equal(
ansi_align(c("foo", "\u6210\u4ea4\u65e5", "", "a"), 6, "center"),
ansi_string(c(" foo ", "\u6210\u4ea4\u65e5", " ", " a ")))
expect_equal(
ansi_align(c("foo", "\u6210\u4ea4\u65e5", "", "a"), 6, "right"),
ansi_string(c(" foo", "\u6210\u4ea4\u65e5", " ", " a")))
})
test_that("stripping hyperlinks", {
withr::local_options(list(cli.hyperlink = TRUE))
x <- unclass(style_hyperlink("foo", "https://r-pkg.org"))
expect_equal(
ansi_strip(paste0("1111-", x, "-2222-", x, "-333")),
"1111-foo-2222-foo-333"
)
})
test_that("ansi_trimws", {
cases <- list(
list(character(), ansi_string(character())),
list(1, ansi_string(1)),
list("", ansi_string("")),
list("foo", ansi_string("foo")),
list(" foo ", ansi_string("foo")),
list(c("foo", "bar"), ansi_string(c("foo", "bar"))),
list(col_red(c(" colored ")), ansi_string(col_red("colored"))),
list(
paste0(" ", col_red(c(" colored ")), " "),
ansi_string(col_red("colored")))
)
for (case in cases) expect_equal(ansi_trimws(case[[1]]), case[[2]])
cases_left <- list(
list(character(), ansi_string(character())),
list(1, ansi_string(1)),
list("", ansi_string("")),
list("foo", ansi_string("foo")),
list(" foo ", ansi_string("foo ")),
list(c("foo", "bar"), ansi_string(c("foo", "bar"))),
list(col_red(c(" colored ")), ansi_string(col_red("colored "))),
list(
paste0(" ", col_red(c(" colored ")), " "),
ansi_string(paste0(col_red("colored "), " ")))
)
for (case in cases_left) {
expect_equal(ansi_trimws(case[[1]], "left"), case[[2]])
}
cases_right <- list(
list(character(), ansi_string(character())),
list(1, ansi_string(1)),
list("", ansi_string("")),
list("foo", ansi_string("foo")),
list(" foo ", ansi_string(" foo")),
list(c(" foo ", " bar "), ansi_string(c(" foo", " bar"))),
list(c("foo", "bar"), ansi_string(c("foo", "bar"))),
list(col_red(c(" colored ")), ansi_string(col_red(" colored"))),
list(
paste0(" ", col_red(c(" colored ")), " "),
ansi_string(paste0(" ", col_red(" colored"))))
)
for (case in cases_right) {
expect_equal(ansi_trimws(case[[1]], "right"), case[[2]])
}
})
test_that("ansi_strwrap simple", {
cases = list(
list(character(), character()),
list("", ""),
list("foo", "foo"),
list(1, "1"),
list(c("foo", "bar"), c("foo", "bar"))
)
for (case in cases) {
expect_equal(ansi_strwrap(case[[1]], 20), ansi_string(case[[2]]))
}
})
test_that("ansi_strwrap simple styled", {
cases = list(
list(col_red("foo"), col_red("foo")),
list(col_red(c("foo", "bar")), col_red(c("foo", "bar"))),
list(
paste0("foo", bg_red(" "), "bar"),
paste0("foo", bg_red(" "), "bar")
)
)
for (case in cases) {
expect_equal(ansi_strwrap(case[[1]], 20), ansi_string(case[[2]]))
}
})
test_that("ansi_strwrap", {
txt0 <- glue::glue_col("
{col_red Velit occaecat} quis culpa occaecat. {col_green Pariatur} \\
ad veniam pariatur {bg_blue consectetur}. Dolore aliquip et \\
{style_underline consequat Lorem consectetur} dolor. Irure id velit \\
proident elit veniam eu exercitation nisi laboris officia. Qui \\
{col_red sunt occaecat} cillum {col_red sit commodo sit. \\
Culpa} aliquip et consectetur ullamco aliqua Lorem laborum dolore. ")
txt <- paste0(txt0, "\n\t \n", txt0)
expect_equal(
ansi_strip(ansi_strwrap(txt0, 40)),
strwrap(ansi_strip(txt0), 40)
)
expect_equal(
ansi_strip(ansi_strwrap(txt, 40)),
strwrap(ansi_strip(txt), 40)
)
expect_equal(
ansi_strip(ansi_strwrap(txt, 40, indent = 2)),
strwrap(ansi_strip(txt), 40, indent = 2)
)
expect_equal(
ansi_strip(ansi_strwrap(txt, 40, exdent = 2)),
strwrap(ansi_strip(txt), 40, exdent = 2)
)
expect_equal(
ansi_strip(ansi_strwrap(txt, 40, indent = 2, exdent = 4)),
strwrap(ansi_strip(txt), 40, indent = 2, exdent = 4)
)
})
test_that("ansi_strwrap double width", {
expect_equal(
ansi_strwrap("\U0001F477 1 2 3", 4),
ansi_string(c("\U0001f477", "1 2", "3"))
)
})
test_that("ansi_strwrap newlines", {
expect_equal(
ansi_strwrap("\033[32mv\033[39m hello world.\nxxx"),
ansi_string("\033[32mv\033[39m hello world. xxx")
)
})
test_that("ansi_strwrap and \f edge cases", {
expect_equal(
ansi_strwrap("\033[32mfoo\fbar\033[39m"),
ansi_string(c("\033[32mfoo\033[39m", "\033[32mbar\033[39m"))
)
expect_equal(
ansi_strwrap("\033[32m\ffoo\f\033[39m"),
ansi_string(c("", "\033[32mfoo\033[39m", ""))
)
})
test_that_cli(configs = c("plain", "ansi"), "ansi_strtrim", {
withr::local_options(c(cli.unicode = FALSE))
setup_unicode_width_fix()
cases <- list(
list("", ansi_string("")),
list("1", ansi_string("1")),
list("123456789", ansi_string("123456789")),
list("1234567890", ansi_string("1234567890")),
list("12345678901", ansi_string("1234567...")),
list(
strrep("\u231A", 6),
ansi_string(paste0(strrep("\u231A", 3), "..."))),
list(col_red("1"), col_red("1")),
list(c("foo", NA, col_red("bar")), ansi_string(c("foo", NA, col_red("bar"))))
)
for (case in cases) expect_equal(ansi_strtrim(case[[1]], 10), case[[2]])
})
test_that("ansi_strtrim with zero-length ellipsis", {
expect_snapshot({
ansi_strtrim("12345", 1, ellipsis = "")
ansi_strtrim("12345", 3, ellipsis = "")
ansi_strtrim("12345", 5, ellipsis = "")
})
})
test_that("ansi_strtrim errors", {
expect_snapshot(
error = TRUE,
ansi_strtrim("foobar", -1)
)
})
test_that("ansi_strtrim edge cases", {
expect_snapshot({
ansi_strtrim("foobar", width = 3, ellipsis = "...")
ansi_strtrim("foobar", width = 2, ellipsis = "...")
ansi_strtrim("foobar", width = 1, ellipsis = "...")
ansi_strtrim("foobar", width = 0, ellipsis = "...")
})
})
test_that("ansi_columns", {
withr::local_options(c(cli.unicode = FALSE))
local_edition(3)
expect_equal(ansi_columns(character()), ansi_string(character()))
expect_snapshot_output(
cat(ansi_columns(paste("foo", 1:10), width = 40), sep = "\n")
)
txt60 <- strrep("1234567890", 6)
expect_snapshot_output(
cat(ansi_columns(txt60, width = 15), sep = "\n")
)
})
test_that_cli(configs = c("plain", "ansi"), "ansi_toupper", {
x <- paste0(
col_red("Red "),
"normal ",
style_bold(col_green("green"))
)
expect_snapshot(local({
cat_line(x)
cat_line(ansi_toupper(x))
}))
})
test_that_cli(configs = c("plain", "ansi"), "ansi_tolower", {
x <- paste0(
col_red("Red "),
"NORMAL ",
style_bold(col_green("grEeN"))
)
expect_snapshot(local({
cat_line(x)
cat_line(ansi_tolower(x))
}))
})
test_that_cli(configs = c("plain", "ansi"), "ansi_chartr", {
x <- paste0(
col_red("Red "),
"normal ",
style_bold(col_green("green"))
)
expect_snapshot(local({
cat_line(x)
cat_line(ansi_chartr(" R_", "-r*", x))
}))
})
cli/tests/testthat/test-non-breaking-space.R 0000644 0001762 0000144 00000000327 14143453131 020567 0 ustar ligges users
test_that("does not break", {
expect_snapshot(local({
withr::local_options(cli.width = 40)
str30 <- "123456789 123456789 1234567890"
cli_text(c(str30, "this\u00a0is\u00a0not\u00a0breaking"))
}))
})
cli/tests/testthat/test-lists.R 0000644 0001762 0000144 00000012473 14313063767 016302 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli(configs = c("plain", "unicode"), "ul", {
expect_snapshot(local({
lid <- cli_ul()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ol", {
expect_snapshot(local({
cli_div(theme = list(ol = list()))
lid <- cli_ol()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ul ul", {
expect_snapshot(local({
cli_div(
theme = list(
"ul ul" = list("list-style-type" = "-", "margin-left" = 2)
)
)
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ul ol", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ol ol", {
expect_snapshot(local({
cli_div(
theme = list(
"li" = list("margin-left" = 2),
"li li" = list("margin-left" = 2)
)
)
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ol ul", {
expect_snapshot(local({
cli_div(
theme = list(
ul = list("margin-left" = 2)
)
)
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "starting with an item", {
expect_snapshot(local({
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end()
cli_end()
}))
})
test_that_cli(configs = c("plain", "unicode"), "ol, with first item", {
expect_snapshot(local({
cli_div(theme = list(ol = list()))
lid <- cli_ol("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ul, with first item", {
expect_snapshot(local({
lid <- cli_ul("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "dl", {
expect_snapshot(local({
cli_div(theme = list(ul = list()))
lid <- cli_dl()
cli_li(c(this = "foo"))
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "dl dl", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_dl()
cli_li(c("a-a" = "1 1"))
cli_li(c("a-b" = "1 2", "a-c" = "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "dl ol", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ol()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "dl ul", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ul()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ol dl", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_ol()
cli_li("1")
lid2 <- cli_dl()
cli_li(c("a-a" = "1 1"))
cli_li(c("a-b" = "1 2", "a-c" = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "ul dl", {
expect_snapshot(local({
cli_div(
theme = list(
li = list("margin-left" = 2)
)
)
lid <- cli_ul()
cli_li("1")
lid2 <- cli_dl()
cli_li(c("a-a" = "1 1"))
cli_li(c("a-b" = "1 2", "a-c" = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
}))
})
test_that_cli(configs = c("plain", "unicode"), "dl, with first item", {
expect_snapshot(local({
cli_div(theme = list(ul = list()))
lid <- cli_dl(c(this = "foo"), .close = FALSE)
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
}))
})
test_that_cli(configs = "ansi", "styling pieces of a dl", {
expect_snapshot(local({
cli_div(
theme = list(
.dt = list(postfix = " -> "),
.dd = list(color = "blue")
)
)
cli_dl(c(foo = "bar", bar = "baz"))
}))
})
test_that("cli_dl edge cases", {
# invalid input
expect_snapshot(
error = TRUE,
cli_dl("foo", "must be a named character vector")
)
# empty dd
expect_snapshot(
cli_dl(c(abc = "foo", empty = "", def = "bar"))
)
})
test_that("cli_dl label style", {
expect_snapshot(local({
cli_dl(c(
"{.code code}" = "{.code this is code too}",
"{.str strin}" = "{.url https://x.com}"
))
}))
})
cli/tests/testthat/test-progress-handler-say.R 0000644 0001762 0000144 00000001373 14143453131 021177 0 ustar ligges users
test_that("say_out", {
px <- asNamespace("processx")$get_tool("px")
tmp <- tempfile("cli-test-")
on.exit(unlink(tmp), add = TRUE)
withr::local_options(
cli.progress_say_command = px,
cli.progress_say_args = c("writefile", tmp)
)
p <- say_out(" 70%")
expect_s3_class(p, "process")
p$wait(3000)
expect_false(p$is_alive())
p$kill()
expect_equal(readLines(tmp, warn = FALSE), " 70%")
})
test_that("say_update", {
withr::local_options(cli.progress_say_frequency = 1e-9)
mockery::stub(say_update, "say_out", function(text) text)
bar <- new.env(parent = emptyenv())
bar$current <- 10
bar$total <- NA
say_update(bar)
expect_equal(bar$say_proc, 10)
bar$total <- 50
say_update(bar)
expect_equal(bar$say_proc, " 20%")
})
cli/tests/testthat/test-format-conditions.R 0000644 0001762 0000144 00000007664 14313063774 020607 0 ustar ligges users
test_that_cli("format_error", {
expect_snapshot(error = TRUE, local({
n <- "boo"
stop(format_error(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
)))
}))
expect_snapshot(error = TRUE, local({
len <- 26
idx <- 100
stop(format_error(c(
"Must index an existing element:",
"i" = "There {?is/are} {len} element{?s}.",
"x" = "You've tried to subset element {idx}."
)))
}))
})
test_that_cli("format_warning", {
expect_snapshot({
n <- "boo"
warning(format_warning(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
)))
})
expect_snapshot(local({
len <- 26
idx <- 100
warning(format_warning(c(
"Must index an existing element:",
"i" = "There {?is/are} {len} element{?s}.",
"x" = "You've tried to subset element {idx}."
)))
}))
})
test_that_cli("format_message", {
expect_snapshot({
n <- "boo"
message(format_message(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
)))
})
expect_snapshot(local({
len <- 26
idx <- 100
message(format_message(c(
"Must index an existing element:",
"i" = "There {?is/are} {len} element{?s}.",
"x" = "You've tried to subset element {idx}."
)))
}))
})
test_that_cli(config = "ansi", "color in RStudio", {
mockery::stub(
get_rstudio_fg_color0,
"rstudio_detect",
list(type = "rstudio_console", num_colors = 256)
)
mockery::stub(
get_rstudio_fg_color0,
"get_rstudio_theme",
list(foreground = "rgb(0, 0, 0)")
)
expect_snapshot({
col <- get_rstudio_fg_color0()
cat(col("this is the new color"))
})
mockery::stub(
get_rstudio_fg_color0,
"get_rstudio_theme",
list()
)
expect_null(get_rstudio_fg_color0())
mockery::stub(
get_rstudio_fg_color0,
"rstudio_detect",
list(type = "rstudio_console", num_colors = 1)
)
expect_null(get_rstudio_fg_color0())
})
test_that_cli(config = "ansi", "update_rstudio_color", {
mockery::stub(
update_rstudio_color,
"get_rstudio_fg_color",
function() make_ansi_style("#008800")
)
expect_snapshot(cat(update_rstudio_color("color me interested")))
})
test_that("named first element", {
expect_snapshot(
format_error(c("*" = "foo", "*" = "bar"))
)
expect_snapshot(
format_warning(c("*" = "foo", "*" = "bar"))
)
})
test_that("no cli conditions are thrown", {
cnd <- NULL
withCallingHandlers({
format_error("error")
format_warning("warning")
format_message("message")
}, cli_message = function(cnd_) cnd <<- cnd_)
expect_null(cnd)
})
test_that("cli.condition_width", {
withr::local_options(cli.condition_width = 40, cli.num_colors = 1)
msg <- strrep("1234567890 ", 8)
expect_snapshot({
format_error(msg)
format_warning(msg)
format_message(msg)
})
withr::local_options(cli.condition_width = Inf)
expect_snapshot({
format_error(msg)
format_warning(msg)
format_message(msg)
})
})
test_that_cli("suppressing Unicode bullets", {
withr::local_options(cli.condition_unicode_bullets = FALSE)
expect_snapshot(error = TRUE, local({
n <- "boo"
stop(format_error(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector.",
"v" = "Success.",
"i" = "Info.",
"*" = "Bullet",
">" = "Arrow"
)))
}))
})
test_that("edge cases", {
expect_equal(cli::format_error(""), "")
expect_equal(cli::format_error(NULL), "")
expect_equal(cli::format_error(character()), "")
expect_equal(cli::format_warning(""), "")
expect_equal(cli::format_warning(NULL), "")
expect_equal(cli::format_warning(character()), "")
expect_equal(cli::format_message(""), "")
expect_equal(cli::format_message(NULL), "")
expect_equal(cli::format_message(character()), "")
})
cli/tests/testthat/test-alerts.R 0000644 0001762 0000144 00000001374 14143453131 016421 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("generic", {
expect_snapshot(local({
cli_div(theme = list(".alert" = list(before = "GENERIC! ")))
cli_alert("wow")
}))
})
test_that_cli("success", {
expect_snapshot(local({
cli_alert_success("wow")
}))
})
test_that_cli("danger", {
expect_snapshot(local({
cli_alert_danger("wow")
}))
})
test_that_cli("warning", {
expect_snapshot(local({
cli_alert_warning("wow")
}))
})
test_that_cli("info", {
expect_snapshot(local({
cli_alert_info("wow")
}))
})
test_that("before and after can have spaces", {
expect_snapshot(local({
cli_div(theme = list(.alert = list(before = "x ", after = " x")))
cli_alert("continuing that first alert", wrap = TRUE)
}))
})
cli/tests/testthat/test-hash.R 0000644 0001762 0000144 00000007435 14332665014 016063 0 ustar ligges users
test_that("hash_sha256", {
dig <- function(x) {
digest::digest(x, serialize = FALSE, algo = "sha256")
}
cases <- list(
list(character(), character()),
list("", dig("")),
list("x", dig("x")),
list(NA_character_, NA_character_),
list(NA, NA_character_),
list(
c(NA, "", "foo", NA),
c(NA, dig(""), dig("foo"), NA)
)
)
for (case in cases) {
expect_equal(hash_sha256(case[[1]]), case[[2]])
}
})
test_that("hash_raw_sha256", {
dig <- function(x) {
digest::digest(x, serialize = FALSE, algo = "sha256")
}
cases <- list(
list(raw(), dig(raw())),
list(as.raw(0), dig(as.raw(0))),
list(charToRaw("foobar"), dig("foobar"))
)
for (case in cases) {
expect_equal(hash_raw_sha256(case[[1]]), case[[2]])
}
})
test_that("hash_obj_sha256", {
dig <- function(x) {
digest::digest(x, serializeVersion = 2, algo = "sha256")
}
cases <- list(
"",
raw(0),
1:10,
mtcars
)
for (case in cases) {
expect_equal(hash_obj_sha256(case), dig(case))
}
})
test_that("hash_file_sha256", {
dig <- function(x) {
digest::digest(file = x, algo = "sha256")
}
f <- test_path("test-hash.R")
expect_equal(
hash_file_sha256(character()),
character()
)
expect_equal(hash_file_sha256(f), dig(f))
})
test_that("hash_md5", {
dig <- function(x) {
digest::digest(x, serialize = FALSE, algo = "md5")
}
cases <- list(
list(character(), character()),
list("", dig("")),
list("x", dig("x")),
list(NA_character_, NA_character_),
list(NA, NA_character_),
list(
c(NA, "", "foo", NA),
c(NA, dig(""), dig("foo"), NA)
)
)
for (case in cases) {
expect_equal(hash_md5(case[[1]]), case[[2]])
}
})
test_that("hash_raw_md5", {
dig <- function(x) {
digest::digest(x, serialize = FALSE, algo = "md5")
}
cases <- list(
list(raw(), dig(raw())),
list(as.raw(0), dig(as.raw(0))),
list(charToRaw("foobar"), dig("foobar"))
)
for (case in cases) {
expect_equal(hash_raw_md5(case[[1]]), case[[2]])
}
})
test_that("hash_obj_md5", {
dig <- function(x) {
digest::digest(x, serializeVersion = 2, algo = "md5")
}
cases <- list(
"",
raw(0),
1:10,
mtcars
)
for (case in cases) {
expect_equal(hash_obj_md5(case), dig(case))
}
})
test_that("hash_file_md5", {
dig <- function(x) {
digest::digest(file = x, algo = "md5")
}
f <- test_path("test-hash.R")
expect_equal(
hash_file_md5(character()),
character()
)
expect_equal(hash_file_md5(f), dig(f))
expect_equal(hash_file_md5(c(f, f)), c(dig(f), dig(f)))
})
test_that("hash_emoji", {
expect_snapshot({
hash_emoji(character())$names
hash_emoji("")$names
hash_emoji("x")$names
hash_emoji(NA_character_)$names
hash_emoji(NA)$names
hash_emoji(c(NA, "", "foo", NA))$names
})
})
test_that("hash_raw_emoji", {
expect_snapshot({
hash_raw_emoji(raw())$names
hash_raw_emoji(as.raw(0))$names
hash_raw_emoji(charToRaw("foobar"))$names
})
})
test_that("hash_obj_emoji", {
expect_snapshot({
hash_obj_emoji("")$names
hash_obj_emoji(raw(0))$names
hash_obj_emoji(1:10)$names
hash_obj_emoji(mtcars)$names
})
})
test_that("hash_animal", {
expect_snapshot({
hash_animal(character())$words
hash_animal("")$words
hash_animal("x")$words
hash_animal(NA_character_)$words
hash_animal(NA)$words
hash_animal(c(NA, "", "foo", NA))$words
})
})
test_that("hash_raw_animal", {
expect_snapshot({
hash_raw_animal(raw())$words
hash_raw_animal(as.raw(0))$words
hash_raw_animal(charToRaw("foobar"))$words
})
})
test_that("hash_obj_animal", {
expect_snapshot({
hash_obj_animal("")$words
hash_obj_animal(raw(0))$words
hash_obj_animal(1:10)$words
hash_obj_animal(mtcars)$words
})
})
cli/tests/testthat/test-box-styles.R 0000644 0001762 0000144 00000000252 14143453131 017232 0 ustar ligges users
test_that_cli(configs = c("plain", "unicode"), "list_border_styles", {
expect_snapshot(
for (st in list_border_styles()) print(boxx("", border_style = st))
)
})
cli/tests/testthat/test-package.R 0000644 0001762 0000144 00000001513 14301737210 016514 0 ustar ligges users
test_that("No leftover SVG figures", {
skip_on_cran()
skip_on_covr()
pkg_dir <- test_package_root()
figs <- dir(file.path(pkg_dir, "man", "figures"), pattern = "[.]svg$")
rd <- dir(file.path(pkg_dir, "man"), pattern = "[.]Rd$", full.names = TRUE)
rd_figs <- unlist(lapply(rd, function(x) {
grep("\\\\figure\\{", readLines(x), value = TRUE)
}))
rd_figs <- sub("^.*\\\\figure\\{(.*[.]svg).*$", "\\1", rd_figs)
expect_equal(
sort(figs),
sort(unique(rd_figs))
)
figs2 <- dir(file.path(pkg_dir, "man", "figures", "README"), pattern = "[.]svg$")
readme <- file.path(pkg_dir, "README.md")
readme_figs <- grep("man/figures/", readLines(readme), value = TRUE)
readme_figs <- sub("^.*man/figures/README/(.*[.]svg).*$", "\\1", readme_figs)
expect_equal(
sort(figs2),
sort(unique(readme_figs))
)
})
cli/tests/testthat/test-ansi-make.R 0000644 0001762 0000144 00000004155 14317007616 017002 0 ustar ligges users
test_that("make_style without name", {
pink <- make_ansi_style("pink")
expect_true(inherits(pink, "cli_ansi_style"))
})
test_that("hexa color regex works", {
positive <- c("#000000", "#ffffff", "#0f0f0f", "#f0f0f0",
"#00000000", "#ffffffff", "#0f0f0f00", "#f0f0f055")
negative <- c("", "#12345", "123456", "1234567", "12345678",
"#1234567", "#1234ffg", "#gggggx", "foo#123456",
"foo#123456bar")
for (color in positive) {
expect_true(grepl(hash_color_regex, color))
expect_true(grepl(hash_color_regex, toupper(color)))
}
for (color in negative) {
expect_false(grepl(hash_color_regex, color))
expect_false(grepl(hash_color_regex, toupper(color)))
}
})
test_that("we fall back for ANSI 8 if needed", {
yellow3 <- make_ansi_style("yellow3", colors = 8)
expect_equal(yellow3("foobar"), col_yellow("foobar"))
})
test_that("we can create a style from an R color", {
red4 <- make_ansi_style("red4")
red_text <- red4("text")
expect_true(num_ansi_colors() == 1 || ansi_has_any(red_text))
})
test_that("errors", {
expect_snapshot(
error = TRUE,
make_ansi_style(1:10)
)
})
test_that("make_ansi_style", {
withr::local_options(cli.num_colors = 256)
cf <- crayon::red
expect_equal(
make_ansi_style(cf)("foo"),
col_red("foo")
)
expect_equal(
make_ansi_style("dim")("foo"),
style_blurred("foo")
)
expect_equal(
make_ansi_style("red", bg = TRUE)("red"),
bg_red("red")
)
expect_equal(
make_ansi_style(cbind(c(200, 200, 100)), grey = TRUE)("200-200-100"),
ansi_string("\033[38;5;250m200-200-100\033[39m")
)
withr::local_options(cli.num_colors = truecolor)
expect_equal(
make_ansi_style(cbind(c(200, 200, 100)))("200-200-100"),
ansi_string("\033[38;2;200;200;100m200-200-100\033[39m")
)
expect_equal(
make_ansi_style(cbind(c(200, 200, 100)), bg = TRUE)("200-200-100"),
ansi_string("\033[48;2;200;200;100m200-200-100\033[49m")
)
# errors
expect_snapshot(
error = TRUE,
make_ansi_style(1:10)
)
expect_snapshot(
error = TRUE,
make_ansi_style("foobar")
)
})
cli/tests/testthat/progresstest/ 0000755 0001762 0000144 00000000000 14535436722 016602 5 ustar ligges users cli/tests/testthat/progresstest/NAMESPACE 0000644 0001762 0000144 00000000314 14143453131 020003 0 ustar ligges users # Generated by roxygen2: do not edit by hand
export(test_baseline)
export(test_cli)
export(test_cli_unroll)
export(test_modulo)
export(testx)
useDynLib(progresstest, .registration = TRUE, .fixes = "c_")
cli/tests/testthat/progresstest/DESCRIPTION 0000644 0001762 0000144 00000000502 14143453131 020271 0 ustar ligges users Package: progresstest
Title: Testing Terminal Progress Bars
Version: 1.0.0
Authors@R: person("Gabor", "Csardi", , "csardi.gabor@gmail.com", role = c("aut", "cre"))
Description: Test progress bars from the cli package.
License: MIT + file LICENSE
Imports:
cli
LinkingTo:
cli
RoxygenNote: 7.1.1.9001
Encoding: UTF-8
cli/tests/testthat/progresstest/src/ 0000755 0001762 0000144 00000000000 14406600132 017352 5 ustar ligges users cli/tests/testthat/progresstest/src/cleancall.c 0000644 0001762 0000144 00000010263 14143453131 021441 0 ustar ligges users #define R_NO_REMAP
#include
#include "cleancall.h"
#if (defined(R_VERSION) && R_VERSION < R_Version(3, 4, 0))
SEXP R_MakeExternalPtrFn(DL_FUNC p, SEXP tag, SEXP prot) {
fn_ptr ptr;
ptr.fn = p;
return R_MakeExternalPtr(ptr.p, tag, prot);
}
DL_FUNC R_ExternalPtrAddrFn(SEXP s) {
fn_ptr ptr;
ptr.p = R_ExternalPtrAddr(s);
return ptr.fn;
}
#endif
// The R API does not have a setter for function pointers
SEXP cleancall_MakeExternalPtrFn(DL_FUNC p, SEXP tag, SEXP prot) {
fn_ptr tmp;
tmp.fn = p;
return R_MakeExternalPtr(tmp.p, tag, prot);
}
void cleancall_SetExternalPtrAddrFn(SEXP s, DL_FUNC p) {
fn_ptr ptr;
ptr.fn = p;
R_SetExternalPtrAddr(s, ptr.p);
}
// Initialised at load time with the `.Call` primitive
SEXP cleancall_fns_dot_call = NULL;
void cleancall_init() {
cleancall_fns_dot_call = Rf_findVar(Rf_install(".Call"), R_BaseEnv);
}
struct eval_args {
SEXP call;
SEXP env;
};
static SEXP eval_wrap(void* data) {
struct eval_args* args = (struct eval_args*) data;
return Rf_eval(args->call, args->env);
}
SEXP cleancall_call(SEXP args, SEXP env) {
SEXP call = PROTECT(Rf_lcons(cleancall_fns_dot_call, args));
struct eval_args data = { call, env };
SEXP out = r_with_cleanup_context(&eval_wrap, &data);
UNPROTECT(1);
return out;
}
static SEXP callbacks = NULL;
// Preallocate a callback
static void push_callback(SEXP stack) {
SEXP top = CDR(stack);
SEXP early_handler = PROTECT(Rf_allocVector(LGLSXP, 1));
SEXP fn_extptr = PROTECT(cleancall_MakeExternalPtrFn(NULL, R_NilValue,
R_NilValue));
SEXP data_extptr = PROTECT(R_MakeExternalPtr(NULL, early_handler,
R_NilValue));
SEXP cb = Rf_cons(Rf_cons(fn_extptr, data_extptr), top);
SETCDR(stack, cb);
UNPROTECT(3);
}
struct data_wrapper {
SEXP (*fn)(void* data);
void *data;
SEXP callbacks;
int success;
};
static void call_exits(void* data) {
// Remove protecting node. Don't remove the preallocated callback on
// the top as it might contain a handler when something went wrong.
SEXP top = CDR(callbacks);
// Restore old stack
struct data_wrapper* state = data;
callbacks = (SEXP) state->callbacks;
// Handlers should not jump
while (top != R_NilValue) {
SEXP cb = CAR(top);
top = CDR(top);
void (*fn)(void*) = (void (*)(void*)) R_ExternalPtrAddrFn(CAR(cb));
void *data = (void*) R_ExternalPtrAddr(CDR(cb));
int early_handler = LOGICAL(R_ExternalPtrTag(CDR(cb)))[0];
// Check for empty pointer in preallocated callbacks
if (fn) {
if (!early_handler || !state->success) fn(data);
}
}
}
static SEXP with_cleanup_context_wrap(void *data) {
struct data_wrapper* cdata = data;
SEXP ret = cdata->fn(cdata->data);
cdata->success = 1;
return ret;
}
SEXP r_with_cleanup_context(SEXP (*fn)(void* data), void* data) {
// Preallocate new stack before changing `callbacks` to avoid
// leaving the global variable in a bad state if alloc fails
SEXP new = PROTECT(Rf_cons(R_NilValue, R_NilValue));
push_callback(new);
if (!callbacks) callbacks = R_NilValue;
SEXP old = callbacks;
callbacks = new;
struct data_wrapper state = { fn, data, old, 0 };
SEXP out = R_ExecWithCleanup(with_cleanup_context_wrap, &state,
&call_exits, &state);
UNPROTECT(1);
return out;
}
int r_cleancall_is_active() {
return callbacks != NULL;
}
static void call_save_handler(void (*fn)(void *data), void* data,
int early) {
if (!callbacks) {
fn(data);
Rf_error("Internal error: Exit handler pushed outside "
"of an exit context");
}
SEXP cb = CADR(callbacks);
// Update pointers
cleancall_SetExternalPtrAddrFn(CAR(cb), (DL_FUNC) fn);
R_SetExternalPtrAddr(CDR(cb), data);
LOGICAL(R_ExternalPtrTag(CDR(cb)))[0] = early;
// Preallocate the next callback in case the allocator jumps
push_callback(callbacks);
}
void r_call_on_exit(void (*fn)(void* data), void* data) {
call_save_handler(fn, data, /* early = */ 0);
}
void r_call_on_early_exit(void (*fn)(void* data), void* data) {
call_save_handler(fn, data, /* early = */ 1);
}
cli/tests/testthat/progresstest/src/cleancall.h 0000644 0001762 0000144 00000002743 14143453131 021452 0 ustar ligges users #ifndef CLEANCALL_H
#define CLEANCALL_H
#include
#include
#ifdef __cplusplus
extern "C" {
#endif
// --------------------------------------------------------------------
// Internals
// --------------------------------------------------------------------
typedef union {void* p; DL_FUNC fn;} fn_ptr;
#if (defined(R_VERSION) && R_VERSION < R_Version(3, 4, 0))
SEXP R_MakeExternalPtrFn(DL_FUNC p, SEXP tag, SEXP prot);
DL_FUNC R_ExternalPtrAddrFn(SEXP s);
#endif
// --------------------------------------------------------------------
// API for packages that embed cleancall
// --------------------------------------------------------------------
// The R API does not have a setter for external function pointers
SEXP cleancall_MakeExternalPtrFn(DL_FUNC p, SEXP tag, SEXP prot);
void cleancall_SetExternalPtrAddrFn(SEXP s, DL_FUNC p);
#define CLEANCALL_METHOD_RECORD \
{"cleancall_call", (DL_FUNC) &cleancall_call, 2}
SEXP cleancall_call(SEXP args, SEXP env);
extern SEXP cleancall_fns_dot_call;
void cleancall_init();
// --------------------------------------------------------------------
// Public API
// --------------------------------------------------------------------
#define R_CLEANCALL_SUPPORT 1
SEXP r_with_cleanup_context(SEXP (*fn)(void* data), void* data);
void r_call_on_exit(void (*fn)(void* data), void* data);
void r_call_on_early_exit(void (*fn)(void* data), void* data);
int r_cleancall_is_active();
#ifdef __cplusplus
}
#endif
#endif
cli/tests/testthat/progresstest/src/test.c 0000644 0001762 0000144 00000004541 14143453131 020504 0 ustar ligges users
#include
#include "cleancall.h"
#include
SEXP test0() {
int i;
int res = 0;
for (i = 0; i < 2000000000; i++) {
res += i % 2;
}
return ScalarInteger(res);
}
SEXP test00(SEXP progress) {
int i;
int res = 0;
int progress_ = LOGICAL(progress)[0];
for (i = 0; i < 2000000000; i++) {
if (i % 10000 == 0 && progress_) cli_progress_set(R_NilValue, i);
res += i % 2;
}
return ScalarInteger(res);
}
SEXP test1() {
int i;
int res = 0;
SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
for (i = 0; i < 2000000000; i++) {
if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
res += i % 2;
}
cli_progress_done(bar);
UNPROTECT(1);
return ScalarInteger(res);
}
SEXP testx() {
int i;
int res = 0;
SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
cli_progress_set_format(
bar,
"{%d} package{?s} {cli::pb_bar} | {cli::pb_elapsed}",
4
);
for (i = 0; i < 2000000000; i++) {
if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
res += i % 2;
}
cli_progress_done(bar);
UNPROTECT(1);
return ScalarInteger(res);
}
SEXP test2() {
int i = 0;
int res = 0;
SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
int s, final, step = 2000000000 / 100000;
for (s = 0; s < 100000; s++) {
if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
final = (s + 1) * step;
for (i = s * step; i < final; i++) {
res += i % 2;
}
}
cli_progress_done(bar);
UNPROTECT(1);
return ScalarInteger(res);
}
SEXP testc() {
int i;
int res = 0;
SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
for (i = 0; i < 2000000000; i++) {
if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
res += i % 2;
}
error("sorry, can't do this any more");
cli_progress_done(bar);
UNPROTECT(1);
return ScalarInteger(res);
}
static const R_CallMethodDef CallEntries[] = {
CLEANCALL_METHOD_RECORD,
{ "test0", (DL_FUNC) test0, 0 },
{ "test00", (DL_FUNC) test00, 1 },
{ "test1", (DL_FUNC) test1, 0 },
{ "test2", (DL_FUNC) test2, 0 },
{ "testx", (DL_FUNC) testx, 0 },
{ "testc", (DL_FUNC) testc, 0 },
{ NULL, NULL, 0 }
};
void R_init_progresstest(DllInfo *dll) {
R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);
R_useDynamicSymbols(dll, FALSE);
R_forceSymbols(dll, TRUE);
cleancall_fns_dot_call = Rf_findVar(Rf_install(".Call"), R_BaseEnv);
}
cli/tests/testthat/progresstest/R/ 0000755 0001762 0000144 00000000000 14143453131 016767 5 ustar ligges users cli/tests/testthat/progresstest/R/test.R 0000644 0001762 0000144 00000001226 14143453131 020072 0 ustar ligges users
#' @useDynLib progresstest, .registration = TRUE, .fixes = "c_"
NULL
#' @export
test_baseline <- function() {
.Call(c_test0)
}
#' @export
test_modulo <- function(progress = FALSE) {
.Call(c_test00, progress)
}
#' @export
test_cli <- function() {
.Call(c_test1)
}
#' @export
test_cli_unroll <- function() {
this <- "test2"
.Call(c_test2)
}
#' @export
testx <- function() {
this <- "testx"
.Call(c_testx)
}
test3 <- function() {
this <- "test3"
test2()
}
call_with_cleanup <- function(ptr, ...) {
.Call(c_cleancall_call, pairlist(ptr, ...), parent.frame())
}
testc <- function() {
this <- "testc"
call_with_cleanup(c_testc)
}
cli/tests/testthat/test-ansi.R 0000644 0001762 0000144 00000006530 14317007616 016066 0 ustar ligges users
test_that("Classes", {
expect_equal(class(style_underline("foo")), c("cli_ansi_string", "ansi_string", "character"))
})
test_that("Coloring and highlighting works", {
local_reproducible_output(crayon = TRUE)
expect_equal(c(style_underline("foo")), "\u001b[4mfoo\u001b[24m")
expect_equal(c(col_red("foo")), "\u001b[31mfoo\u001b[39m")
expect_equal(c(bg_red("foo")), "\u001b[41mfoo\u001b[49m")
})
test_that("Applying multiple styles at once works", {
local_reproducible_output(crayon = TRUE)
st <- combine_ansi_styles(col_red, bg_green, "underline")
expect_equal(
c(st("foo")),
"\u001b[31m\u001b[42m\u001b[4mfoo\u001b[24m\u001b[49m\u001b[39m")
st <- combine_ansi_styles(style_underline, "red", bg_green)
expect_equal(
c(st("foo")),
"\u001b[4m\u001b[31m\u001b[42mfoo\u001b[49m\u001b[39m\u001b[24m")
})
test_that("Nested styles are supported", {
local_reproducible_output(crayon = TRUE)
st <- combine_ansi_styles(style_underline, bg_blue)
expect_equal(
c(col_red("foo", st("bar"), "!")),
"\u001b[31mfoo\u001b[4m\u001b[44mbar\u001b[49m\u001b[24m!\u001b[39m")
})
test_that("Nested styles of the same type are supported", {
local_reproducible_output(crayon = TRUE)
expect_equal(
c(col_red("a", col_blue("b", col_green("c"), "b"), "c")),
"\u001b[31ma\u001b[34mb\u001b[32mc\u001b[34mb\u001b[31mc\u001b[39m")
})
test_that("Reset all styles", {
local_reproducible_output(crayon = TRUE)
st <- combine_ansi_styles("red", bg_green, "underline")
ok <- c(
paste0(
"\033[0m\033[31m\033[42m\033[4mfoo\033[24m\033[49m\033[39m",
"foo\033[0m\033[22m\033[23m\033[24m\033[27m\033[28m",
"\033[29m\033[39m\033[49m"),
paste0("\u001b[0m\u001b[31m\u001b[42m\u001b[4mfoo\u001b[24m\u001b[49m",
"\u001b[39mfoo\u001b[0m")
)
expect_true(style_reset(st("foo"), "foo") %in% ok)
})
test_that("Variable number of arguments", {
local_reproducible_output(crayon = TRUE)
expect_equal(c(col_red("foo", "bar")), "\u001b[31mfoobar\u001b[39m")
})
test_that("print.cli_ansi_style", {
expect_snapshot(
print(col_red)
)
})
test_that("print.cli_ansi_string", {
withr::local_options(cli.num_colors = 256)
expect_snapshot(
print(col_red("red"))
)
})
test_that("ansi-scale", {
expect_snapshot({
ansi_scale(c(0,0,0))
ansi_scale(c(255,100,0))
ansi_scale(c(255,100,0), round = FALSE)
})
})
test_that("zero length vectors", {
withr::local_options(cli.num_colors = 1)
expect_equal(length(col_cyan(character())), 0)
expect_equal(length(bg_cyan(character())), 0)
expect_equal(length(col_br_cyan(character())), 0)
expect_equal(length(bg_br_cyan(character())), 0)
withr::local_options(cli.num_colors = 8)
expect_equal(length(col_cyan(character())), 0)
expect_equal(length(bg_cyan(character())), 0)
expect_equal(length(col_br_cyan(character())), 0)
expect_equal(length(bg_br_cyan(character())), 0)
withr::local_options(cli.num_colors = 256)
expect_equal(length(col_cyan(character())), 0)
expect_equal(length(bg_cyan(character())), 0)
expect_equal(length(col_br_cyan(character())), 0)
expect_equal(length(bg_br_cyan(character())), 0)
withr::local_options(cli.num_colors = truecolor)
expect_equal(length(col_cyan(character())), 0)
expect_equal(length(bg_cyan(character())), 0)
expect_equal(length(col_br_cyan(character())), 0)
expect_equal(length(bg_br_cyan(character())), 0)
})
cli/tests/testthat/test-substitution.R 0000644 0001762 0000144 00000000260 14143453131 017674 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("glue errors", {
expect_error(cli_h1("foo { asdfasdfasdf } bar"))
expect_error(cli_text("foo {cmd {dsfsdf()}}"))
})
cli/tests/testthat/test-ansi-combine.R 0000644 0001762 0000144 00000001750 14143453131 017471 0 ustar ligges users
test_that("one style", {
testthat::skip_on_covr() # because we are comparing functions
expect_equal(
combine_ansi_styles(col_red),
col_red,
ignore_function_env = TRUE
)
expect_equal(
combine_ansi_styles(style_bold),
style_bold,
ignore_function_env = TRUE
)
})
test_that_cli(configs = c("plain", "ansi"), "style objects", {
expect_equal(
combine_ansi_styles(col_red, style_bold)("blah"),
col_red(style_bold("blah"))
)
expect_equal(
combine_ansi_styles(col_red, style_bold, style_underline)("foo"),
col_red(style_bold(style_underline("foo")))
)
})
test_that_cli(configs = c("plain", "ansi"), "create styles on the fly", {
expect_equal(
combine_ansi_styles("darkolivegreen", style_bold)("blah"),
make_ansi_style("darkolivegreen")((style_bold("blah")))
)
expect_equal(
combine_ansi_styles(style_bold, "darkolivegreen", style_underline)("foo"),
style_bold(make_ansi_style("darkolivegreen")(style_underline("foo")))
)
})
cli/tests/testthat/test-tree.R 0000644 0001762 0000144 00000006103 14143453131 016061 0 ustar ligges users
test_that_cli("tree", {
data <- data.frame(
stringsAsFactors = FALSE,
package = c("processx", "backports", "assertthat", "Matrix",
"magrittr", "rprojroot", "clisymbols", "prettyunits", "withr",
"desc", "igraph", "R6", "crayon", "debugme", "digest", "irlba",
"rcmdcheck", "callr", "pkgconfig", "lattice"),
dependencies = I(list(
c("assertthat", "crayon", "debugme", "R6"), character(0),
character(0), "lattice", character(0), "backports", character(0),
c("magrittr", "assertthat"), character(0),
c("assertthat", "R6", "crayon", "rprojroot"),
c("irlba", "magrittr", "Matrix", "pkgconfig"), character(0),
character(0), "crayon", character(0), "Matrix",
c("callr", "clisymbols", "crayon", "desc", "digest", "prettyunits",
"R6", "rprojroot", "withr"),
c("processx", "R6"), character(0), character(0)
))
)
expect_snapshot(tree(data))
expect_snapshot(tree(data, root = "desc"))
# Check that trees with apparent circularity error nicely
data <- data.frame(
stringsAsFactors = FALSE,
X = c("a", "b", "c","d", "e", "f", "g", "h", "j"),
Y = I(list(
c("b", "e", "f"),
c("d", "g"),
character(0),
c("a", "h"),
character(0),
character(0),
character(0),
c("j"),
character(0)
))
)
expect_warning(tree(data), "Endless loop found in tree: a -> b -> d -> a")
})
test_that_cli("trimming", {
pkgdeps <- list(
"dplyr@0.8.3" = c("assertthat@0.2.1", "glue@1.3.1", "magrittr@1.5",
"R6@2.4.0", "Rcpp@1.0.2", "rlang@0.4.0", "tibble@2.1.3",
"tidyselect@0.2.5"),
"assertthat@0.2.1" = character(),
"glue@1.3.1" = character(),
"magrittr@1.5" = character(),
"pkgconfig@2.0.3" = character(),
"R6@2.4.0" = character(),
"Rcpp@1.0.2" = character(),
"rlang@0.4.0" = character(),
"tibble@2.1.3" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
"pillar@1.4.2", "pkgconfig@2.0.3", "rlang@0.4.0"),
"cli@1.1.0" = c("assertthat@0.2.1", "crayon@1.3.4"),
"crayon@1.3.4" = character(),
"fansi@0.4.0" = character(),
"pillar@1.4.2" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
"rlang@0.4.0", "utf8@1.1.4", "vctrs@0.2.0"),
"utf8@1.1.4" = character(),
"vctrs@0.2.0" = c("backports@1.1.5", "ellipsis@0.3.0",
"digest@0.6.21", "glue@1.3.1", "rlang@0.4.0", "zeallot@0.1.0"),
"backports@1.1.5" = character(),
"ellipsis@0.3.0" = c("rlang@0.4.0"),
"digest@0.6.21" = character(),
"glue@1.3.1" = character(),
"zeallot@0.1.0" = character(),
"tidyselect@0.2.5" = c("glue@1.3.1", "purrr@1.3.1", "rlang@0.4.0",
"Rcpp@1.0.2"),
"purrr@0.3.3" = c("magrittr@1.5", "rlang@0.4.0")
)
pkgs <- data.frame(
stringsAsFactors = FALSE,
name = names(pkgdeps),
deps = I(unname(pkgdeps))
)
pkgs$label <- pkgs$name
pkgs$trimmed <- paste(pkgs$name, " (trimmed)")
expect_snapshot(tree(pkgs, trim = TRUE))
})
test_that("no warning for tibbles", {
data <- tibble::tibble(
package = c("A", "B", "C"),
dependencies = c("B", "C", "")
)
expect_silent(cli::tree(data))
})
cli/tests/testthat/test-rlang-errors.R 0000644 0001762 0000144 00000010462 14500305721 017540 0 ustar ligges users test_that_cli("cli_abort", {
withr::local_options(cli.theme_dark = FALSE)
expect_snapshot(error = TRUE, local({
n <- "boo"
cli_abort(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
))
}))
expect_snapshot(error = TRUE, local({
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}."
))
}))
n <- "boo"
err <- tryCatch(
cli_abort(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
)),
error = function(e) e
)
expect_snapshot(c(err$message, err$body))
})
test_that_cli("cli_warn", {
skip_if_not_installed("rlang", "1.0.0")
withr::local_options(cli.theme_dark = FALSE)
expect_snapshot({
n <- "boo"
cli_warn(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
))
})
expect_snapshot(local({
len <- 26
idx <- 100
cli_warn(c(
"Must index an existing element:",
"i" = "There {?is/are} {len} element{?s}.",
"x" = "You've tried to subset element {idx}."
))
}))
})
test_that_cli("cli_inform", {
skip_if_not_installed("rlang", "1.0.0")
withr::local_options(cli.ansi = FALSE)
expect_snapshot({
n <- "boo"
cli_inform(c(
"{.var n} must be a numeric vector",
"x" = "You've supplied a {.cls {class(n)}} vector."
))
})
expect_snapshot(local({
len <- 26
idx <- 100
cli_inform(c(
"Must index an existing element:",
"i" = "There {?is/are} {len} element{?s}.",
"x" = "You've tried to subset element {idx}."
))
}))
})
test_that("cli_abort width in RStudio", {
# this is to fix breakage with new testthat
withr::local_options(cli.condition_width = getOption("cli.width"))
mockery::stub(cli_abort, "rstudio_detect", list(type = "rstudio_console"))
withr::local_rng_version("3.5.0")
set.seed(42)
expect_snapshot(error = TRUE, local({
len <- 26
idx <- 100
cli_abort(c(
lorem_ipsum(1, 3),
"i" = lorem_ipsum(1, 3),
"x" = lorem_ipsum(1, 3)
))
}))
})
test_that_cli(config = "ansi", "color in RStudio", {
mockery::stub(
get_rstudio_fg_color0,
"rstudio_detect",
list(type = "rstudio_console", num_colors = 256)
)
mockery::stub(
get_rstudio_fg_color0,
"get_rstudio_theme",
list(foreground = "rgb(0, 0, 0)")
)
expect_snapshot({
col <- get_rstudio_fg_color0()
cat(col("this is the new color"))
})
mockery::stub(
get_rstudio_fg_color0,
"get_rstudio_theme",
list()
)
expect_null(get_rstudio_fg_color0())
mockery::stub(
get_rstudio_fg_color0,
"rstudio_detect",
list(type = "rstudio_console", num_colors = 1)
)
expect_null(get_rstudio_fg_color0())
})
test_that_cli(config = "ansi", "update_rstudio_color", {
mockery::stub(
update_rstudio_color,
"get_rstudio_fg_color",
function() make_ansi_style("#008800")
)
expect_snapshot(cat(update_rstudio_color("color me interested")))
})
test_that("cli_abort() captures correct call and backtrace", {
skip_on_cran()
rlang::local_options(
rlang_trace_top_env = environment(),
rlang_trace_format_srcrefs = FALSE
)
f <- function() g()
g <- function() h()
h <- function() cli::cli_abort("foo")
expect_snapshot({
print(expect_error(f()))
}, variant = paste0("rlang-", packageVersion("rlang")))
classed_stop <- function(message, env = parent.frame()) {
cli::cli_abort(
message,
.envir = env,
class = "cli_my_class"
)
}
h <- function(x) {
if (!length(x)) {
classed_stop("{.arg x} can't be empty.")
}
}
f <- function(x) g(x)
g <- function(x) h(x)
expect_snapshot({
print(expect_error(f(list())))
}, variant = paste0("rlang-", packageVersion("rlang")))
})
test_that("cli_abort(.internal = TRUE) reports the correct function (r-lib/rlang#1386)", {
skip_on_cran()
fn <- function() {
cli::cli_abort("Message.", .internal = TRUE)
}
environment(fn) <- rlang::ns_env("base")
# Should mention an internal error in the `base` package
expect_snapshot({
(expect_error(fn()))
}, variant = paste0("rlang-", packageVersion("rlang")))
})
cli/tests/testthat/test-rules.R 0000644 0001762 0000144 00000007532 14200445676 016274 0 ustar ligges users
test_that_cli("make_line", {
expect_equal(make_line(1, "-"), "-")
expect_equal(make_line(0, "-"), "")
expect_equal(make_line(2, "-"), "--")
expect_equal(make_line(10, "-"), "----------")
expect_equal(make_line(2, "12"), "12")
expect_equal(make_line(0, "12"), "")
expect_equal(make_line(1, "12"), "1")
expect_equal(make_line(9, "12"), "121212121")
expect_equal(make_line(10, "12"), "1212121212")
})
test_that("width option", {
expect_equal(
rule(width = 11, line = "-"),
rule_class("-----------")
)
})
test_that("left label", {
expect_equal(
rule("label", width = 12, line = "-"),
rule_class("-- label ---")
)
expect_equal(
rule("l", width = 12, line = "-"),
rule_class("-- l -------")
)
expect_equal(
rule("label", width = 9, line = "-"),
rule_class("-- label ")
)
expect_equal(
rule("label", width = 8, line = "-"),
rule_class("-- label")
)
expect_equal(
rule("label", width = 6, line = "-"),
rule_class("-- lab")
)
})
test_that("centered label", {
expect_error(
rule(left = "label", center = "label"),
"cannot be specified"
)
expect_error(
rule(center = "label", right = "label"),
"cannot be specified"
)
expect_equal(
rule(center = "label", width = 13, line = "-"),
rule_class("--- label ---")
)
expect_equal(
rule(center = "label", width = 14, line = "-"),
rule_class("---- label ---")
)
expect_equal(
rule(center = "label", width = 9, line = "-"),
rule_class("- label -")
)
expect_equal(
rule(center = "label", width = 8, line = "-"),
rule_class("- labe -")
)
expect_equal(
rule(center = "label", width = 7, line = "-"),
rule_class("- lab -")
)
})
test_that("right label", {
expect_equal(
rule(right = "label", width = 12, line = "-"),
rule_class("--- label --")
)
expect_equal(
rule(right = "l", width = 12, line = "-"),
rule_class("------- l --")
)
expect_equal(
rule(right = "label", width = 9, line = "-"),
rule_class(" label --")
)
expect_equal(
rule(right = "label", width = 8, line = "-"),
rule_class(" label -")
)
expect_equal(
rule(right = "label", width = 6, line = "-"),
rule_class(" label")
)
expect_equal(
rule(right = "label", width = 5, line = "-"),
rule_class(" labe")
)
expect_equal(
rule(right = "label", width = 4, line = "-"),
rule_class(" lab")
)
})
test_that("line_col", {
withr::with_options(
list(cli.num_colors = 256L), {
expect_true(ansi_has_any(
rule(line_col = "red")
))
expect_true(ansi_has_any(
rule(left = "left", line_col = "red")
))
expect_true(ansi_has_any(
rule(left = "left", right = "right", line_col = "red")
))
expect_true(ansi_has_any(
rule(center = "center", line_col = "red")
))
expect_true(ansi_has_any(
rule(right = "right", line_col = "red")
))
expect_true(ansi_has_any(
rule(line_col = col_red)
))
}
)
})
test_that_cli("get_line_char", {
expect_equal(get_line_char(1), cli::symbol$line)
expect_equal(get_line_char(2), cli::symbol$double_line)
expect_equal(get_line_char("bar1"), cli::symbol$lower_block_1)
expect_equal(get_line_char("bar2"), cli::symbol$lower_block_2)
expect_equal(get_line_char("bar3"), cli::symbol$lower_block_3)
expect_equal(get_line_char("bar4"), cli::symbol$lower_block_4)
expect_equal(get_line_char("bar5"), cli::symbol$lower_block_5)
expect_equal(get_line_char("bar6"), cli::symbol$lower_block_6)
expect_equal(get_line_char("bar7"), cli::symbol$lower_block_7)
expect_equal(get_line_char("bar8"), cli::symbol$lower_block_8)
expect_equal(get_line_char("xxx"), "xxx")
expect_equal(get_line_char(c("x", "y", "z")), "xyz")
})
test_that("print.cli_rule", {
withr::local_options(cli.width = 20)
expect_snapshot(rule("foo"))
})
cli/tests/testthat/test-progress-utils.R 0000644 0001762 0000144 00000002051 14143453131 020122 0 ustar ligges users
test_that("cli_progress_num", {
withr::local_options(cli.progress_handlers_only = "cli")
fun <- function() {
before <- cli_progress_num()
cli_progress_bar()
after <- cli_progress_num()
expect_equal(before + 1, after)
}
capture_cli_messages(fun())
})
test_that("cli_progress_cleanup", {
fun <- function() {
num <- NULL
cli::cli_progress_bar()
fun2 <- function() {
cli::cli_progress_bar()
cli::cli_progress_cleanup()
num <<- cli::cli_progress_num()
}
fun2()
}
out <- callr::r(fun)
expect_equal(out, 0L)
})
test_that("should_run_progress_examples", {
withr::local_envvar(NOT_CRAN = "true")
expect_true(should_run_progress_examples())
mockery::stub(should_run_progress_examples, "is_rcmd_check", TRUE)
expect_false(should_run_progress_examples())
})
test_that("is_rcmd_check", {
withr::local_envvar(NOT_CRAN = NA, "_R_CHECK_PACKAGE_NAME_" = NA)
expect_false(is_rcmd_check())
withr::local_envvar(NOT_CRAN = NA, "_R_CHECK_PACKAGE_NAME_" = "cli")
expect_true(is_rcmd_check())
})
cli/tests/testthat/test-ansi-palette.R 0000644 0001762 0000144 00000001726 14317007616 017524 0 ustar ligges users
test_that("ansi_palette_show", {
local_clean_cli_context()
expect_snapshot(
ansi_palette_show(colors = truecolor)
)
withr::local_options(cli.palette = "iterm-snazzy")
expect_snapshot(
ansi_palette_show(colors = truecolor)
)
})
test_that("error", {
expect_snapshot(
error = TRUE,
withr::with_options(
list(cli.palette = "foobar12"),
ansi_palette_show(colors = 256)
)
)
})
test_that("custom palettes", {
withr::local_options(
cli.num_colors = 256,
cli.palette = "iterm-snazzy"
)
expect_snapshot({
col_black("black")
col_red("red")
col_green("green")
col_yellow("yellow")
col_blue("blue")
col_magenta("magenta")
col_cyan("cyan")
col_white("white")
col_br_black("br_black")
col_br_red("br_red")
col_br_green("br_green")
col_br_yellow("br_yellow")
col_br_blue("br_blue")
col_br_magenta("br_magenta")
col_br_cyan("br_cyan")
col_br_white("br_white")
})
})
cli/tests/testthat/test-collapsing.R 0000644 0001762 0000144 00000012321 14521175065 017263 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("collapsing without formatting, n>3", {
expect_snapshot({
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {pkgs}.")
})
})
test_that("collapsing without formatting, n<3", {
expect_snapshot({
pkgs <- paste0("pkg", 1:2)
cli_text("Packages: {pkgs}.")
})
})
test_that("collapsing with formatting", {
expect_snapshot(local({
cli_div(theme = list(".pkg" = list(fmt = function(x) paste0(x, " (P)"))))
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {.pkg {pkgs}}.")
}))
})
test_that("collapsing with formatting, custom seps", {
expect_snapshot(local({
cli_div(theme = list(div = list("vec-sep" = " ... ")))
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {.pkg {pkgs}}.")
}))
})
test_that("collapsing a cli_vec", {
expect_snapshot({
pkgs <- cli_vec(
paste0("pkg", 1:5),
style = list("vec-sep" = " & ", "vec-last" = " & ")
)
cli_text("Packages: {pkgs}.")
})
})
test_that_cli(configs = c("plain", "ansi"), "collapsing a cli_vec with styling", {
expect_snapshot(local({
cli_div(theme = list(body = list("vec-sep" = " ... ")))
pkgs <- cli_vec(
paste0("pkg", 1:5),
style = list("vec-sep" = " & ", "vec-last" = " & ", color = "blue")
)
cli_text("Packages: {pkgs}.")
}))
})
test_that("head", {
v <- function(n, t = 5) {
cli_vec(
seq_len(n),
style = list("vec-trunc-style" = "head", "vec-trunc" = t)
)
}
expect_snapshot({
cli_text("{v(0,1)}")
cli_text("{v(1,1)}")
cli_text("{v(2,1)}")
cli_text("{v(3,1)}")
cli_text("{v(4,1)}")
cli_text("{v(0,2)}")
cli_text("{v(1,2)}")
cli_text("{v(2,2)}")
cli_text("{v(3,2)}")
cli_text("{v(4,2)}")
cli_text("{v(0,3)}")
cli_text("{v(1,3)}")
cli_text("{v(2,3)}")
cli_text("{v(3,3)}")
cli_text("{v(4,3)}")
cli_text("{v(0,4)}")
cli_text("{v(1,4)}")
cli_text("{v(2,4)}")
cli_text("{v(3,4)}")
cli_text("{v(4,4)}")
cli_text("{v(0,5)}")
cli_text("{v(1,5)}")
cli_text("{v(2,5)}")
cli_text("{v(3,5)}")
cli_text("{v(4,5)}")
cli_text("{v(10,5)}")
})
})
test_that("both-ends", {
v <- function(n, t = 5) {
cli_vec(
seq_len(n),
style = list("vec-trunc-style" = "both-ends", "vec-trunc" = t)
)
}
expect_snapshot({
cli_text("{v(0,1)}")
cli_text("{v(1,1)}")
cli_text("{v(2,1)}")
cli_text("{v(3,1)}")
cli_text("{v(4,1)}")
cli_text("{v(5,1)}")
cli_text("{v(6,1)}")
cli_text("{v(7,1)}")
cli_text("{v(10,1)}")
})
})
test_that_cli(config = c("plain", "ansi"), "both-ends with formatting", {
v <- function(n, t = 5) {
cli_vec(
seq_len(n),
style = list("vec-trunc-style" = "both-ends", "vec-trunc" = t)
)
}
expect_snapshot({
cli_text("{.val {v(0,1)}}")
cli_text("{.val {v(1,1)}}")
cli_text("{.val {v(2,1)}}")
cli_text("{.val {v(3,1)}}")
cli_text("{.val {v(4,1)}}")
cli_text("{.val {v(5,1)}}")
cli_text("{.val {v(6,1)}}")
cli_text("{.val {v(7,1)}}")
cli_text("{.val {v(10,1)}}")
cli_text("{.val {v(10,6)}}")
cli_text("{.val {v(10,10)}}")
cli_text("{.val {v(11,10)}}")
})
})
test_that("ansi_collapse", {
l10 <- letters[1:10]
expect_snapshot({
ansi_collapse(l10)
ansi_collapse(l10, trunc = 6)
ansi_collapse(l10, trunc = 5)
ansi_collapse(l10, trunc = 4)
ansi_collapse(l10, trunc = 1)
ansi_collapse(l10, sep = "; ")
ansi_collapse(l10, sep = "; ", last = "; or ")
ansi_collapse(l10, sep = "; ")
ansi_collapse(l10, sep = "; ", last = "; or ", trunc = 6)
ansi_collapse(l10, style = "head")
ansi_collapse(l10, trunc = 6, style = "head")
ansi_collapse(l10, trunc = 5, style = "head")
ansi_collapse(l10, trunc = 4, style = "head")
ansi_collapse(l10, trunc = 1, style = "head")
ansi_collapse(l10, sep = "; ", style = "head")
ansi_collapse(l10, sep = "; ", last = "; or ", style = "head")
ansi_collapse(l10, sep = "; ", last = "; or ", trunc = 6, style = "head")
})
})
test_that("ansi_collapse with width trimming", {
l10 <- letters[1:10]
expect_snapshot({
ansi_collapse(l10, width = 1, style = "head")
ansi_collapse(l10, width = 2, style = "head")
ansi_collapse(l10, width = 3, style = "head")
ansi_collapse(l10, width = 4, style = "head")
ansi_collapse(l10, width = 5, style = "head")
ansi_collapse(l10, width = 6, style = "head")
ansi_collapse(l10, width = 7, style = "head")
ansi_collapse(l10, width = 8, style = "head")
ansi_collapse(l10, width = 9, style = "head")
ansi_collapse(l10, width = 30, style = "head")
ansi_collapse(l10, width = 31, style = "head")
ansi_collapse(l10, width = 32, style = "head")
ansi_collapse(l10, width = 40, style = "head")
})
expect_snapshot({
ansi_collapse(l10, width = 10, style = "both-ends")
})
})
test_that("ansi_collapse produces consistent truncation results", {
expect_equal(ansi_collapse(1:2, trunc = 1, style = "head"),
ansi_collapse(1:2, trunc = 0, style = "head"))
})
test_that("ansi_collapse uses `sep2` for length-two inputs", {
expect_equal(ansi_collapse(1:2),
"1 and 2")
expect_equal(ansi_collapse(1:2, trunc = 2, style = "head"),
"1 and 2")
})
cli/tests/testthat/test-suppress.R 0000644 0001762 0000144 00000000763 14143453131 017014 0 ustar ligges users
test_that("suppress output", {
if (getRversion() >= "4.0.0") {
cnd <- NULL
tryCatch(
suppressMessages(cli_text("foo"), "cliMessage"),
message = function(cnd2) cnd <<- cnd2
)
expect_null(cnd)
}
mysuppress <- function(expr) {
withCallingHandlers(
expr,
cliMessage = function(msg) invokeRestart("muffleMessage")
)
}
cnd <- NULL
tryCatch(
mysuppress(cli_text("foo")),
message = function(cnd2) cnd <<- cnd2
)
expect_null(cnd)
})
cli/tests/testthat/test-progress-types.R 0000644 0001762 0000144 00000010210 14143453131 020122 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("iterator", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.spinner = NULL,
cli.spinner_unicode = NULL,
cli.progress_format_iterator = NULL,
cli.progress_format_iterator_nototal= NULL
)
fun <- function() {
cli_progress_bar(type = "iterator", total = 100)
cli_progress_update(set = 50, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
fun <- function() {
cli_progress_bar(type = "iterator", total = NA)
cli_progress_update(set = 50, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
})
test_that("tasks", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.spinner = NULL,
cli.spinner_unicode = NULL,
cli.progress_format_tasks = NULL,
cli.progress_format_tasks_nototal= NULL
)
fun <- function() {
cli_progress_bar(type = "tasks", total = 100)
cli_progress_update(set = 50, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
fun <- function() {
cli_progress_bar(type = "tasks", total = NA)
cli_progress_update(set = 50, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
})
test_that("download", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.spinner = NULL,
cli.spinner_unicode = NULL,
cli.progress_format_download = NULL,
cli.progress_format_download_nototal= NULL
)
fun <- function() {
cli_progress_bar(type = "download", total = 1024 * 1024)
cli_progress_update(set = 52 * 1024, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
fun <- function() {
cli_progress_bar(type = "download", total = NA)
cli_progress_update(set = 52 * 1024, force = TRUE)
}
out <- fix_times(capture_cli_messages(fun()))
expect_snapshot(out)
})
test_that("customize with options, iterator", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.progress_format_iterator = "new format {cli::pb_current}",
cli.progress_format_iterator_nototal = NULL
)
fun <- function(type, total, set = 50) {
cli_progress_bar(type = type, total = total)
cli_progress_update(set = set, force = TRUE)
}
expect_snapshot(capture_cli_messages(fun("iterator", 100)))
expect_snapshot(capture_cli_messages(fun("iterator", NA)))
withr::local_options(
cli.progress_format_iterator_nototal = "new too {cli::pb_current}"
)
expect_snapshot(capture_cli_messages(fun("iterator", 100)))
expect_snapshot(capture_cli_messages(fun("iterator", NA)))
})
test_that("customize with options, tasks", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.progress_format_tasks = "new format {cli::pb_current}",
cli.progress_format_tasks_nototal = NULL
)
fun <- function(type, total, set = 50) {
cli_progress_bar(type = type, total = total)
cli_progress_update(set = set, force = TRUE)
}
expect_snapshot(capture_cli_messages(fun("tasks", 100)))
expect_snapshot(capture_cli_messages(fun("tasks", NA)))
withr::local_options(
cli.progress_format_tasks_nototal = "new too {cli::pb_current}"
)
expect_snapshot(capture_cli_messages(fun("tasks", 100)))
expect_snapshot(capture_cli_messages(fun("tasks", NA)))
})
test_that("customize with options, download", {
withr::local_options(
cli.dynamic = TRUE,
cli.ansi = TRUE,
cli.progress_format_download = "new format {cli::pb_current_bytes}",
cli.progress_format_download_nototal = NULL
)
fun <- function(type, total, set = 50) {
cli_progress_bar(type = type, total = total)
cli_progress_update(set = set, force = TRUE)
}
expect_snapshot(capture_cli_messages(fun("download", 1024 * 1024, 512 * 1024)))
expect_snapshot(capture_cli_messages(fun("download", NA, 512 * 1024)))
withr::local_options(
cli.progress_format_download_nototal = "new too {cli::pb_current_bytes}"
)
expect_snapshot(capture_cli_messages(fun("download", 1024 * 1024, 512 * 1024)))
expect_snapshot(capture_cli_messages(fun("download", NA, 512 * 1024)))
})
cli/tests/testthat/test-pluralization.R 0000644 0001762 0000144 00000005203 14143453131 020017 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("simplest", {
expect_snapshot({
for (n in 0:2) cli_text("{n} package{?s}")
for (n in 0:2) print(pluralize("{n} package{?s}"))
})
})
test_that("irregular", {
expect_snapshot({
for (n in 0:2) cli_text("{n} dictionar{?y/ies}")
for (n in 0:2) print(pluralize("{n} dictionar{?y/ies}"))
})
})
test_that("multiple substitutions", {
expect_snapshot({
for (n in 0:2) cli_text("{n} package{?s} {?is/are} ...")
for (n in 0:2) print(pluralize("{n} package{?s} {?is/are} ..."))
})
})
test_that("multiple quantities", {
expect_snapshot({
for (m in 0:2) for (n in 0:2) cli_text("{m} package{?s} and {n} folder{?s}")
for (m in 0:2) for (n in 0:2) print(pluralize("{m} package{?s} and {n} folder{?s}"))
})
})
test_that("no()", {
expect_snapshot({
for (n in 0:2) cli_text("{no(n)} package{?s}")
for (n in 0:2) print(pluralize("{no(n)} package{?s}"))
})
})
test_that("set qty() explicitly", {
expect_snapshot({
for (n in 0:2) cli_text("{qty(n)}There {?is/are} {n} package{?s}")
for (n in 0:2) print(pluralize("{qty(n)}There {?is/are} {n} package{?s}"))
})
})
test_that("collapsing vectors", {
expect_snapshot({
pkgs <- function(n) glue::glue("pkg{seq_len(n)}")
for (n in 1:3) cli_text("The {pkgs(n)} package{?s}")
for (n in 1:3) print(pluralize("The {pkgs(n)} package{?s}"))
})
})
test_that("pluralization and style", {
expect_snapshot({
special_style <- list(span.foo = list(before = "<", after = ">"))
cli_div(theme = special_style)
for (n in 0:2) cli_text("{n} {.foo package{?s}}")
})
expect_snapshot({
pkgs <- function(n) glue::glue("pkg{seq_len(n)}")
for (n in 1:3) cli_text("The {.foo {pkgs(n)}} package{?s}")
})
})
test_that("post-processing", {
expect_snapshot({
for (n in 0:2) cli_text("Package{?s}: {n}")
})
expect_snapshot({
pkgs <- function(n) glue::glue("pkg{seq_len(n)}")
for (n in 1:2) cli_text("Package{?s}: {pkgs(n)}")
for (n in 1:2) print(pluralize("Package{?s}: {pkgs(n)}"))
})
})
test_that("post-processing errors", {
expect_error(
cli_text("package{?s}"),
"Cannot pluralize without a quantity"
)
expect_error(
pluralize("package{?s}"),
"Cannot pluralize without a quantity"
)
expect_error(
cli_text("package{?s} {5} {10}"),
"Multiple quantities for pluralization"
)
expect_error(
pluralize("package{?s} {5} {10}"),
"Multiple quantities for pluralization"
)
})
test_that("issue 158", {
expect_snapshot({
print(pluralize("{0} word{?A/B/}"))
print(pluralize("{1} word{?A/B/}"))
print(pluralize("{9} word{?A/B/}"))
})
})
cli/tests/testthat/test-headers.R 0000644 0001762 0000144 00000001065 14317007616 016545 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that_cli("headers", {
expect_snapshot(local({
cli_div(class = "testcli", theme = test_style())
cli_h1("HEADER")
cli_h2("Header")
cli_h3("Header")
x <- "foobar"
xx <- 100
cli_h2("{xx}. header: {x}")
}), variant = if (packageVersion("testthat") <= "3.1.4") "old" else "new")
})
test_that("issue #218", {
expect_snapshot({
cli_h1("one {1} two {2} three {3}")
cli_h2("one {1} two {2} three {3}")
}, variant = if (packageVersion("testthat") <= "3.1.4") "old" else "new")
})
cli/tests/testthat/progress-2.c 0000644 0001762 0000144 00000000465 14143453131 016176 0 ustar ligges users
#include
#include
SEXP clitest__init_timer() {
int before = CLI_SHOULD_TICK;
cli_progress_init_timer();
int after = CLI_SHOULD_TICK;
SEXP ret = PROTECT(Rf_allocVector(INTSXP, 2));
INTEGER(ret)[0] = before;
INTEGER(ret)[1] = after;
UNPROTECT(1);
return ret;
}
cli/tests/testthat/test-custom-handler.R 0000644 0001762 0000144 00000000645 14143453131 020054 0 ustar ligges users
test_that("custom handler works", {
conds <- list()
withr::with_options(
list(cli.default_handler = function(msg) conds <<- c(conds, list(msg))),
{ cli_h1("title"); cli_h2("subtitle"); cli_text("text") }
)
expect_equal(length(conds), 3)
lapply(conds, expect_s3_class, "cli_message")
expect_equal(conds[[1]]$type, "h1")
expect_equal(conds[[2]]$type, "h2")
expect_equal(conds[[3]]$type, "text")
})
cli/tests/testthat/helper.R 0000644 0001762 0000144 00000012462 14331172227 015434 0 ustar ligges users
rule_class <- function(x) {
structure(x, class = c("cli_rule", "rule", "cli_ansi_string", "ansi_string", "character"))
}
capture_msgs <- function(expr) {
msgs <- character()
i <- 0
suppressMessages(withCallingHandlers(
expr,
message = function(e) msgs[[i <<- i + 1]] <<- conditionMessage(e)))
paste0(msgs, collapse = "")
}
capture_cli_messages <- function(expr) {
msgs <- character()
withCallingHandlers(
expr,
cliMessage = function(e) {
msgs <<- c(msgs, conditionMessage(e))
invokeRestart("muffleMessage")
}
)
msgs
}
capt <- function(expr, print_it = TRUE) {
pr <- if (print_it) print else identity
paste(capture.output(pr(expr)), collapse = "\n")
}
capt0 <- function(expr, strip_style = FALSE) {
out <- capture_msgs(expr)
if (strip_style) ansi_strip(out) else out
}
local_cli_config <- function(unicode = FALSE, dynamic = FALSE,
ansi = FALSE, num_colors = 1,
.local_envir = parent.frame()) {
withr::local_options(
cli.dynamic = dynamic,
cli.ansi = ansi,
cli.unicode = unicode,
crayon.enabled = num_colors > 1,
crayon.colors = num_colors,
.local_envir = .local_envir
)
withr::local_envvar(
PKG_OMIT_TIMES = "true",
PKG_OMIT_SIZES = "true",
.local_envir = .local_envir
)
}
test_style <- function() {
list(
".testcli h1" = list(
"font-weight" = "bold",
"font-style" = "italic",
"margin-top" = 1,
"margin-bottom" = 1),
".testcli h2" = list(
"font-weight" = "bold",
"margin-top" = 1,
"margin-bottom" = 1),
".testcli h3" = list(
"text-decoration" = "underline",
"margin-top" = 1)
)
}
fix_times <- function(out) {
out <- sub("[(][ ]*[.0-9]+ [Mk]B/s[)]", "(8.5 MB/s)", out)
out <- sub("[(][.0-9]+/s[)]", "(100/s)", out)
out <- sub(" [.0-9]+(ms|s|m)", " 3ms", out)
out <- sub("ETA:[ ]*[.0-9]+m?s", "ETA: 1s", out)
out <- gsub("\\[[.0-9]+m?s\\]", "[1s]", out)
out
}
fix_logger_output <- function(lines) {
sub(
paste0(
"^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T",
"[0-9][0-9]:[0-9][0-9]:[0-9][0-9]\\+00:00 ",
"cli-[0-9]+-[0-9]+ "
),
"2021-06-18T00:09:14+00:00 cli-36434-1 ",
lines
)
}
make_c_function <- function(file = NULL,
code = NULL,
args = character(),
type = c(".c", ".cpp"),
header = NULL,
linkingto = packageName(),
quiet = Sys.getenv("TESTTHAT") == "true") {
type <- match.arg(type)
# Create source file
dir.create(dir <- tempfile())
if (is.null(file)) {
lines <- create_c_function_call(code, args, header = header)
} else {
lines <- readLines(file)
}
src <- basename(tempfile(fileext = type))
writeLines(lines, file.path(dir, src))
# Compile
cflags <- ""
for (pkg in linkingto) {
pkgdir <- file.path(find.package(pkg), "include")
lcldir <- file.path(find.package(pkg), "inst", "include")
cflags <- paste(cflags, "-I", pkgdir, "-I", lcldir)
}
env <- c(PKG_CFLAGS = cflags)
callr::rcmd(
"SHLIB",
src,
wd = file.path(dir),
env = env,
echo = !quiet,
show = !quiet
)
# Load DLL
dllfile <- file.path(dir, sub("[.]c(pp)?$", .Platform$dynlib.ext, src))
dll <- dyn.load(dllfile, local = TRUE, now = TRUE)
# TODO: finalizer to unload/delete
dll
}
create_c_function_call <- function(code, args, header = NULL) {
c(
"#include ",
header,
"SEXP tmp_c_function(",
if (length(args) > 0) paste0("SEXP ", args, collapse = ", "),
") {",
code,
"}\n"
)
}
win2unix <- function (str) {
gsub("\r\n", "\n", str, fixed = TRUE, useBytes = TRUE)
}
st_from_bel <- function(x) {
gsub("\007", "\033\\", x, fixed = TRUE)
}
st_to_bel <- function(x) {
gsub("\033\\", "\007", x, fixed = TRUE)
}
test_package_root <- function() {
x <- tryCatch(
rprojroot::find_package_root_file(),
error = function(e) NULL)
if (!is.null(x)) return(x)
pkg <- testthat::testing_package()
x <- tryCatch(
rprojroot::find_package_root_file(
path = file.path("..", "..", "00_pkg_src", pkg)),
error = function(e) NULL)
if (!is.null(x)) return(x)
stop("Cannot find package root")
}
sanitize_wd <- function(x) {
wd <- paste0("file://", getwd())
gsub(wd, "file:///testthat/home", x, fixed = TRUE)
}
sanitize_home <- function(x) {
home <- paste0("file://", path.expand("~"))
gsub(home, "file:///my/home", x, fixed = TRUE)
}
sanitize_srcref <- function(x) {
gsub(" at .*.R:[0-9]+:[0-9]+", "", x)
}
sanitize_call <- function(x) {
gsub(" in `.*`", "", x)
}
r_pty <- function(.envir = parent.frame()) {
skip_on_cran()
# TODO: why does this fail on the CI, in covr
if (Sys.getenv("R_COVR") == "true" &&
isTRUE(as.logical(Sys.getenv("CI")))) {
skip("fails on CI in covr")
}
if (!Sys.info()[["sysname"]] %in% c("Darwin", "Linux")) skip("Needs Linux or macOS")
r <- file.path(R.home("bin"), "R")
p <- processx::process$new(
r,
c("-q", "--slave", "--vanilla"),
pty = TRUE,
env = c("current", R_CLI_HIDE_CURSOR = "false", R_LIBS = .libPaths()[1])
)
defer({
close(p$get_input_connection())
p$wait(1000)
p$kill()
}, envir = .envir)
p$poll_io(1000)
p$read_output()
p
}
cli/tests/testthat/test-text.R 0000644 0001762 0000144 00000001137 14212141573 016111 0 ustar ligges users
start_app()
on.exit(stop_app(), add = TRUE)
test_that("text is wrapped", {
withr::local_options(cli.width = 60)
withr::local_rng_version("3.3.0")
set.seed(42)
expect_snapshot(local({
cli_div(class = "testcli", theme = test_style())
cli_h1("Header")
cli_text(lorem_ipsum())
}))
})
test_that("verbatim text is not wrapped", {
cli_div(class = "testcli", theme = test_style())
withr::local_options(cli.width = 60)
suppressMessages(cli_h1("Header"))
txt <- strrep("1234567890 ", 20)
out <- capt0(cli_verbatim(txt), strip_style = TRUE)
expect_equal(out, paste0(txt, "\n"))
})
cli/tests/testthat/_snaps/ 0000755 0001762 0000144 00000000000 14535436722 015321 5 ustar ligges users cli/tests/testthat/_snaps/format-conditions.md 0000644 0001762 0000144 00000027224 14535354346 021312 0 ustar ligges users # format_error [plain]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
})
Condition
Error:
! `n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
stop(format_error(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
Error:
! Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
# format_error [ansi]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
stop(format_error(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22mMust index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
# format_error [unicode]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
})
Condition
Error:
! `n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
stop(format_error(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
Error:
! Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
# format_error [fancy]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
stop(format_error(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22mMust index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
# format_warning [plain]
Code
n <- "boo"
warning(format_warning(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Condition
Warning:
`n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
warning(format_warning(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
Warning:
Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
# format_warning [ansi]
Code
n <- "boo"
warning(format_warning(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Condition
[1m[33mWarning[39m:[22m
[1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
warning(format_warning(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
[1m[33mWarning[39m:[22m
[1m[22mMust index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
# format_warning [unicode]
Code
n <- "boo"
warning(format_warning(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Condition
Warning:
`n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
warning(format_warning(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
Warning:
Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
# format_warning [fancy]
Code
n <- "boo"
warning(format_warning(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Condition
[1m[33mWarning[39m:[22m
[1m[22m`n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
warning(format_warning(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Condition
[1m[33mWarning[39m:[22m
[1m[22mMust index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
# format_message [plain]
Code
n <- "boo"
message(format_message(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Message
`n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
message(format_message(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Message
Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
# format_message [ansi]
Code
n <- "boo"
message(format_message(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Message
[1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
message(format_message(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Message
[1m[22mMust index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
# format_message [unicode]
Code
n <- "boo"
message(format_message(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Message
`n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
message(format_message(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Message
Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
# format_message [fancy]
Code
n <- "boo"
message(format_message(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.")))
Message
[1m[22m`n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
message(format_message(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}.")))
})
Message
[1m[22mMust index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
# color in RStudio [ansi]
Code
col <- get_rstudio_fg_color0()
cat(col("this is the new color"))
Output
[30mthis is the new color[39m
# update_rstudio_color [ansi]
Code
cat(update_rstudio_color("color me interested"))
Output
[32mcolor me interested[39m
# named first element
Code
format_error(c(`*` = "foo", `*` = "bar"))
Output
[1] "* foo\n* bar"
---
Code
format_warning(c(`*` = "foo", `*` = "bar"))
Output
[1] "* foo\n* bar"
# cli.condition_width
Code
format_error(msg)
Output
[1] "1234567890 1234567890 1234567890\n1234567890 1234567890 1234567890\n1234567890 1234567890"
Code
format_warning(msg)
Output
[1] "1234567890 1234567890 1234567890\n1234567890 1234567890 1234567890\n1234567890 1234567890"
Code
format_message(msg)
Output
[1] "1234567890 1234567890 1234567890\n1234567890 1234567890 1234567890\n1234567890 1234567890"
---
Code
format_error(msg)
Output
[1] "1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890"
Code
format_warning(msg)
Output
[1] "1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890"
Code
format_message(msg)
Output
[1] "1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890"
# suppressing Unicode bullets [plain]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.",
v = "Success.", i = "Info.", `*` = "Bullet", `>` = "Arrow")))
})
Condition
Error:
! `n` must be a numeric vector
x You've supplied a vector.
v Success.
i Info.
* Bullet
> Arrow
# suppressing Unicode bullets [ansi]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.",
v = "Success.", i = "Info.", `*` = "Bullet", `>` = "Arrow")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
[32mv[39m Success.
[36mi[39m Info.
[36m*[39m Bullet
> Arrow
# suppressing Unicode bullets [unicode]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.",
v = "Success.", i = "Info.", `*` = "Bullet", `>` = "Arrow")))
})
Condition
Error:
! `n` must be a numeric vector
x You've supplied a vector.
v Success.
i Info.
* Bullet
> Arrow
# suppressing Unicode bullets [fancy]
Code
local({
n <- "boo"
stop(format_error(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector.",
v = "Success.", i = "Info.", `*` = "Bullet", `>` = "Arrow")))
})
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
[32mv[39m Success.
[36mi[39m Info.
[36m*[39m Bullet
> Arrow
cli/tests/testthat/_snaps/box-styles.md 0000644 0001762 0000144 00000002762 14535354341 017757 0 ustar ligges users # list_border_styles [plain]
Code
for (st in list_border_styles()) print(boxx("", border_style = st))
Output
+------+
| |
| |
| |
+------+
+------+
| |
| |
| |
+------+
+------+
| |
| |
| |
+------+
+------+
| |
| |
| |
+------+
+------+
| |
| |
| |
+------+
+------+
| |
| |
| |
+------+
# list_border_styles [unicode]
Code
for (st in list_border_styles()) print(boxx("", border_style = st))
Output
┌──────┐
│ │
│ │
│ │
└──────┘
╔══════╗
║ ║
║ ║
║ ║
╚══════╝
╭──────╮
│ │
│ │
│ │
╰──────╯
╓──────╖
║ ║
║ ║
║ ║
╙──────╜
╒══════╕
│ │
│ │
│ │
╘══════╛
+------+
| |
| |
| |
+------+
cli/tests/testthat/_snaps/boxes.md 0000644 0001762 0000144 00000026232 14535354342 016765 0 ustar ligges users # empty label [plain]
Code
boxx("")
Output
+------+
| |
| |
| |
+------+
# empty label [unicode]
Code
boxx("")
Output
┌──────┐
│ │
│ │
│ │
└──────┘
# empty label 2 [plain]
Code
boxx(character())
Output
+------+
| |
| |
+------+
# empty label 2 [unicode]
Code
boxx(character())
Output
┌──────┐
│ │
│ │
└──────┘
# label [plain]
Code
boxx("label")
Output
+-----------+
| |
| label |
| |
+-----------+
# label [unicode]
Code
boxx("label")
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
# label vector [plain]
Code
boxx(c("label", "l2"))
Output
+-----------+
| |
| label |
| l2 |
| |
+-----------+
# label vector [unicode]
Code
boxx(c("label", "l2"))
Output
┌───────────┐
│ │
│ label │
│ l2 │
│ │
└───────────┘
# border style [plain]
Code
boxx("label", border_style = "classic")
Output
+-----------+
| |
| label |
| |
+-----------+
# border style [unicode]
Code
boxx("label", border_style = "classic")
Output
+-----------+
| |
| label |
| |
+-----------+
# padding [plain]
Code
boxx("label", padding = 2)
Output
+-----------------+
| |
| |
| label |
| |
| |
+-----------------+
---
Code
boxx("label", padding = c(1, 2, 1, 2))
Output
+---------+
| |
| label |
| |
+---------+
---
Code
boxx("label", padding = c(1, 2, 0, 2))
Output
+---------+
| label |
| |
+---------+
---
Code
boxx("label", padding = c(1, 2, 0, 0))
Output
+-------+
| label|
| |
+-------+
# padding [unicode]
Code
boxx("label", padding = 2)
Output
┌─────────────────┐
│ │
│ │
│ label │
│ │
│ │
└─────────────────┘
---
Code
boxx("label", padding = c(1, 2, 1, 2))
Output
┌─────────┐
│ │
│ label │
│ │
└─────────┘
---
Code
boxx("label", padding = c(1, 2, 0, 2))
Output
┌─────────┐
│ label │
│ │
└─────────┘
---
Code
boxx("label", padding = c(1, 2, 0, 0))
Output
┌───────┐
│ label│
│ │
└───────┘
# margin [plain]
Code
boxx("label", margin = 1)
Output
+-----------+
| |
| label |
| |
+-----------+
---
Code
boxx("label", margin = c(1, 2, 3, 4))
Output
+-----------+
| |
| label |
| |
+-----------+
---
Code
boxx("label", margin = c(0, 1, 2, 0))
Output
+-----------+
| |
| label |
| |
+-----------+
# margin [unicode]
Code
boxx("label", margin = 1)
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
---
Code
boxx("label", margin = c(1, 2, 3, 4))
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
---
Code
boxx("label", margin = c(0, 1, 2, 0))
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
# float [plain]
Code
boxx("label", float = "center", width = 20)
Output
+-----------+
| |
| label |
| |
+-----------+
---
Code
boxx("label", float = "right", width = 20)
Output
+-----------+
| |
| label |
| |
+-----------+
# float [unicode]
Code
boxx("label", float = "center", width = 20)
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
---
Code
boxx("label", float = "right", width = 20)
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
# background_col [plain]
Code
boxx("label", background_col = "red")
Output
+-----------+
| |
| label |
| |
+-----------+
---
Code
boxx("label", background_col = col_red)
Output
+-----------+
| |
| label |
| |
+-----------+
# background_col [ansi]
Code
boxx("label", background_col = "red")
Output
+-----------+
|[41m [49m|
|[41m label [49m|
|[41m [49m|
+-----------+
---
Code
boxx("label", background_col = col_red)
Output
+-----------+
|[31m [39m|
|[31m label [39m|
|[31m [39m|
+-----------+
# background_col [unicode]
Code
boxx("label", background_col = "red")
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
---
Code
boxx("label", background_col = col_red)
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
# background_col [fancy]
Code
boxx("label", background_col = "red")
Output
┌───────────┐
│[41m [49m│
│[41m label [49m│
│[41m [49m│
└───────────┘
---
Code
boxx("label", background_col = col_red)
Output
┌───────────┐
│[31m [39m│
│[31m label [39m│
│[31m [39m│
└───────────┘
# border_col [plain]
Code
boxx("label", border_col = "red")
Output
+-----------+
| |
| label |
| |
+-----------+
---
Code
boxx("label", border_col = col_red)
Output
+-----------+
| |
| label |
| |
+-----------+
# border_col [ansi]
Code
boxx("label", border_col = "red")
Output
[31m+-----------+[39m
[31m|[39m [31m|[39m
[31m|[39m label [31m|[39m
[31m|[39m [31m|[39m
[31m+-----------+[39m
---
Code
boxx("label", border_col = col_red)
Output
[31m+-----------+[39m
[31m|[39m [31m|[39m
[31m|[39m label [31m|[39m
[31m|[39m [31m|[39m
[31m+-----------+[39m
# border_col [unicode]
Code
boxx("label", border_col = "red")
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
---
Code
boxx("label", border_col = col_red)
Output
┌───────────┐
│ │
│ label │
│ │
└───────────┘
# border_col [fancy]
Code
boxx("label", border_col = "red")
Output
[31m┌───────────┐[39m
[31m│[39m [31m│[39m
[31m│[39m label [31m│[39m
[31m│[39m [31m│[39m
[31m└───────────┘[39m
---
Code
boxx("label", border_col = col_red)
Output
[31m┌───────────┐[39m
[31m│[39m [31m│[39m
[31m│[39m label [31m│[39m
[31m│[39m [31m│[39m
[31m└───────────┘[39m
# align [plain]
Code
boxx(c("label", "l2"), align = "center")
Output
+-----------+
| |
| label |
| l2 |
| |
+-----------+
---
Code
boxx(c("label", "l2"), align = "right")
Output
+-----------+
| |
| label |
| l2 |
| |
+-----------+
# align [unicode]
Code
boxx(c("label", "l2"), align = "center")
Output
┌───────────┐
│ │
│ label │
│ l2 │
│ │
└───────────┘
---
Code
boxx(c("label", "l2"), align = "right")
Output
┌───────────┐
│ │
│ label │
│ l2 │
│ │
└───────────┘
# header [plain]
Code
boxx("foobar", header = "foo")
Output
+ foo -------+
| |
| foobar |
| |
+------------+
# header [unicode]
Code
boxx("foobar", header = "foo")
Output
┌ foo ───────┐
│ │
│ foobar │
│ │
└────────────┘
# footer [plain]
Code
boxx("foobar", footer = "foo")
Output
+------------+
| |
| foobar |
| |
+------- foo +
# footer [unicode]
Code
boxx("foobar", footer = "foo")
Output
┌────────────┐
│ │
│ foobar │
│ │
└─────── foo ┘
cli/tests/testthat/_snaps/ansiex-2.md 0000644 0001762 0000144 00000000422 14535354340 017262 0 ustar ligges users # NA
Code
ansi_html(s)
Output
[1] "foo"
[2] NA
[3] "bar"
[4] "foobar"
cli/tests/testthat/_snaps/ansi-utils.md 0000644 0001762 0000144 00000005206 14535354337 017737 0 ustar ligges users # re_table
Code
tbl2
Output
start end length
text1 "19" "23" "5" "\033[31m"
text2 "27" "31" "5" "\033[39m"
text3 "48" "52" "5" "\033[32m"
text4 "58" "62" "5" "\033[39m"
text5 "74" "98" "25" "\033]8;;https://example.com\a"
text6 "103" "108" "6" "\033]8;;\a"
---
Code
non_matching(list(tbl), txt)
Output
[[1]]
start end length
[1,] 1 18 18
[2,] 24 26 3
[3,] 32 47 16
[4,] 53 57 5
[5,] 63 73 11
[6,] 99 102 4
# re_table special cases
Code
tbl
Output
start end length
---
Code
non_matching(list(tbl), txt)
Output
[[1]]
start end length
[1,] 1 6 6
---
Code
non_matching(list(tbl), txt, empty = TRUE)
Output
[[1]]
start end length
[1,] 1 6 6
---
Code
tbl
Output
start end length
[1,] 1 5 5
[2,] 12 16 5
---
Code
non_matching(list(tbl), txt)
Output
[[1]]
start end length
[1,] 6 11 6
---
Code
non_matching(list(tbl), txt, empty = TRUE)
Output
[[1]]
start end length
[1,] 1 0 0
[2,] 6 11 6
[3,] 17 16 0
---
Code
tbl
Output
start end length
[1,] 5 9 5
[2,] 10 14 5
---
Code
non_matching(list(tbl), txt)
Output
[[1]]
start end length
[1,] 1 4 4
[2,] 15 18 4
---
Code
non_matching(list(tbl), txt, empty = TRUE)
Output
[[1]]
start end length
[1,] 1 4 4
[2,] 10 9 0
[3,] 15 18 4
# myseq
Code
myseq(1, 5)
Output
[1] 1 2 3 4 5
Code
myseq(1, 1)
Output
[1] 1
Code
myseq(1, 0)
Output
integer(0)
Code
myseq(1, 5, 2)
Output
[1] 1 3 5
Code
myseq(1, 6, 2)
Output
[1] 1 3 5
Code
myseq(1, 1, 2)
Output
[1] 1
Code
myseq(1, 2, -1)
Output
integer(0)
Code
myseq(10, 1, -1)
Output
[1] 10 9 8 7 6 5 4 3 2 1
Code
myseq(10, 1, -2)
Output
[1] 10 8 6 4 2
Code
myseq(1, 5, -2)
Output
integer(0)
cli/tests/testthat/_snaps/diff.md 0000644 0001762 0000144 00000007653 14535354345 016566 0 ustar ligges users # diff_chr
Code
d$lcs
Output
operation offset length old_offset new_offset
1 match 0 8 8 8
2 delete 8 1 9 8
3 insert 8 1 9 9
4 match 9 7 16 16
5 insert 16 2 16 18
6 match 16 1 17 19
---
Code
d$lcs
Output
operation offset length old_offset new_offset
1 match 0 8 8 8
2 delete 8 1 9 8
3 insert 8 1 9 9
4 match 9 7 16 16
5 delete 16 2 18 16
6 match 18 1 19 17
# diff_chr [plain]
Code
d
Output
@@ -6,7 +6,7 @@
1
1
2
-3
+10
4
4
4
@@ -14,4 +14,6 @@
4
4
4
+6
+7
5
---
Code
d$lcs
Output
operation offset length old_offset new_offset
1 match 0 8 8 8
2 delete 8 1 9 8
3 insert 8 1 9 9
4 match 9 7 16 16
5 insert 16 2 16 18
6 match 16 1 17 19
# diff_chr [ansi]
Code
d
Output
@@ -6,7 +6,7 @@
1
1
2
[34m-3[39m
[32m+10[39m
4
4
4
@@ -14,4 +14,6 @@
4
4
4
[32m+6[39m
[32m+7[39m
5
---
Code
d$lcs
Output
operation offset length old_offset new_offset
1 match 0 8 8 8
2 delete 8 1 9 8
3 insert 8 1 9 9
4 match 9 7 16 16
5 insert 16 2 16 18
6 match 16 1 17 19
# diff_chr edge cases
Code
diff_chr(character(), character())
---
Code
diff_chr(character(), character())$lcs
Output
[1] operation offset length old_offset new_offset
<0 rows> (or 0-length row.names)
---
Code
diff_chr("a", character())
Output
@@ -1 +0 @@
-a
---
Code
diff_chr(character(), "b")
Output
@@ -0 +1 @@
+b
---
Code
diff_chr("a", "a")
---
Code
diff_chr(letters, letters)
---
Code
diff_chr(c("a", NA, "a2"), "b")
Output
@@ -1,3 +1 @@
-a
-NA
-a2
+b
---
Code
diff_chr(NA_character_, "NA")
Output
@@ -1 +1 @@
-NA
+NA
# format.cli_diff_chr context
Code
print(d, context = 1)
Output
@@ -8,3 +8,3 @@
2
-3
+10
4
@@ -16,2 +16,4 @@
4
+6
+7
5
---
Code
print(d, context = 0)
Output
@@ -9 +9 @@
-3
+10
@@ -17,0 +17,2 @@
+6
+7
---
Code
print(d, context = Inf)
Output
1
1
1
1
1
1
1
2
-3
+10
4
4
4
4
4
4
4
+6
+7
5
---
Code
print(d2, context = Inf)
Output
foo
bar
# diff_str [plain]
Code
d
Output
{+PRE+}abcdefg[-hijklm-]{+MIDDLE+}nopqrstuvwxyz{+POST+}
# diff_str [ansi]
Code
d
Output
[42m[30mPRE[39m[49mabcdefg[44m[30mhijklm[39m[49m[42m[30mMIDDLE[39m[49mnopqrstuvwxyz[42m[30mPOST[39m[49m
# max_diff
! Diff edit distance is larger than the limit.
i The edit distance limit is 0.
---
! Diff edit distance is larger than the limit.
i The edit distance limit is 1.
cli/tests/testthat/_snaps/progress-variables.md 0000644 0001762 0000144 00000012533 14535354365 021463 0 ustar ligges users # cli_progress_demo
Code
out
Output
\ 50 done (100/s) | 3ms[K
---
Code
out
Output
==========>-------------------- 33% | ETA: 1s[K
====================>---------- 67% | ETA: 1s[K
==============================> 100% | ETA: 1s[K
[K
---
Code
out
Output
\ 1 done (100/s) | 3ms[K
| 2 done (100/s) | 3ms[K
/ 3 done (100/s) | 3ms[K
- 4 done (100/s) | 3ms[K
\ 5 done (100/s) | 3ms[K
[K
---
Code
out
Output
==========>-------------------- 33% | ETA: 10s[K
====================>---------- 67% | ETA: 3s[K
==============================> 100% | ETA: 0s[K
[K
---
Code
msgs
Output
[1] "\r==========>-------------------- 33% | ETA: 10s\033[K\r"
[2] "\r====================>---------- 67% | ETA: 3s\033[K\r"
[3] "\r==============================> 100% | ETA: 0s\033[K\r"
[4] "\r\033[K"
# pb_bar
Code
cli_text("-{cli::pb_bar}-")
Message
--
---
Code
cli_text("-{cli::pb_bar}-")
Message
-===============>--------------- -
# pb_current_bytes
Code
cli__pb_current_bytes(list(current = 0))
Output
[1] "0.0 kB"
Code
cli__pb_current_bytes(list(current = 1))
Output
[1] "0.0 kB"
Code
cli__pb_current_bytes(list(current = 1000))
Output
[1] "1.0 kB"
Code
cli__pb_current_bytes(list(current = 1000 * 23))
Output
[1] " 23 kB"
Code
cli__pb_current_bytes(list(current = 1000 * 1000 * 23))
Output
[1] " 23 MB"
# pb_elapsed
Code
cli__pb_elapsed()
Output
[1] "1s"
---
Code
cli__pb_elapsed()
Output
[1] "21s"
---
Code
cli__pb_elapsed()
Output
[1] "58s"
---
Code
cli__pb_elapsed()
Output
[1] "1h 5m"
# pb_elapsed_clock
Code
cli__pb_elapsed_clock()
Output
[1] "00:00:01"
---
Code
cli__pb_elapsed_clock()
Output
[1] "00:00:21"
---
Code
cli__pb_elapsed_clock()
Output
[1] "00:00:58"
---
Code
cli__pb_elapsed_clock()
Output
[1] "01:05:00"
# pb_elapsed_raw
Code
cli__pb_elapsed_raw()
Output
[1] 1
---
Code
cli__pb_elapsed_raw()
Output
[1] 21
---
Code
cli__pb_elapsed_raw()
Output
[1] 58
---
Code
cli__pb_elapsed_raw()
Output
[1] 3900
# pb_eta
Code
cli__pb_eta(list())
Output
[1] "?"
---
Code
cli__pb_eta(list())
Output
[1] "12s"
# pb_eta_raw
Code
cli__pb_eta_raw()
Output
[1] NA
---
Code
cli__pb_eta_raw()
Output
Time difference of 40 secs
---
Code
cli__pb_eta_raw()
Output
Time difference of 10 secs
---
Code
cli__pb_eta_raw()
Output
Time difference of 0 secs
# pb_eta_str
Code
cli__pb_eta_str(list())
Output
[1] ""
---
Code
cli__pb_eta_str(list())
Output
[1] "ETA: 1s"
# pb_percent
Code
cli__pb_percent(list(current = 0, total = 99))
Output
[1] " 0%"
Code
cli__pb_percent(list(current = 5, total = 99))
Output
[1] " 5%"
Code
cli__pb_percent(list(current = 10, total = 99))
Output
[1] " 10%"
Code
cli__pb_percent(list(current = 25, total = 99))
Output
[1] " 25%"
Code
cli__pb_percent(list(current = 99, total = 99))
Output
[1] "100%"
Code
cli__pb_percent(list(current = 100, total = 99))
Output
[1] "101%"
# pb_rate
Code
cli__pb_rate(list())
Output
[1] "?/s"
---
Code
cli__pb_rate(list())
Output
[1] "?/s"
---
Code
cli__pb_rate(list())
Output
[1] "0.1/s"
---
Code
cli__pb_rate(list())
Output
[1] "12/s"
# pb_rate_bytes
Code
cli__pb_rate_bytes(list())
Output
[1] "NaN kB/s"
---
Code
cli__pb_rate_bytes(list())
Output
[1] "Inf YB/s"
---
Code
cli__pb_rate_bytes(list())
Output
[1] "0.0 kB/s"
---
Code
cli__pb_rate_bytes(list())
Output
[1] "1.0 kB/s"
---
Code
cli__pb_rate_bytes(list())
Output
[1] " 24 kB/s"
---
Code
cli__pb_rate_bytes(list())
Output
[1] " 24 MB/s"
# pb_spin
Code
cli_text("-{cli::pb_spin}-{cli::pb_spin}-")
Message
-\-\-
---
Code
cli_text("-{cli::pb_spin}-{cli::pb_spin}-")
Message
-|-|-
---
Code
cli_text("-{cli::pb_spin}-{cli::pb_spin}-")
Message
-|-|-
# pb_timestamp
Code
cli__pb_timestamp(list())
Output
[1] "2021-06-18T00:09:14+00:00"
---
Code
cli__pb_timestamp(list())
Output
[1] "2021-06-18T00:09:34+00:00"
# pb_total_bytes
Code
cli__pb_total_bytes(list(total = 0))
Output
[1] "0.0 kB"
Code
cli__pb_total_bytes(list(total = 1))
Output
[1] "0.0 kB"
Code
cli__pb_total_bytes(list(total = 1000))
Output
[1] "1.0 kB"
Code
cli__pb_total_bytes(list(total = 1000 * 23))
Output
[1] " 23 kB"
Code
cli__pb_total_bytes(list(total = 1000 * 1000 * 23))
Output
[1] " 23 MB"
cli/tests/testthat/_snaps/ansi-html.md 0000644 0001762 0000144 00000075762 14535354337 017561 0 ustar ligges users # ansi_html
Code
ansi_html(str)
Output
[1] "bold"
[2] "faint"
[3] "italic"
[4] "underline"
[5] "blink"
[6] "inverse"
[7] "hide"
[8] "crossedout"
[9] "black"
[10] "red"
[11] "green"
[12] "yellow"
[13] "blue"
[14] "magenta"
[15] "cyan"
[16] "white"
[17] "bblack"
[18] "bred"
[19] "bgreen"
[20] "byellow"
[21] "bblue"
[22] "bmagenta"
[23] "bcyan"
[24] "bwhite"
[25] "color-156"
[26] "color-1-22-255"
[27] "bg-black"
[28] "bg-red"
[29] "bg-green"
[30] "bg-yellow"
[31] "bg-blue"
[32] "bg-magenta"
[33] "bg-cyan"
[34] "bg-white"
[35] "bg-bblack"
[36] "bg-bred"
[37] "bg-bgreen"
[38] "bg-byellow"
[39] "bg-bblue"
[40] "bg-bmagenta"
[41] "bg-bcyan"
[42] "bg-bwhite"
[43] "bg-color-156"
[44] "bg-color-1-22-255"
# multiple styles
Code
ansi_html("\033[1;2;35;45mmultiple")
Output
[1] "multiple"
# ansi_html_style
Code
ansi_html_style(colors = 8)
Output
.ansi-bold { font-weight: bold; }
.ansi-italic { font-style: italic; }
.ansi-underline { text-decoration: underline; }
.ansi-blink { text-decoration: blink; }
.ansi-hide { visibility: hidden; }
.ansi-crossedout { text-decoration: line-through; }
.ansi-link:hover { text-decoration: underline; }
.ansi-color-0 { color: #000000 }
.ansi-color-1 { color: #cd3131 }
.ansi-color-2 { color: #0dbc79 }
.ansi-color-3 { color: #e5e510 }
.ansi-color-4 { color: #2472c8 }
.ansi-color-5 { color: #bc3fbc }
.ansi-color-6 { color: #11a8cd }
.ansi-color-7 { color: #e5e5e5 }
.ansi-color-8 { color: #666666 }
.ansi-color-9 { color: #f14c4c }
.ansi-color-10 { color: #23d18b }
.ansi-color-11 { color: #f5f543 }
.ansi-color-12 { color: #3b8eea }
.ansi-color-13 { color: #d670d6 }
.ansi-color-14 { color: #29b8db }
.ansi-color-15 { color: #e5e5e5 }
.ansi-bg-color-0 { background-color: #000000 }
.ansi-bg-color-1 { background-color: #cd3131 }
.ansi-bg-color-2 { background-color: #0dbc79 }
.ansi-bg-color-3 { background-color: #e5e510 }
.ansi-bg-color-4 { background-color: #2472c8 }
.ansi-bg-color-5 { background-color: #bc3fbc }
.ansi-bg-color-6 { background-color: #11a8cd }
.ansi-bg-color-7 { background-color: #e5e5e5 }
.ansi-bg-color-8 { background-color: #666666 }
.ansi-bg-color-9 { background-color: #f14c4c }
.ansi-bg-color-10 { background-color: #23d18b }
.ansi-bg-color-11 { background-color: #f5f543 }
.ansi-bg-color-12 { background-color: #3b8eea }
.ansi-bg-color-13 { background-color: #d670d6 }
.ansi-bg-color-14 { background-color: #29b8db }
.ansi-bg-color-15 { background-color: #e5e5e5 }
---
Code
ansi_html_style(colors = 256, palette = "ubuntu")
Output
.ansi-bold { font-weight: bold; }
.ansi-italic { font-style: italic; }
.ansi-underline { text-decoration: underline; }
.ansi-blink { text-decoration: blink; }
.ansi-hide { visibility: hidden; }
.ansi-crossedout { text-decoration: line-through; }
.ansi-link:hover { text-decoration: underline; }
.ansi-color-0 { color: #010101 }
.ansi-color-1 { color: #de382b }
.ansi-color-2 { color: #39b54a }
.ansi-color-3 { color: #ffc706 }
.ansi-color-4 { color: #006fb8 }
.ansi-color-5 { color: #762671 }
.ansi-color-6 { color: #2cb5e9 }
.ansi-color-7 { color: #cccccc }
.ansi-color-8 { color: #808080 }
.ansi-color-9 { color: #ff0000 }
.ansi-color-10 { color: #00ff00 }
.ansi-color-11 { color: #ffff00 }
.ansi-color-12 { color: #0000ff }
.ansi-color-13 { color: #ff00ff }
.ansi-color-14 { color: #00ffff }
.ansi-color-15 { color: #ffffff }
.ansi-bg-color-0 { background-color: #010101 }
.ansi-bg-color-1 { background-color: #de382b }
.ansi-bg-color-2 { background-color: #39b54a }
.ansi-bg-color-3 { background-color: #ffc706 }
.ansi-bg-color-4 { background-color: #006fb8 }
.ansi-bg-color-5 { background-color: #762671 }
.ansi-bg-color-6 { background-color: #2cb5e9 }
.ansi-bg-color-7 { background-color: #cccccc }
.ansi-bg-color-8 { background-color: #808080 }
.ansi-bg-color-9 { background-color: #ff0000 }
.ansi-bg-color-10 { background-color: #00ff00 }
.ansi-bg-color-11 { background-color: #ffff00 }
.ansi-bg-color-12 { background-color: #0000ff }
.ansi-bg-color-13 { background-color: #ff00ff }
.ansi-bg-color-14 { background-color: #00ffff }
.ansi-bg-color-15 { background-color: #ffffff }
.ansi-color-16 { color: #000000 }
.ansi-color-52 { color: #330000 }
.ansi-color-88 { color: #660000 }
.ansi-color-124 { color: #990000 }
.ansi-color-160 { color: #cc0000 }
.ansi-color-196 { color: #ff0000 }
.ansi-color-22 { color: #003300 }
.ansi-color-58 { color: #333300 }
.ansi-color-94 { color: #663300 }
.ansi-color-130 { color: #993300 }
.ansi-color-166 { color: #cc3300 }
.ansi-color-202 { color: #ff3300 }
.ansi-color-28 { color: #006600 }
.ansi-color-64 { color: #336600 }
.ansi-color-100 { color: #666600 }
.ansi-color-136 { color: #996600 }
.ansi-color-172 { color: #cc6600 }
.ansi-color-208 { color: #ff6600 }
.ansi-color-34 { color: #009900 }
.ansi-color-70 { color: #339900 }
.ansi-color-106 { color: #669900 }
.ansi-color-142 { color: #999900 }
.ansi-color-178 { color: #cc9900 }
.ansi-color-214 { color: #ff9900 }
.ansi-color-40 { color: #00cc00 }
.ansi-color-76 { color: #33cc00 }
.ansi-color-112 { color: #66cc00 }
.ansi-color-148 { color: #99cc00 }
.ansi-color-184 { color: #cccc00 }
.ansi-color-220 { color: #ffcc00 }
.ansi-color-46 { color: #00ff00 }
.ansi-color-82 { color: #33ff00 }
.ansi-color-118 { color: #66ff00 }
.ansi-color-154 { color: #99ff00 }
.ansi-color-190 { color: #ccff00 }
.ansi-color-226 { color: #ffff00 }
.ansi-color-17 { color: #000033 }
.ansi-color-53 { color: #330033 }
.ansi-color-89 { color: #660033 }
.ansi-color-125 { color: #990033 }
.ansi-color-161 { color: #cc0033 }
.ansi-color-197 { color: #ff0033 }
.ansi-color-23 { color: #003333 }
.ansi-color-59 { color: #333333 }
.ansi-color-95 { color: #663333 }
.ansi-color-131 { color: #993333 }
.ansi-color-167 { color: #cc3333 }
.ansi-color-203 { color: #ff3333 }
.ansi-color-29 { color: #006633 }
.ansi-color-65 { color: #336633 }
.ansi-color-101 { color: #666633 }
.ansi-color-137 { color: #996633 }
.ansi-color-173 { color: #cc6633 }
.ansi-color-209 { color: #ff6633 }
.ansi-color-35 { color: #009933 }
.ansi-color-71 { color: #339933 }
.ansi-color-107 { color: #669933 }
.ansi-color-143 { color: #999933 }
.ansi-color-179 { color: #cc9933 }
.ansi-color-215 { color: #ff9933 }
.ansi-color-41 { color: #00cc33 }
.ansi-color-77 { color: #33cc33 }
.ansi-color-113 { color: #66cc33 }
.ansi-color-149 { color: #99cc33 }
.ansi-color-185 { color: #cccc33 }
.ansi-color-221 { color: #ffcc33 }
.ansi-color-47 { color: #00ff33 }
.ansi-color-83 { color: #33ff33 }
.ansi-color-119 { color: #66ff33 }
.ansi-color-155 { color: #99ff33 }
.ansi-color-191 { color: #ccff33 }
.ansi-color-227 { color: #ffff33 }
.ansi-color-18 { color: #000066 }
.ansi-color-54 { color: #330066 }
.ansi-color-90 { color: #660066 }
.ansi-color-126 { color: #990066 }
.ansi-color-162 { color: #cc0066 }
.ansi-color-198 { color: #ff0066 }
.ansi-color-24 { color: #003366 }
.ansi-color-60 { color: #333366 }
.ansi-color-96 { color: #663366 }
.ansi-color-132 { color: #993366 }
.ansi-color-168 { color: #cc3366 }
.ansi-color-204 { color: #ff3366 }
.ansi-color-30 { color: #006666 }
.ansi-color-66 { color: #336666 }
.ansi-color-102 { color: #666666 }
.ansi-color-138 { color: #996666 }
.ansi-color-174 { color: #cc6666 }
.ansi-color-210 { color: #ff6666 }
.ansi-color-36 { color: #009966 }
.ansi-color-72 { color: #339966 }
.ansi-color-108 { color: #669966 }
.ansi-color-144 { color: #999966 }
.ansi-color-180 { color: #cc9966 }
.ansi-color-216 { color: #ff9966 }
.ansi-color-42 { color: #00cc66 }
.ansi-color-78 { color: #33cc66 }
.ansi-color-114 { color: #66cc66 }
.ansi-color-150 { color: #99cc66 }
.ansi-color-186 { color: #cccc66 }
.ansi-color-222 { color: #ffcc66 }
.ansi-color-48 { color: #00ff66 }
.ansi-color-84 { color: #33ff66 }
.ansi-color-120 { color: #66ff66 }
.ansi-color-156 { color: #99ff66 }
.ansi-color-192 { color: #ccff66 }
.ansi-color-228 { color: #ffff66 }
.ansi-color-19 { color: #000099 }
.ansi-color-55 { color: #330099 }
.ansi-color-91 { color: #660099 }
.ansi-color-127 { color: #990099 }
.ansi-color-163 { color: #cc0099 }
.ansi-color-199 { color: #ff0099 }
.ansi-color-25 { color: #003399 }
.ansi-color-61 { color: #333399 }
.ansi-color-97 { color: #663399 }
.ansi-color-133 { color: #993399 }
.ansi-color-169 { color: #cc3399 }
.ansi-color-205 { color: #ff3399 }
.ansi-color-31 { color: #006699 }
.ansi-color-67 { color: #336699 }
.ansi-color-103 { color: #666699 }
.ansi-color-139 { color: #996699 }
.ansi-color-175 { color: #cc6699 }
.ansi-color-211 { color: #ff6699 }
.ansi-color-37 { color: #009999 }
.ansi-color-73 { color: #339999 }
.ansi-color-109 { color: #669999 }
.ansi-color-145 { color: #999999 }
.ansi-color-181 { color: #cc9999 }
.ansi-color-217 { color: #ff9999 }
.ansi-color-43 { color: #00cc99 }
.ansi-color-79 { color: #33cc99 }
.ansi-color-115 { color: #66cc99 }
.ansi-color-151 { color: #99cc99 }
.ansi-color-187 { color: #cccc99 }
.ansi-color-223 { color: #ffcc99 }
.ansi-color-49 { color: #00ff99 }
.ansi-color-85 { color: #33ff99 }
.ansi-color-121 { color: #66ff99 }
.ansi-color-157 { color: #99ff99 }
.ansi-color-193 { color: #ccff99 }
.ansi-color-229 { color: #ffff99 }
.ansi-color-20 { color: #0000cc }
.ansi-color-56 { color: #3300cc }
.ansi-color-92 { color: #6600cc }
.ansi-color-128 { color: #9900cc }
.ansi-color-164 { color: #cc00cc }
.ansi-color-200 { color: #ff00cc }
.ansi-color-26 { color: #0033cc }
.ansi-color-62 { color: #3333cc }
.ansi-color-98 { color: #6633cc }
.ansi-color-134 { color: #9933cc }
.ansi-color-170 { color: #cc33cc }
.ansi-color-206 { color: #ff33cc }
.ansi-color-32 { color: #0066cc }
.ansi-color-68 { color: #3366cc }
.ansi-color-104 { color: #6666cc }
.ansi-color-140 { color: #9966cc }
.ansi-color-176 { color: #cc66cc }
.ansi-color-212 { color: #ff66cc }
.ansi-color-38 { color: #0099cc }
.ansi-color-74 { color: #3399cc }
.ansi-color-110 { color: #6699cc }
.ansi-color-146 { color: #9999cc }
.ansi-color-182 { color: #cc99cc }
.ansi-color-218 { color: #ff99cc }
.ansi-color-44 { color: #00cccc }
.ansi-color-80 { color: #33cccc }
.ansi-color-116 { color: #66cccc }
.ansi-color-152 { color: #99cccc }
.ansi-color-188 { color: #cccccc }
.ansi-color-224 { color: #ffcccc }
.ansi-color-50 { color: #00ffcc }
.ansi-color-86 { color: #33ffcc }
.ansi-color-122 { color: #66ffcc }
.ansi-color-158 { color: #99ffcc }
.ansi-color-194 { color: #ccffcc }
.ansi-color-230 { color: #ffffcc }
.ansi-color-21 { color: #0000ff }
.ansi-color-57 { color: #3300ff }
.ansi-color-93 { color: #6600ff }
.ansi-color-129 { color: #9900ff }
.ansi-color-165 { color: #cc00ff }
.ansi-color-201 { color: #ff00ff }
.ansi-color-27 { color: #0033ff }
.ansi-color-63 { color: #3333ff }
.ansi-color-99 { color: #6633ff }
.ansi-color-135 { color: #9933ff }
.ansi-color-171 { color: #cc33ff }
.ansi-color-207 { color: #ff33ff }
.ansi-color-33 { color: #0066ff }
.ansi-color-69 { color: #3366ff }
.ansi-color-105 { color: #6666ff }
.ansi-color-141 { color: #9966ff }
.ansi-color-177 { color: #cc66ff }
.ansi-color-213 { color: #ff66ff }
.ansi-color-39 { color: #0099ff }
.ansi-color-75 { color: #3399ff }
.ansi-color-111 { color: #6699ff }
.ansi-color-147 { color: #9999ff }
.ansi-color-183 { color: #cc99ff }
.ansi-color-219 { color: #ff99ff }
.ansi-color-45 { color: #00ccff }
.ansi-color-81 { color: #33ccff }
.ansi-color-117 { color: #66ccff }
.ansi-color-153 { color: #99ccff }
.ansi-color-189 { color: #ccccff }
.ansi-color-225 { color: #ffccff }
.ansi-color-51 { color: #00ffff }
.ansi-color-87 { color: #33ffff }
.ansi-color-123 { color: #66ffff }
.ansi-color-159 { color: #99ffff }
.ansi-color-195 { color: #ccffff }
.ansi-color-231 { color: #ffffff }
.ansi-color-232 { color: #0a0a0a }
.ansi-color-233 { color: #141414 }
.ansi-color-234 { color: #1f1f1f }
.ansi-color-235 { color: #292929 }
.ansi-color-236 { color: #333333 }
.ansi-color-237 { color: #3d3d3d }
.ansi-color-238 { color: #474747 }
.ansi-color-239 { color: #525252 }
.ansi-color-240 { color: #5c5c5c }
.ansi-color-241 { color: #666666 }
.ansi-color-242 { color: #707070 }
.ansi-color-243 { color: #7a7a7a }
.ansi-color-244 { color: #858585 }
.ansi-color-245 { color: #8f8f8f }
.ansi-color-246 { color: #999999 }
.ansi-color-247 { color: #a3a3a3 }
.ansi-color-248 { color: #adadad }
.ansi-color-249 { color: #b8b8b8 }
.ansi-color-250 { color: #c2c2c2 }
.ansi-color-251 { color: #cccccc }
.ansi-color-252 { color: #d6d6d6 }
.ansi-color-253 { color: #e0e0e0 }
.ansi-color-254 { color: #ebebeb }
.ansi-color-255 { color: #f5f5f5 }
.ansi-bg-color-16 { background-color: #000000 }
.ansi-bg-color-52 { background-color: #330000 }
.ansi-bg-color-88 { background-color: #660000 }
.ansi-bg-color-124 { background-color: #990000 }
.ansi-bg-color-160 { background-color: #cc0000 }
.ansi-bg-color-196 { background-color: #ff0000 }
.ansi-bg-color-22 { background-color: #003300 }
.ansi-bg-color-58 { background-color: #333300 }
.ansi-bg-color-94 { background-color: #663300 }
.ansi-bg-color-130 { background-color: #993300 }
.ansi-bg-color-166 { background-color: #cc3300 }
.ansi-bg-color-202 { background-color: #ff3300 }
.ansi-bg-color-28 { background-color: #006600 }
.ansi-bg-color-64 { background-color: #336600 }
.ansi-bg-color-100 { background-color: #666600 }
.ansi-bg-color-136 { background-color: #996600 }
.ansi-bg-color-172 { background-color: #cc6600 }
.ansi-bg-color-208 { background-color: #ff6600 }
.ansi-bg-color-34 { background-color: #009900 }
.ansi-bg-color-70 { background-color: #339900 }
.ansi-bg-color-106 { background-color: #669900 }
.ansi-bg-color-142 { background-color: #999900 }
.ansi-bg-color-178 { background-color: #cc9900 }
.ansi-bg-color-214 { background-color: #ff9900 }
.ansi-bg-color-40 { background-color: #00cc00 }
.ansi-bg-color-76 { background-color: #33cc00 }
.ansi-bg-color-112 { background-color: #66cc00 }
.ansi-bg-color-148 { background-color: #99cc00 }
.ansi-bg-color-184 { background-color: #cccc00 }
.ansi-bg-color-220 { background-color: #ffcc00 }
.ansi-bg-color-46 { background-color: #00ff00 }
.ansi-bg-color-82 { background-color: #33ff00 }
.ansi-bg-color-118 { background-color: #66ff00 }
.ansi-bg-color-154 { background-color: #99ff00 }
.ansi-bg-color-190 { background-color: #ccff00 }
.ansi-bg-color-226 { background-color: #ffff00 }
.ansi-bg-color-17 { background-color: #000033 }
.ansi-bg-color-53 { background-color: #330033 }
.ansi-bg-color-89 { background-color: #660033 }
.ansi-bg-color-125 { background-color: #990033 }
.ansi-bg-color-161 { background-color: #cc0033 }
.ansi-bg-color-197 { background-color: #ff0033 }
.ansi-bg-color-23 { background-color: #003333 }
.ansi-bg-color-59 { background-color: #333333 }
.ansi-bg-color-95 { background-color: #663333 }
.ansi-bg-color-131 { background-color: #993333 }
.ansi-bg-color-167 { background-color: #cc3333 }
.ansi-bg-color-203 { background-color: #ff3333 }
.ansi-bg-color-29 { background-color: #006633 }
.ansi-bg-color-65 { background-color: #336633 }
.ansi-bg-color-101 { background-color: #666633 }
.ansi-bg-color-137 { background-color: #996633 }
.ansi-bg-color-173 { background-color: #cc6633 }
.ansi-bg-color-209 { background-color: #ff6633 }
.ansi-bg-color-35 { background-color: #009933 }
.ansi-bg-color-71 { background-color: #339933 }
.ansi-bg-color-107 { background-color: #669933 }
.ansi-bg-color-143 { background-color: #999933 }
.ansi-bg-color-179 { background-color: #cc9933 }
.ansi-bg-color-215 { background-color: #ff9933 }
.ansi-bg-color-41 { background-color: #00cc33 }
.ansi-bg-color-77 { background-color: #33cc33 }
.ansi-bg-color-113 { background-color: #66cc33 }
.ansi-bg-color-149 { background-color: #99cc33 }
.ansi-bg-color-185 { background-color: #cccc33 }
.ansi-bg-color-221 { background-color: #ffcc33 }
.ansi-bg-color-47 { background-color: #00ff33 }
.ansi-bg-color-83 { background-color: #33ff33 }
.ansi-bg-color-119 { background-color: #66ff33 }
.ansi-bg-color-155 { background-color: #99ff33 }
.ansi-bg-color-191 { background-color: #ccff33 }
.ansi-bg-color-227 { background-color: #ffff33 }
.ansi-bg-color-18 { background-color: #000066 }
.ansi-bg-color-54 { background-color: #330066 }
.ansi-bg-color-90 { background-color: #660066 }
.ansi-bg-color-126 { background-color: #990066 }
.ansi-bg-color-162 { background-color: #cc0066 }
.ansi-bg-color-198 { background-color: #ff0066 }
.ansi-bg-color-24 { background-color: #003366 }
.ansi-bg-color-60 { background-color: #333366 }
.ansi-bg-color-96 { background-color: #663366 }
.ansi-bg-color-132 { background-color: #993366 }
.ansi-bg-color-168 { background-color: #cc3366 }
.ansi-bg-color-204 { background-color: #ff3366 }
.ansi-bg-color-30 { background-color: #006666 }
.ansi-bg-color-66 { background-color: #336666 }
.ansi-bg-color-102 { background-color: #666666 }
.ansi-bg-color-138 { background-color: #996666 }
.ansi-bg-color-174 { background-color: #cc6666 }
.ansi-bg-color-210 { background-color: #ff6666 }
.ansi-bg-color-36 { background-color: #009966 }
.ansi-bg-color-72 { background-color: #339966 }
.ansi-bg-color-108 { background-color: #669966 }
.ansi-bg-color-144 { background-color: #999966 }
.ansi-bg-color-180 { background-color: #cc9966 }
.ansi-bg-color-216 { background-color: #ff9966 }
.ansi-bg-color-42 { background-color: #00cc66 }
.ansi-bg-color-78 { background-color: #33cc66 }
.ansi-bg-color-114 { background-color: #66cc66 }
.ansi-bg-color-150 { background-color: #99cc66 }
.ansi-bg-color-186 { background-color: #cccc66 }
.ansi-bg-color-222 { background-color: #ffcc66 }
.ansi-bg-color-48 { background-color: #00ff66 }
.ansi-bg-color-84 { background-color: #33ff66 }
.ansi-bg-color-120 { background-color: #66ff66 }
.ansi-bg-color-156 { background-color: #99ff66 }
.ansi-bg-color-192 { background-color: #ccff66 }
.ansi-bg-color-228 { background-color: #ffff66 }
.ansi-bg-color-19 { background-color: #000099 }
.ansi-bg-color-55 { background-color: #330099 }
.ansi-bg-color-91 { background-color: #660099 }
.ansi-bg-color-127 { background-color: #990099 }
.ansi-bg-color-163 { background-color: #cc0099 }
.ansi-bg-color-199 { background-color: #ff0099 }
.ansi-bg-color-25 { background-color: #003399 }
.ansi-bg-color-61 { background-color: #333399 }
.ansi-bg-color-97 { background-color: #663399 }
.ansi-bg-color-133 { background-color: #993399 }
.ansi-bg-color-169 { background-color: #cc3399 }
.ansi-bg-color-205 { background-color: #ff3399 }
.ansi-bg-color-31 { background-color: #006699 }
.ansi-bg-color-67 { background-color: #336699 }
.ansi-bg-color-103 { background-color: #666699 }
.ansi-bg-color-139 { background-color: #996699 }
.ansi-bg-color-175 { background-color: #cc6699 }
.ansi-bg-color-211 { background-color: #ff6699 }
.ansi-bg-color-37 { background-color: #009999 }
.ansi-bg-color-73 { background-color: #339999 }
.ansi-bg-color-109 { background-color: #669999 }
.ansi-bg-color-145 { background-color: #999999 }
.ansi-bg-color-181 { background-color: #cc9999 }
.ansi-bg-color-217 { background-color: #ff9999 }
.ansi-bg-color-43 { background-color: #00cc99 }
.ansi-bg-color-79 { background-color: #33cc99 }
.ansi-bg-color-115 { background-color: #66cc99 }
.ansi-bg-color-151 { background-color: #99cc99 }
.ansi-bg-color-187 { background-color: #cccc99 }
.ansi-bg-color-223 { background-color: #ffcc99 }
.ansi-bg-color-49 { background-color: #00ff99 }
.ansi-bg-color-85 { background-color: #33ff99 }
.ansi-bg-color-121 { background-color: #66ff99 }
.ansi-bg-color-157 { background-color: #99ff99 }
.ansi-bg-color-193 { background-color: #ccff99 }
.ansi-bg-color-229 { background-color: #ffff99 }
.ansi-bg-color-20 { background-color: #0000cc }
.ansi-bg-color-56 { background-color: #3300cc }
.ansi-bg-color-92 { background-color: #6600cc }
.ansi-bg-color-128 { background-color: #9900cc }
.ansi-bg-color-164 { background-color: #cc00cc }
.ansi-bg-color-200 { background-color: #ff00cc }
.ansi-bg-color-26 { background-color: #0033cc }
.ansi-bg-color-62 { background-color: #3333cc }
.ansi-bg-color-98 { background-color: #6633cc }
.ansi-bg-color-134 { background-color: #9933cc }
.ansi-bg-color-170 { background-color: #cc33cc }
.ansi-bg-color-206 { background-color: #ff33cc }
.ansi-bg-color-32 { background-color: #0066cc }
.ansi-bg-color-68 { background-color: #3366cc }
.ansi-bg-color-104 { background-color: #6666cc }
.ansi-bg-color-140 { background-color: #9966cc }
.ansi-bg-color-176 { background-color: #cc66cc }
.ansi-bg-color-212 { background-color: #ff66cc }
.ansi-bg-color-38 { background-color: #0099cc }
.ansi-bg-color-74 { background-color: #3399cc }
.ansi-bg-color-110 { background-color: #6699cc }
.ansi-bg-color-146 { background-color: #9999cc }
.ansi-bg-color-182 { background-color: #cc99cc }
.ansi-bg-color-218 { background-color: #ff99cc }
.ansi-bg-color-44 { background-color: #00cccc }
.ansi-bg-color-80 { background-color: #33cccc }
.ansi-bg-color-116 { background-color: #66cccc }
.ansi-bg-color-152 { background-color: #99cccc }
.ansi-bg-color-188 { background-color: #cccccc }
.ansi-bg-color-224 { background-color: #ffcccc }
.ansi-bg-color-50 { background-color: #00ffcc }
.ansi-bg-color-86 { background-color: #33ffcc }
.ansi-bg-color-122 { background-color: #66ffcc }
.ansi-bg-color-158 { background-color: #99ffcc }
.ansi-bg-color-194 { background-color: #ccffcc }
.ansi-bg-color-230 { background-color: #ffffcc }
.ansi-bg-color-21 { background-color: #0000ff }
.ansi-bg-color-57 { background-color: #3300ff }
.ansi-bg-color-93 { background-color: #6600ff }
.ansi-bg-color-129 { background-color: #9900ff }
.ansi-bg-color-165 { background-color: #cc00ff }
.ansi-bg-color-201 { background-color: #ff00ff }
.ansi-bg-color-27 { background-color: #0033ff }
.ansi-bg-color-63 { background-color: #3333ff }
.ansi-bg-color-99 { background-color: #6633ff }
.ansi-bg-color-135 { background-color: #9933ff }
.ansi-bg-color-171 { background-color: #cc33ff }
.ansi-bg-color-207 { background-color: #ff33ff }
.ansi-bg-color-33 { background-color: #0066ff }
.ansi-bg-color-69 { background-color: #3366ff }
.ansi-bg-color-105 { background-color: #6666ff }
.ansi-bg-color-141 { background-color: #9966ff }
.ansi-bg-color-177 { background-color: #cc66ff }
.ansi-bg-color-213 { background-color: #ff66ff }
.ansi-bg-color-39 { background-color: #0099ff }
.ansi-bg-color-75 { background-color: #3399ff }
.ansi-bg-color-111 { background-color: #6699ff }
.ansi-bg-color-147 { background-color: #9999ff }
.ansi-bg-color-183 { background-color: #cc99ff }
.ansi-bg-color-219 { background-color: #ff99ff }
.ansi-bg-color-45 { background-color: #00ccff }
.ansi-bg-color-81 { background-color: #33ccff }
.ansi-bg-color-117 { background-color: #66ccff }
.ansi-bg-color-153 { background-color: #99ccff }
.ansi-bg-color-189 { background-color: #ccccff }
.ansi-bg-color-225 { background-color: #ffccff }
.ansi-bg-color-51 { background-color: #00ffff }
.ansi-bg-color-87 { background-color: #33ffff }
.ansi-bg-color-123 { background-color: #66ffff }
.ansi-bg-color-159 { background-color: #99ffff }
.ansi-bg-color-195 { background-color: #ccffff }
.ansi-bg-color-231 { background-color: #ffffff }
.ansi-bg-color-232 { background-color: #0a0a0a }
.ansi-bg-color-233 { background-color: #141414 }
.ansi-bg-color-234 { background-color: #1f1f1f }
.ansi-bg-color-235 { background-color: #292929 }
.ansi-bg-color-236 { background-color: #333333 }
.ansi-bg-color-237 { background-color: #3d3d3d }
.ansi-bg-color-238 { background-color: #474747 }
.ansi-bg-color-239 { background-color: #525252 }
.ansi-bg-color-240 { background-color: #5c5c5c }
.ansi-bg-color-241 { background-color: #666666 }
.ansi-bg-color-242 { background-color: #707070 }
.ansi-bg-color-243 { background-color: #7a7a7a }
.ansi-bg-color-244 { background-color: #858585 }
.ansi-bg-color-245 { background-color: #8f8f8f }
.ansi-bg-color-246 { background-color: #999999 }
.ansi-bg-color-247 { background-color: #a3a3a3 }
.ansi-bg-color-248 { background-color: #adadad }
.ansi-bg-color-249 { background-color: #b8b8b8 }
.ansi-bg-color-250 { background-color: #c2c2c2 }
.ansi-bg-color-251 { background-color: #cccccc }
.ansi-bg-color-252 { background-color: #d6d6d6 }
.ansi-bg-color-253 { background-color: #e0e0e0 }
.ansi-bg-color-254 { background-color: #ebebeb }
.ansi-bg-color-255 { background-color: #f5f5f5 }
cli/tests/testthat/_snaps/text.md 0000644 0001762 0000144 00000001635 14535354370 016632 0 ustar ligges users # text is wrapped
Code
local({
cli_div(class = "testcli", theme = test_style())
cli_h1("Header")
cli_text(lorem_ipsum())
})
Message
Header
Duis quis magna incididunt nulla commodo minim non
exercitation nostrud ullamco dolor exercitation ut veniam.
Fugiat irure tempor commodo voluptate ut. In et tempor
excepteur quis. Qui et nisi ad quis ad cupidatat tempor
laborum est excepteur aliqua veniam. Velit sunt magna
veniam Lorem elit enim et pariatur. Occaecat mollit
consequat dolore in. Veniam officia labore reprehenderit
culpa dolore quis nisi do aliqua commodo deserunt.
Cupidatat nostrud ad est in ad laboris consectetur esse
minim. Irure do anim anim ea mollit ad cupidatat ullamco
ullamco nulla elit in. Lorem Lorem deserunt deserunt et ut
velit nulla nulla ipsum ad laborum quis.
cli/tests/testthat/_snaps/spark.md 0000644 0001762 0000144 00000001060 14535354366 016763 0 ustar ligges users # spark_bar [plain]
Code
spark_bar(seq(0, 1, length = 8))
Output
__,,**##
Code
spark_bar(c(0, NA, 0.5, NA, 1))
Output
_ , #
# spark_bar [unicode]
Code
spark_bar(seq(0, 1, length = 8))
Output
▁▂▃▄▅▆▇█
Code
spark_bar(c(0, NA, 0.5, NA, 1))
Output
▁ ▄ █
# spark_line [plain]
Code
spark_line(seq(0, 1, length = 10))
Output
_,,-^
# spark_line [unicode]
Code
spark_line(seq(0, 1, length = 10))
Output
⣀⡠⠔⠊⠉
cli/tests/testthat/_snaps/inline.md 0000644 0001762 0000144 00000004570 14535354350 017123 0 ustar ligges users # inline classes [plain]
Code
invisible(lapply(classes, do))
Message
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
This is <<>> really
# inline classes [ansi]
Code
invisible(lapply(classes, do))
Message
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
This is [36m<<>>[39m really
# {{ and }} can be used for comments
Code
local({
cli_text("Escaping {{ works")
cli_text("Escaping }} works")
cli_text("Escaping {{ and }} works")
cli_text("Escaping {{{{ works")
cli_text("Escaping }}}} works")
cli_text("Escaping {{{{ and }} works")
cli_text("Escaping {{{{ and }}}} works")
cli_text("Escaping {{ and }}}} works")
})
Message
Escaping { works
Escaping } works
Escaping { and } works
Escaping {{ works
Escaping }} works
Escaping {{ and } works
Escaping {{ and }} works
Escaping { and }} works
# no glue substitution in expressions that evaluate to a string
Code
local({
msg <- "Message with special characters like } { }} {{"
cli_text("{msg}")
cli_text("{.emph {msg}}")
})
Message
Message with special characters like } { }} {{
Message with special characters like } { }} {{
# S3 class is used for styling
Code
local({
cli_div(theme = list(div = list(`class-map` = list(foo = "bar")), .bar = list(
before = "::")))
obj <- structure("yep", class = "foo")
cli_text("This is {obj}.")
})
Message
This is ::yep.
cli/tests/testthat/_snaps/rlang-1.1.0/ 0000755 0001762 0000144 00000000000 14500305721 017041 5 ustar ligges users cli/tests/testthat/_snaps/rlang-1.1.0/rlang-errors.md 0000644 0001762 0000144 00000003063 14500305721 022002 0 ustar ligges users # cli_abort() captures correct call and backtrace
Code
print(expect_error(f()))
Output
Error in `h()`:
! foo
---
Backtrace:
x
1. +-base::print(expect_error(f()))
2. +-testthat::expect_error(f())
3. | \-testthat:::expect_condition_matching(...)
4. | \-testthat:::quasi_capture(...)
5. | +-testthat (local) .capture(...)
6. | | \-base::withCallingHandlers(...)
7. | \-rlang::eval_bare(quo_get_expr(.quo), quo_get_env(.quo))
8. \-cli (local) f()
9. \-cli (local) g()
10. \-cli (local) h()
---
Code
print(expect_error(f(list())))
Output
Error in `h()`:
! `x` can't be empty.
---
Backtrace:
x
1. +-base::print(expect_error(f(list())))
2. +-testthat::expect_error(f(list()))
3. | \-testthat:::expect_condition_matching(...)
4. | \-testthat:::quasi_capture(...)
5. | +-testthat (local) .capture(...)
6. | | \-base::withCallingHandlers(...)
7. | \-rlang::eval_bare(quo_get_expr(.quo), quo_get_env(.quo))
8. \-cli (local) f(list())
9. \-cli (local) g(x)
10. \-cli (local) h(x)
# cli_abort(.internal = TRUE) reports the correct function (r-lib/rlang#1386)
Code
(expect_error(fn()))
Output
Error in `fn()`:
! Message.
i This is an internal error that was detected in the base package.
cli/tests/testthat/_snaps/lists.md 0000644 0001762 0000144 00000026573 14535354357 017021 0 ustar ligges users # ul [plain]
Code
local({
lid <- cli_ul()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
* foo
* bar
* foobar
# ul [unicode]
Code
local({
lid <- cli_ul()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
• foo
• bar
• foobar
# ol [plain]
Code
local({
cli_div(theme = list(ol = list()))
lid <- cli_ol()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
1. foo
2. bar
3. foobar
# ol [unicode]
Code
local({
cli_div(theme = list(ol = list()))
lid <- cli_ol()
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
1. foo
2. bar
3. foobar
# ul ul [plain]
Code
local({
cli_div(theme = list(`ul ul` = list(`list-style-type` = "-", `margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
* 1
- 1 1
- 1 2
- 1 3
* 2
# ul ul [unicode]
Code
local({
cli_div(theme = list(`ul ul` = list(`list-style-type` = "-", `margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
• 1
- 1 1
- 1 2
- 1 3
• 2
# ul ol [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
* 1
1. 1 1
2. 1 2
3. 1 3
* 2
# ul ol [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
• 1
1. 1 1
2. 1 2
3. 1 3
• 2
# ol ol [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2), `li li` = list(
`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
1. 1 1
2. 1 2
3. 1 3
2. 2
# ol ol [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2), `li li` = list(
`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ol()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
1. 1 1
2. 1 2
3. 1 3
2. 2
# ol ul [plain]
Code
local({
cli_div(theme = list(ul = list(`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
* 1 1
* 1 2
* 1 3
2. 2
# ol ul [unicode]
Code
local({
cli_div(theme = list(ul = list(`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_ul()
cli_li("1 1")
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
• 1 1
• 1 2
• 1 3
2. 2
# starting with an item [plain]
Code
local({
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end()
cli_end()
})
Message
* foo
* bar
* foobar
# starting with an item [unicode]
Code
local({
cli_li("foo")
cli_li(c("bar", "foobar"))
cli_end()
cli_end()
})
Message
• foo
• bar
• foobar
# ol, with first item [plain]
Code
local({
cli_div(theme = list(ol = list()))
lid <- cli_ol("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
1. foo
2. bar
3. foobar
# ol, with first item [unicode]
Code
local({
cli_div(theme = list(ol = list()))
lid <- cli_ol("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
1. foo
2. bar
3. foobar
# ul, with first item [plain]
Code
local({
lid <- cli_ul("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
* foo
* bar
* foobar
# ul, with first item [unicode]
Code
local({
lid <- cli_ul("foo", .close = FALSE)
cli_li(c("bar", "foobar"))
cli_end(lid)
})
Message
• foo
• bar
• foobar
# dl [plain]
Code
local({
cli_div(theme = list(ul = list()))
lid <- cli_dl()
cli_li(c(this = "foo"))
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
})
Message
this: foo
that: bar
other: foobar
# dl [unicode]
Code
local({
cli_div(theme = list(ul = list()))
lid <- cli_dl()
cli_li(c(this = "foo"))
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
})
Message
this: foo
that: bar
other: foobar
# dl dl [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
b: 2
# dl dl [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
b: 2
# dl ol [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ol()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
1. 1 1
2. 1 2
3. 1 3
b: 2
# dl ol [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ol()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
1. 1 1
2. 1 2
3. 1 3
b: 2
# dl ul [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ul()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
* 1 1
* 1 2
* 1 3
b: 2
# dl ul [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_dl()
cli_li(c(a = "1"))
lid2 <- cli_ul()
cli_li(c("1 1"))
cli_li(c("1 2", "1 3"))
cli_end(lid2)
cli_li(c(b = "2"))
cli_end(lid)
})
Message
a: 1
• 1 1
• 1 2
• 1 3
b: 2
# ol dl [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
2. 2
# ol dl [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ol()
cli_li("1")
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
1. 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
2. 2
# ul dl [plain]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
* 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
* 2
# ul dl [unicode]
Code
local({
cli_div(theme = list(li = list(`margin-left` = 2)))
lid <- cli_ul()
cli_li("1")
lid2 <- cli_dl()
cli_li(c(`a-a` = "1 1"))
cli_li(c(`a-b` = "1 2", `a-c` = "1 3"))
cli_end(lid2)
cli_li("2")
cli_end(lid)
})
Message
• 1
a-a: 1 1
a-b: 1 2
a-c: 1 3
• 2
# dl, with first item [plain]
Code
local({
cli_div(theme = list(ul = list()))
lid <- cli_dl(c(this = "foo"), .close = FALSE)
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
})
Message
this: foo
that: bar
other: foobar
# dl, with first item [unicode]
Code
local({
cli_div(theme = list(ul = list()))
lid <- cli_dl(c(this = "foo"), .close = FALSE)
cli_li(c(that = "bar", other = "foobar"))
cli_end(lid)
})
Message
this: foo
that: bar
other: foobar
# styling pieces of a dl [ansi]
Code
local({
cli_div(theme = list(.dt = list(postfix = " -> "), .dd = list(color = "blue")))
cli_dl(c(foo = "bar", bar = "baz"))
})
Message
foo -> [34mbar[39m
bar -> [34mbaz[39m
# cli_dl edge cases
Code
cli_dl("foo", "must be a named character vector")
Condition
Error:
! `items` must be a named character vector
i `items` is not named
---
Code
cli_dl(c(abc = "foo", empty = "", def = "bar"))
Message
abc: foo
empty:
def: bar
# cli_dl label style
Code
local({
cli_dl(c(`{.code code}` = "{.code this is code too}", `{.str strin}` = "{.url https://x.com}"))
})
Message
`code`: `this is code too`
"strin":
cli/tests/testthat/_snaps/progress-client.md 0000644 0001762 0000144 00000003203 14535354363 020761 0 ustar ligges users # cli_progress_bar
Code
capture_cli_messages(fun())
Output
[1] "\\ name status 1\n"
# removes previous progress bar
Code
capture_cli_messages(fun())
Output
[1] "first\n" "first done\n" "\n" "second\n"
[5] "second done\n" "\n"
# cli_progress_update can update status
Code
capture_cli_messages(fun())
Output
[1] "\\ name status 1\n" "| name new status 2\n"
# cli_progress_update can update extra data
Code
capture_cli_messages(fun())
Output
[1] "Extra: bar\n" "Extra: baz\n"
# update set
Code
capture_cli_messages(fun())
Output
[1] "name 1/100\n" "name 50/100\n"
# format changes if we (un)learn total
Code
out
Output
[1] "\\ name 1 done (100/s) | 3ms\n"
[2] "name ===============>--------------- 50% | ETA: 1s\n"
[3] "/ name 75 done (100/s) | 3ms\n"
# auto-terminate
Code
capture_cli_messages(fun())
Output
[1] "first\n" "first done\n"
[3] "\n" "First is done by now.\n"
[5] "second\n" "second done\n"
[7] "\n"
# cli_progress_output
Code
capture_cli_messages(fun())
Output
[1] "\rfirst\033[K\r" "\r\033[K" "just 1 text\n" "first\r"
[5] "\rfirst\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun())
Output
[1] "\rfirst\r" "\r \r" "just 1 text\n" "first\r"
[5] "\rfirst\r" "\r \r"
cli/tests/testthat/_snaps/new-r/ 0000755 0001762 0000144 00000000000 14314545341 016342 5 ustar ligges users cli/tests/testthat/_snaps/new-r/inline-2.md 0000644 0001762 0000144 00000000401 14535354347 020305 0 ustar ligges users # various errors
Code
cli_text("xx {__cannot-parse-this__} yy")
Condition
Error:
! Could not parse cli `{}` expression: `__cannot-parse-th...`.
Caused by error:
! :1:2: unexpected input
1: __
^
cli/tests/testthat/_snaps/utf8/ 0000755 0001762 0000144 00000000000 14535536335 016210 5 ustar ligges users cli/tests/testthat/_snaps/utf8/utf8-output.txt 0000644 0001762 0000144 00000006444 14506533474 021204 0 ustar ligges users
── Alerts ────────────────────────────────────────────────────────────
→ マルチバイトのタイトル
✖ árvíztűrő tükörfúrógép
ℹ マルチバイトのタイトル
✔ マルチバイトのタイトル
! マルチバイトのタイトル
── Block quote ───────────────────────────────────────────────────────
“マルチバイトのタイトル”
— árvíztűrő tükörfúrógép
── Bullets ───────────────────────────────────────────────────────────
• マルチバイトのタイトル
! árvíztűrő tükörfúrógép
── Code ──────────────────────────────────────────────────────────────
マルチバイトのタイトル
árvíztűrő tükörfúrógép
── Lists ─────────────────────────────────────────────────────────────
s1: マルチバイトのタイトル
s2: árvíztűrő tükörfúrógép
1. マルチバイトのタイトル
2. árvíztűrő tükörfúrógép
• マルチバイトのタイトル
• árvíztűrő tükörfúrógép
── Headers ───────────────────────────────────────────────────────────
── マルチバイトのタイトル ────────────────────────────────────────────
── árvíztűrő tükörfúrógép ──
── マルチバイトのタイトル
── Progress bars ─────────────────────────────────────────────────────
ℹ マルチバイトのタイトル
✔ マルチバイトのタイトル [1s]
ℹ árvíztűrő tükörfúrógép
✔ árvíztűrő tükörfúrógép [1s]
── Text ──────────────────────────────────────────────────────────────
マルチバイトのタイトル árvíztűrő tükörfúrógép マルチバイトのタイトル
árvíztűrő tükörfúrógép マルチバイトのタイトル マルチバイトのタイトル
マルチバイトのタイトル マルチバイトのタイトル árvíztűrő tükörfúrógép
マルチバイトのタイトル árvíztűrő tükörfúrógép マルチバイトのタイトル
マルチバイトのタイトル マルチバイトのタイトル マルチバイトのタイトル
── Verbatim ──────────────────────────────────────────────────────────
マルチバイトのタイトル
árvíztűrő tükörfúrógép
cli/tests/testthat/_snaps/glue.md 0000644 0001762 0000144 00000001744 14535354346 016606 0 ustar ligges users # glue quotes and comments
Code
cli_dl(c(test_1 = "all good", test_2 = "not #good"))
Message
test_1: all good
test_2: not #good
Code
cli::cli_dl(c(test_3 = "no' good either"))
Message
test_3: no' good either
Code
cli::cli_dl(c(test_4 = "no\" good also"))
Message
test_4: no" good also
Code
cli::cli_text("{.url https://example.com/#section}")
Message
Code
cli::cli_alert_success("Qapla'")
Message
v Qapla'
# quotes, etc. within expressions are still OK
Code
cli::cli_text("{.url URL} {x <- 'foo'; nchar(x)}")
Message
3
Code
cli::cli_text("{.url URL} {x <- \"foo\"; nchar(x)}")
Message
3
Code
cli::cli_text("{.url URL} {1 + 1 # + 1} {1 + 1}")
Message
2 2
# { } is parsed with literal = FALSE
Code
format_message("{.emph {'{foo {}'}}")
Output
[1] "{foo {}"
cli/tests/testthat/_snaps/progress-ticking.md 0000644 0001762 0000144 00000000365 14535354364 021142 0 ustar ligges users # ticking
Code
out
Output
[1] "\r1/10\033[K\r" "\r2/10\033[K\r" "\r3/10\033[K\r" "\r4/10\033[K\r"
[5] "\r5/10\033[K\r" "\r6/10\033[K\r" "\r7/10\033[K\r" "\r8/10\033[K\r"
[9] "\r9/10\033[K\r" "\r\033[K"
cli/tests/testthat/_snaps/console-width.md 0000644 0001762 0000144 00000000366 14535354345 020427 0 ustar ligges users # errors
! `options("cli.width")` must be an integer scalar.
i `options("cli.width")` is a character vector.
---
! `options("cli.width")` cannot be `NA`.
---
! `options("cli.width")` must be a positive integer and not -100.
cli/tests/testthat/_snaps/ansi-make.md 0000644 0001762 0000144 00000001766 14535354337 017523 0 ustar ligges users # errors
Code
make_ansi_style(1:10)
Condition
Error:
! `style` must be an ANSI style
i an ANSI style is a character scalar (cli style name, RGB or R color name), or a [3x1] or [4x1] numeric RGB matrix
i `style` is an integer vector
# make_ansi_style
Code
make_ansi_style(1:10)
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`style` must be an ANSI style
[36mi[39m an ANSI style is a character scalar (cli style name, RGB or R color name), or a [3x1] or [4x1] numeric RGB matrix
[36mi[39m `style` is an integer vector
---
Code
make_ansi_style("foobar")
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22mUnknown style specification: [34m"style"[39m, it must be one of
[36m*[39m a builtin cli style, e.g. [34m"bold"[39m or [34m"red"[39m,
[36m*[39m an R color name, see `?grDevices::colors()`.
[36m*[39m a [3x1] or [4x1] numeric RGB matrix with, range 0-255.
cli/tests/testthat/_snaps/defer.md 0000644 0001762 0000144 00000000261 14535354345 016727 0 ustar ligges users # errors
Code
fun()
Condition
Error:
! Error in a deferred `on.exit()` clause
Caused by error:
! non-numeric argument to binary operator
cli/tests/testthat/_snaps/keypress.md 0000644 0001762 0000144 00000004350 14535354353 017511 0 ustar ligges users # control characaters
Code
for (code in c(1:2, 4:6, 8:14, 16L, 20L, 21L, 23L, 27L, 127L)) {
p$write_input("cli::keypress()\n")
Sys.sleep(0.1)
p$write_input(as.raw(code))
p$poll_io(1000)
cat(p$read_output())
}
Output
[1] "ctrl-a"
[1] "ctrl-b"
[1] "ctrl-d"
[1] "ctrl-e"
[1] "ctrl-f"
[1] "ctrl-h"
[1] "tab"
[1] "enter"
[1] "ctrl-k"
[1] "ctrl-l"
[1] "enter"
[1] "ctrl-n"
[1] "ctrl-p"
[1] "ctrl-t"
[1] "ctrl-u"
[1] "ctrl-w"
[1] "escape"
[1] "backspace"
# write ahead
Code
p$write_input("{ Sys.sleep(0.5); cli::keypress() }\nX")
p$poll_io(1000)
Output
output error process
"ready" "nopipe" "silent"
Code
cat(p$read_output())
Output
[1] "X"
# arrows, etc
Code
for (key in keys) {
p$write_input("cli::keypress()\n")
p$write_input(key)
p$poll_io(1000)
cat(p$read_output())
}
Output
[1] "up"
[1] "right"
[1] "left"
[1] "end"
[1] "home"
[1] "-"
[1] "up"
[1] "down"
[1] "right"
[1] "left"
[1] "end"
[1] "home"
[1] "-"
[1] "home"
[1] "insert"
[1] "delete"
[1] "end"
[1] "pageup"
[1] "pagedown"
[1] "-"
[1] "pageup"
[1] "pagedown"
[1] "-"
[1] "home"
[1] "end"
[1] "-"
[1] "f1"
[1] "f2"
[1] "f3"
[1] "f4"
[1] "-"
[1] "f5"
[1] "f6"
[1] "f7"
[1] "f8"
[1] "f9"
[1] "f10"
[1] "f11"
[1] "f12"
[1] "-"
[1] "f1"
[1] "f2"
[1] "f3"
[1] "f4"
[1] "-"
[1] "escape"
# nonblocking
Code
p$write_input("cli::keypress(block = FALSE)\n")
p$poll_io(1000)
Output
output error process
"ready" "nopipe" "silent"
Code
cat(p$read_output())
Output
[1] NA
---
Code
p$write_input("{ Sys.sleep(0.5); cli::keypress() }\nX")
p$poll_io(1000)
Output
output error process
"ready" "nopipe" "silent"
Code
cat(p$read_output())
Output
[1] "X"
cli/tests/testthat/_snaps/ansi.md 0000644 0001762 0000144 00000000746 14535354337 016605 0 ustar ligges users # print.cli_ansi_style
Code
print(col_red)
Output
Example output
# print.cli_ansi_string
Code
print(col_red("red"))
Output
[1] [31mred[39m
# ansi-scale
Code
ansi_scale(c(0, 0, 0))
Output
[1] 0 0 0
Code
ansi_scale(c(255, 100, 0))
Output
[1] 5 2 0
Code
ansi_scale(c(255, 100, 0), round = FALSE)
Output
[1] 5.000000 1.960784 0.000000
cli/tests/testthat/_snaps/collapsing.md 0000644 0001762 0000144 00000023715 14535354344 020005 0 ustar ligges users # collapsing without formatting, n>3
Code
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {pkgs}.")
Message
Packages: pkg1, pkg2, pkg3, pkg4, and pkg5.
# collapsing without formatting, n<3
Code
pkgs <- paste0("pkg", 1:2)
cli_text("Packages: {pkgs}.")
Message
Packages: pkg1 and pkg2.
# collapsing with formatting
Code
local({
cli_div(theme = list(.pkg = list(fmt = function(x) paste0(x, " (P)"))))
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {.pkg {pkgs}}.")
})
Message
Packages: pkg1 (P), pkg2 (P), pkg3 (P), pkg4 (P), and pkg5 (P).
# collapsing with formatting, custom seps
Code
local({
cli_div(theme = list(div = list(`vec-sep` = " ... ")))
pkgs <- paste0("pkg", 1:5)
cli_text("Packages: {.pkg {pkgs}}.")
})
Message
Packages: pkg1 ... pkg2 ... pkg3 ... pkg4, and pkg5.
# collapsing a cli_vec
Code
pkgs <- cli_vec(paste0("pkg", 1:5), style = list(`vec-sep` = " & ", `vec-last` = " & "))
cli_text("Packages: {pkgs}.")
Message
Packages: pkg1 & pkg2 & pkg3 & pkg4 & pkg5.
# collapsing a cli_vec with styling [plain]
Code
local({
cli_div(theme = list(body = list(`vec-sep` = " ... ")))
pkgs <- cli_vec(paste0("pkg", 1:5), style = list(`vec-sep` = " & ",
`vec-last` = " & ", color = "blue"))
cli_text("Packages: {pkgs}.")
})
Message
Packages: pkg1 & pkg2 & pkg3 & pkg4 & pkg5.
# collapsing a cli_vec with styling [ansi]
Code
local({
cli_div(theme = list(body = list(`vec-sep` = " ... ")))
pkgs <- cli_vec(paste0("pkg", 1:5), style = list(`vec-sep` = " & ",
`vec-last` = " & ", color = "blue"))
cli_text("Packages: {pkgs}.")
})
Message
Packages: [34mpkg1[39m & [34mpkg2[39m & [34mpkg3[39m & [34mpkg4[39m & [34mpkg5[39m.
# head
Code
cli_text("{v(0,1)}")
Message
Code
cli_text("{v(1,1)}")
Message
1
Code
cli_text("{v(2,1)}")
Message
1 and 2
Code
cli_text("{v(3,1)}")
Message
1, ...
Code
cli_text("{v(4,1)}")
Message
1, ...
Code
cli_text("{v(0,2)}")
Message
Code
cli_text("{v(1,2)}")
Message
1
Code
cli_text("{v(2,2)}")
Message
1 and 2
Code
cli_text("{v(3,2)}")
Message
1, 2, ...
Code
cli_text("{v(4,2)}")
Message
1, 2, ...
Code
cli_text("{v(0,3)}")
Message
Code
cli_text("{v(1,3)}")
Message
1
Code
cli_text("{v(2,3)}")
Message
1 and 2
Code
cli_text("{v(3,3)}")
Message
1, 2, and 3
Code
cli_text("{v(4,3)}")
Message
1, 2, 3, ...
Code
cli_text("{v(0,4)}")
Message
Code
cli_text("{v(1,4)}")
Message
1
Code
cli_text("{v(2,4)}")
Message
1 and 2
Code
cli_text("{v(3,4)}")
Message
1, 2, and 3
Code
cli_text("{v(4,4)}")
Message
1, 2, 3, and 4
Code
cli_text("{v(0,5)}")
Message
Code
cli_text("{v(1,5)}")
Message
1
Code
cli_text("{v(2,5)}")
Message
1 and 2
Code
cli_text("{v(3,5)}")
Message
1, 2, and 3
Code
cli_text("{v(4,5)}")
Message
1, 2, 3, and 4
Code
cli_text("{v(10,5)}")
Message
1, 2, 3, 4, 5, ...
# both-ends
Code
cli_text("{v(0,1)}")
Message
Code
cli_text("{v(1,1)}")
Message
1
Code
cli_text("{v(2,1)}")
Message
1 and 2
Code
cli_text("{v(3,1)}")
Message
1, 2, and 3
Code
cli_text("{v(4,1)}")
Message
1, 2, 3, and 4
Code
cli_text("{v(5,1)}")
Message
1, 2, 3, 4, and 5
Code
cli_text("{v(6,1)}")
Message
1, 2, 3, ..., 5, and 6
Code
cli_text("{v(7,1)}")
Message
1, 2, 3, ..., 6, and 7
Code
cli_text("{v(10,1)}")
Message
1, 2, 3, ..., 9, and 10
# both-ends with formatting [plain]
Code
cli_text("{.val {v(0,1)}}")
Message
Code
cli_text("{.val {v(1,1)}}")
Message
1
Code
cli_text("{.val {v(2,1)}}")
Message
1 and 2
Code
cli_text("{.val {v(3,1)}}")
Message
1, 2, and 3
Code
cli_text("{.val {v(4,1)}}")
Message
1, 2, 3, and 4
Code
cli_text("{.val {v(5,1)}}")
Message
1, 2, 3, 4, and 5
Code
cli_text("{.val {v(6,1)}}")
Message
1, 2, 3, ..., 5, and 6
Code
cli_text("{.val {v(7,1)}}")
Message
1, 2, 3, ..., 6, and 7
Code
cli_text("{.val {v(10,1)}}")
Message
1, 2, 3, ..., 9, and 10
Code
cli_text("{.val {v(10,6)}}")
Message
1, 2, 3, 4, ..., 9, and 10
Code
cli_text("{.val {v(10,10)}}")
Message
1, 2, 3, 4, 5, 6, 7, 8, 9, and 10
Code
cli_text("{.val {v(11,10)}}")
Message
1, 2, 3, 4, 5, 6, 7, 8, ..., 10, and 11
# both-ends with formatting [ansi]
Code
cli_text("{.val {v(0,1)}}")
Message
Code
cli_text("{.val {v(1,1)}}")
Message
[34m1[39m
Code
cli_text("{.val {v(2,1)}}")
Message
[34m1[39m and [34m2[39m
Code
cli_text("{.val {v(3,1)}}")
Message
[34m1[39m, [34m2[39m, and [34m3[39m
Code
cli_text("{.val {v(4,1)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, and [34m4[39m
Code
cli_text("{.val {v(5,1)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, [34m4[39m, and [34m5[39m
Code
cli_text("{.val {v(6,1)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, ..., [34m5[39m, and [34m6[39m
Code
cli_text("{.val {v(7,1)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, ..., [34m6[39m, and [34m7[39m
Code
cli_text("{.val {v(10,1)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, ..., [34m9[39m, and [34m10[39m
Code
cli_text("{.val {v(10,6)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, [34m4[39m, ..., [34m9[39m, and [34m10[39m
Code
cli_text("{.val {v(10,10)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, [34m4[39m, [34m5[39m, [34m6[39m, [34m7[39m, [34m8[39m, [34m9[39m, and [34m10[39m
Code
cli_text("{.val {v(11,10)}}")
Message
[34m1[39m, [34m2[39m, [34m3[39m, [34m4[39m, [34m5[39m, [34m6[39m, [34m7[39m, [34m8[39m, ..., [34m10[39m, and [34m11[39m
# ansi_collapse
Code
ansi_collapse(l10)
Output
[1] "a, b, c, d, e, f, g, h, i, and j"
Code
ansi_collapse(l10, trunc = 6)
Output
[1] "a, b, c, d, ..., i, and j"
Code
ansi_collapse(l10, trunc = 5)
Output
[1] "a, b, c, ..., i, and j"
Code
ansi_collapse(l10, trunc = 4)
Output
[1] "a, b, c, ..., i, and j"
Code
ansi_collapse(l10, trunc = 1)
Output
[1] "a, b, c, ..., i, and j"
Code
ansi_collapse(l10, sep = "; ")
Output
[1] "a; b; c; d; e; f; g; h; i, and j"
Code
ansi_collapse(l10, sep = "; ", last = "; or ")
Output
[1] "a; b; c; d; e; f; g; h; i; or j"
Code
ansi_collapse(l10, sep = "; ")
Output
[1] "a; b; c; d; e; f; g; h; i, and j"
Code
ansi_collapse(l10, sep = "; ", last = "; or ", trunc = 6)
Output
[1] "a; b; c; d; ...; i; or j"
Code
ansi_collapse(l10, style = "head")
Output
[1] "a, b, c, d, e, f, g, h, i, and j"
Code
ansi_collapse(l10, trunc = 6, style = "head")
Output
[1] "a, b, c, d, e, f, ..."
Code
ansi_collapse(l10, trunc = 5, style = "head")
Output
[1] "a, b, c, d, e, ..."
Code
ansi_collapse(l10, trunc = 4, style = "head")
Output
[1] "a, b, c, d, ..."
Code
ansi_collapse(l10, trunc = 1, style = "head")
Output
[1] "a, ..."
Code
ansi_collapse(l10, sep = "; ", style = "head")
Output
[1] "a; b; c; d; e; f; g; h; i, and j"
Code
ansi_collapse(l10, sep = "; ", last = "; or ", style = "head")
Output
[1] "a; b; c; d; e; f; g; h; i; or j"
Code
ansi_collapse(l10, sep = "; ", last = "; or ", trunc = 6, style = "head")
Output
[1] "a; b; c; d; e; f; ..."
# ansi_collapse with width trimming
Code
ansi_collapse(l10, width = 1, style = "head")
Output
[1] .
Code
ansi_collapse(l10, width = 2, style = "head")
Output
[1] ..
Code
ansi_collapse(l10, width = 3, style = "head")
Output
[1] "..."
Code
ansi_collapse(l10, width = 4, style = "head")
Output
[1] "a..."
Code
ansi_collapse(l10, width = 5, style = "head")
Output
[1] "a..."
Code
ansi_collapse(l10, width = 6, style = "head")
Output
[1] "a, ..."
Code
ansi_collapse(l10, width = 7, style = "head")
Output
[1] "a, ..."
Code
ansi_collapse(l10, width = 8, style = "head")
Output
[1] "a, ..."
Code
ansi_collapse(l10, width = 9, style = "head")
Output
[1] "a, b, ..."
Code
ansi_collapse(l10, width = 30, style = "head")
Output
[1] "a, b, c, d, e, f, g, h, i, ..."
Code
ansi_collapse(l10, width = 31, style = "head")
Output
[1] "a, b, c, d, e, f, g, h, i, ..."
Code
ansi_collapse(l10, width = 32, style = "head")
Output
[1] "a, b, c, d, e, f, g, h, i, and j"
Code
ansi_collapse(l10, width = 40, style = "head")
Output
[1] "a, b, c, d, e, f, g, h, i, and j"
---
Code
ansi_collapse(l10, width = 10, style = "both-ends")
Condition
Warning in `collapse_both_ends()`:
! finite `width` is not implemented in `cli::ansi_collapse()`.
i `width = Inf` is used instead.
Output
[1] "a, b, c, d, e, f, g, h, i, and j"
cli/tests/testthat/_snaps/inline-2.md 0000644 0001762 0000144 00000026344 14535354347 017273 0 ustar ligges users # quoting phrases that don't start or end with letter or number [plain]
Code
local({
x0 <- "good-name"
cli_text("The name is {.file {x0}}.")
x <- "weird-name "
cli_text("The name is {.file {x}}.")
cli_text("The name is {.path {x}}.")
cli_text("The name is {.email {x}}.")
})
Message
The name is 'good-name'.
The name is 'weird-name '.
The name is 'weird-name '.
The name is 'weird-name '.
# quoting phrases that don't start or end with letter or number [ansi]
Code
local({
x0 <- "good-name"
cli_text("The name is {.file {x0}}.")
x <- "weird-name "
cli_text("The name is {.file {x}}.")
cli_text("The name is {.path {x}}.")
cli_text("The name is {.email {x}}.")
})
Message
The name is [34mgood-name[39m.
The name is '[34mweird-name[39m[44m [49m'.
The name is '[34mweird-name[39m[44m [49m'.
The name is '[34mweird-name[39m[44m [49m'.
# quoting weird names, still [plain]
Code
local({
cat_line(nb(quote_weird_name("good")))
cat_line(nb(quote_weird_name(" bad")))
cat_line(nb(quote_weird_name("bad ")))
cat_line(nb(quote_weird_name(" bad ")))
})
Output
'good'
' bad'
'bad '
' bad '
# quoting weird names, still [ansi]
Code
local({
cat_line(nb(quote_weird_name("good")))
cat_line(nb(quote_weird_name(" bad")))
cat_line(nb(quote_weird_name("bad ")))
cat_line(nb(quote_weird_name(" bad ")))
})
Output
good
'[44m [49mbad'
'bad[44m [49m'
'[44m [49mbad[44m [49m'
# ~/ files are not weird [ansi]
Code
local({
cat_line(nb(quote_weird_name("~/good")))
cat_line(nb(quote_weird_name("~~bad")))
cat_line(nb(quote_weird_name("bad~ ")))
cat_line(nb(quote_weird_name(" ~ bad ~ ")))
})
Output
~/good
'~~bad'
'bad~[44m [49m'
'[44m [49m~ bad ~[44m [49m'
# custom truncation [plain]
Code
x <- cli_vec(1:100, list(`vec-trunc` = 5))
cli_text("Some numbers: {x}.")
Message
Some numbers: 1, 2, 3, ..., 99, and 100.
Code
cli_text("Some numbers: {.val {x}}.")
Message
Some numbers: 1, 2, 3, ..., 99, and 100.
# custom truncation [ansi]
Code
x <- cli_vec(1:100, list(`vec-trunc` = 5))
cli_text("Some numbers: {x}.")
Message
Some numbers: 1, 2, 3, ..., 99, and 100.
Code
cli_text("Some numbers: {.val {x}}.")
Message
Some numbers: [34m1[39m, [34m2[39m, [34m3[39m, ..., [34m99[39m, and [34m100[39m.
# custom truncation [unicode]
Code
x <- cli_vec(1:100, list(`vec-trunc` = 5))
cli_text("Some numbers: {x}.")
Message
Some numbers: 1, 2, 3, …, 99, and 100.
Code
cli_text("Some numbers: {.val {x}}.")
Message
Some numbers: 1, 2, 3, …, 99, and 100.
# custom truncation [fancy]
Code
x <- cli_vec(1:100, list(`vec-trunc` = 5))
cli_text("Some numbers: {x}.")
Message
Some numbers: 1, 2, 3, …, 99, and 100.
Code
cli_text("Some numbers: {.val {x}}.")
Message
Some numbers: [34m1[39m, [34m2[39m, [34m3[39m, …, [34m99[39m, and [34m100[39m.
# collapsing class names [plain]
Code
local({
cc <- c("one", "two")
cli_text("this is a class: {.cls myclass}")
cli_text("multiple classes: {.cls {cc}}")
})
Message
this is a class:
multiple classes:
# collapsing class names [ansi]
Code
local({
cc <- c("one", "two")
cli_text("this is a class: {.cls myclass}")
cli_text("multiple classes: {.cls {cc}}")
})
Message
this is a class: [34m[39m
multiple classes: [34m[39m
# transform [plain]
Code
local({
cli_text("This is a {.field field} (before)")
foo <- (function(x) toupper(x))
cli_div(theme = list(span.field = list(transform = foo)))
cli_text("This is a {.field field} (during)")
cli_end()
cli_text("This is a {.field field} (after)")
})
Message
This is a field (before)
This is a FIELD (during)
This is a field (after)
# transform [ansi]
Code
local({
cli_text("This is a {.field field} (before)")
foo <- (function(x) toupper(x))
cli_div(theme = list(span.field = list(transform = foo)))
cli_text("This is a {.field field} (during)")
cli_end()
cli_text("This is a {.field field} (after)")
})
Message
This is a [32mfield[39m (before)
This is a [32mFIELD[39m (during)
This is a [32mfield[39m (after)
# cli_format
Code
cli_format(1:4 / 7, list(digits = 2))
Output
[1] 0.14 0.29 0.43 0.57
# cli_format() is used for .val
Code
local({
cli_div(theme = list(.val = list(digits = 2)))
cli_text("Some random numbers: {.val {runif(4)}}.")
})
Message
Some random numbers: 0.91, 0.94, 0.29, and 0.83.
# .q always double quotes
Code
cli_text("just a {.q string}, nothing more")
Message
just a "string", nothing more
# .or
Code
cli_text("{.or {letters[1:5]}}")
Message
a, b, c, d, or e
---
Code
cli_text("{.or {letters[1:2]}}")
Message
a or b
# line breaks
Code
ansi_strwrap(txt2, width = 60)
Output
[1] Cupidatat deserunt culpa enim deserunt minim aliqua tempor
[2] fugiat cupidatat laboris officia esse ex aliqua. Ullamco
[3] mollit adipisicing anim.
[4] Cupidatat deserunt culpa enim deserunt minim aliqua tempor
[5] fugiat cupidatat laboris officia esse ex aliqua. Ullamco
[6] mollit adipisicing anim.
# double ticks [ansi]
Code
format_inline("{.code {x}}")
Output
[1] "\033[31m`a`\033[39m, \033[31m`` `x` ``\033[39m, and \033[31m`b`\033[39m"
---
Code
format_inline("{.fun {x}}")
Output
[1] "\033[31m`a()`\033[39m, \033[31m`` `x` ()``\033[39m, and \033[31m`b()`\033[39m"
# do not inherit 'transform' issue #422
Code
d <- deparse(c("cli", "glue"))
cli::cli_alert_info("To install, run {.code install.packages({d})}")
Message
i To install, run `install.packages(c("cli", "glue"))`
---
Code
cli::cli_text("{.code foo({1+1})}")
Message
`foo(2)`
# no inherit color, issue #474 [plain]
Code
cli::cli_text("pre {.val x {'foo'} y} post")
Message
pre "x foo y" post
# no inherit color, issue #474 [ansi]
Code
cli::cli_text("pre {.val x {'foo'} y} post")
Message
pre [34m"x foo y"[39m post
# \f at the end, issue #491 [plain]
Code
cli_fmt(cli::cli_text("{.val a}{.val b}"))
Output
[1] "\"a\"\"b\""
Code
cli_fmt(cli::cli_text("\f{.val a}{.val b}"))
Output
[1] "" "\"a\"\"b\""
Code
cli_fmt(cli::cli_text("\f\f{.val a}{.val b}"))
Output
[1] "" "" "\"a\"\"b\""
Code
cli_fmt(cli::cli_text("{.val a}\f{.val b}"))
Output
[1] "\"a\"" "\"b\""
Code
cli_fmt(cli::cli_text("{.val a}\f\f{.val b}"))
Output
[1] "\"a\"" "" "\"b\""
Code
cli_fmt(cli::cli_text("{.val a}{.val b}\f"))
Output
[1] "\"a\"\"b\"" ""
Code
cli_fmt(cli::cli_text("{.val a}{.val b}\f\f"))
Output
[1] "\"a\"\"b\"" "" ""
Code
cli_fmt(cli::cli_text("\f\f\f{.val a}\f\f\f{.val b}\f\f\f"))
Output
[1] "" "" "" "\"a\"" "" "" "\"b\"" "" ""
[10] ""
# \f at the end, issue #491 [ansi]
Code
cli_fmt(cli::cli_text("{.val a}{.val b}"))
Output
[1] "\033[34m\"a\"\"b\"\033[39m"
Code
cli_fmt(cli::cli_text("\f{.val a}{.val b}"))
Output
[1] "" "\033[34m\"a\"\"b\"\033[39m"
Code
cli_fmt(cli::cli_text("\f\f{.val a}{.val b}"))
Output
[1] "" ""
[3] "\033[34m\"a\"\"b\"\033[39m"
Code
cli_fmt(cli::cli_text("{.val a}\f{.val b}"))
Output
[1] "\033[34m\"a\"\033[39m" "\033[34m\"b\"\033[39m"
Code
cli_fmt(cli::cli_text("{.val a}\f\f{.val b}"))
Output
[1] "\033[34m\"a\"\033[39m" "" "\033[34m\"b\"\033[39m"
Code
cli_fmt(cli::cli_text("{.val a}{.val b}\f"))
Output
[1] "\033[34m\"a\"\"b\"\033[39m" ""
Code
cli_fmt(cli::cli_text("{.val a}{.val b}\f\f"))
Output
[1] "\033[34m\"a\"\"b\"\033[39m" ""
[3] ""
Code
cli_fmt(cli::cli_text("\f\f\f{.val a}\f\f\f{.val b}\f\f\f"))
Output
[1] "" "" ""
[4] "\033[34m\"a\"\033[39m" "" ""
[7] "\033[34m\"b\"\033[39m" "" ""
[10] ""
# truncate vectors at 20
Code
cli::cli_text("Some letters: {letters}")
Message
Some letters: a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, ..., y, and
z
# brace expresssion edge cases [ansi]
Code
cli_text("{.code {foo} and {bar}}")
Message
`foo and bar`
Code
cli_text("{.emph {foo} and {bar}}")
Message
[3mfoo and bar[23m
Code
cli_text("{.q {foo} and {bar}}")
Message
"foo and bar"
# various errors
! Invalid cli literal: `{.foobar}` starts with a dot.
i Interpreted literals must not start with a dot in cli >= 3.4.0.
i `{}` expressions starting with a dot are now only used for cli styles.
i To avoid this error, put a space character after the starting `{` or use parentheses: `{(.foobar)}`.
---
! Invalid cli literal: `{.someve...}` starts with a dot.
i Interpreted literals must not start with a dot in cli >= 3.4.0.
i `{}` expressions starting with a dot are now only used for cli styles.
i To avoid this error, put a space character after the starting `{` or use parentheses: `{(.someve...)}`.
---
Code
cli_text("xx {1 + 'a'} yy")
Condition
Error:
! Could not evaluate cli `{}` expression: `1 + 'a'`.
Caused by error:
! non-numeric argument to binary operator
# format_inline and newlines
Code
format_inline("foo\nbar")
Output
[1] "foo\nbar"
Code
format_inline("\nfoo\n\nbar\n")
Output
[1] "\nfoo\n\nbar\n"
Code
format_inline("foo\fbar")
Output
[1] "foo\fbar"
Code
format_inline("\ffoo\f\fbar\f")
Output
[1] "\ffoo\f\fbar\f"
---
Code
format_inline("foo\nbar", keep_whitespace = FALSE)
Output
[1] "foo bar"
Code
format_inline("\nfoo\n\nbar\n", keep_whitespace = FALSE)
Output
[1] "foo\n\nbar"
Code
format_inline("foo\fbar", keep_whitespace = FALSE)
Output
[1] "foo\nbar"
Code
format_inline("\ffoo\f\fbar\f", keep_whitespace = FALSE)
Output
[1] "\nfoo\n\nbar\n"
cli/tests/testthat/_snaps/meta.md 0000644 0001762 0000144 00000012631 14535354357 016577 0 ustar ligges users # meta basics [plain]
Code
cli::cli({
message("This is before")
cli_alert_info("First message")
message("This as well")
cli_alert_success("Success!")
})
Message
This is before
This as well
i First message
v Success!
# meta basics [ansi]
Code
cli::cli({
message("This is before")
cli_alert_info("First message")
message("This as well")
cli_alert_success("Success!")
})
Message
This is before
This as well
[36mi[39m First message
[32mv[39m Success!
# meta basics [unicode]
Code
cli::cli({
message("This is before")
cli_alert_info("First message")
message("This as well")
cli_alert_success("Success!")
})
Message
This is before
This as well
ℹ First message
✔ Success!
# meta basics [fancy]
Code
cli::cli({
message("This is before")
cli_alert_info("First message")
message("This as well")
cli_alert_success("Success!")
})
Message
This is before
This as well
[36mℹ[39m First message
[32m✔[39m Success!
# meta is single cli_message [plain]
Code
cli_server_default(msgs[[1]])
Message
i First message
v Success!
Output
NULL
# meta is single cli_message [ansi]
Code
cli_server_default(msgs[[1]])
Message
[36mi[39m First message
[32mv[39m Success!
Output
NULL
# meta is single cli_message [unicode]
Code
cli_server_default(msgs[[1]])
Message
ℹ First message
✔ Success!
Output
NULL
# meta is single cli_message [fancy]
Code
cli_server_default(msgs[[1]])
Message
[36mℹ[39m First message
[32m✔[39m Success!
Output
NULL
# meta is single cliMessage [plain]
Code
withCallingHandlers(cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}), cliMessage = function(msg) {
msgs <<- c(msgs, list(msg))
})
Message
i First message
v Success!
# meta is single cliMessage [ansi]
Code
withCallingHandlers(cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}), cliMessage = function(msg) {
msgs <<- c(msgs, list(msg))
})
Message
[36mi[39m First message
[32mv[39m Success!
# meta is single cliMessage [unicode]
Code
withCallingHandlers(cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}), cliMessage = function(msg) {
msgs <<- c(msgs, list(msg))
})
Message
ℹ First message
✔ Success!
# meta is single cliMessage [fancy]
Code
withCallingHandlers(cli::cli({
cli_alert_info("First message")
cli_alert_success("Success!")
}), cliMessage = function(msg) {
msgs <<- c(msgs, list(msg))
})
Message
[36mℹ[39m First message
[32m✔[39m Success!
# substitution [plain]
Code
local({
x <- 1:3
cli({
title <- "My title"
cli_h1("Title: {.emph {title}}")
cli_text("And {.emph some} more: {.val {x}}")
})
})
Message
-- Title: My title -------------------------------------------------------------
And some more: 1, 2, and 3
# substitution [ansi]
Code
local({
x <- 1:3
cli({
title <- "My title"
cli_h1("Title: {.emph {title}}")
cli_text("And {.emph some} more: {.val {x}}")
})
})
Message
[36m--[39m [1mTitle: [3mMy title[23m[22m [36m-------------------------------------------------------------[39m
And [3msome[23m more: [34m1[39m, [34m2[39m, and [34m3[39m
# substitution [unicode]
Code
local({
x <- 1:3
cli({
title <- "My title"
cli_h1("Title: {.emph {title}}")
cli_text("And {.emph some} more: {.val {x}}")
})
})
Message
── Title: My title ─────────────────────────────────────────────────────────────
And some more: 1, 2, and 3
# substitution [fancy]
Code
local({
x <- 1:3
cli({
title <- "My title"
cli_h1("Title: {.emph {title}}")
cli_text("And {.emph some} more: {.val {x}}")
})
})
Message
[36m──[39m [1mTitle: [3mMy title[23m[22m [36m─────────────────────────────────────────────────────────────[39m
And [3msome[23m more: [34m1[39m, [34m2[39m, and [34m3[39m
# return values are ok when recording (#496)
Code
cli::cli({
lid <- cli::cli_ul()
cli::cli_li("a bullet")
cli::cli_end(lid)
})
Message
* a bullet
# nested cli() (#497)
Code
cli::cli({
cli::cli_h1("Header")
cli::cli(cli::cli_text("Some text"))
cli::cli_text("Some more text")
})
Message
-- Header ----------------------------------------------------------------------
Some text
Some more text
cli/tests/testthat/_snaps/ansi-palette.md 0000644 0001762 0000144 00000013064 14535354337 020236 0 ustar ligges users # ansi_palette_show
Code
ansi_palette_show(colors = truecolor)
Output
bright variants
blck red grn yllw blue mgnt cyan whte blck red grn yllw blue mgnt cyan whte
[30m####[39m [31m####[39m [32m####[39m [33m####[39m [34m####[39m [35m####[39m [36m####[39m [37m####[39m [90m####[39m [91m####[39m [92m####[39m [93m####[39m [94m####[39m [95m####[39m [96m####[39m [97m####[39m
[30m####[39m [31m####[39m [32m####[39m [33m####[39m [34m####[39m [35m####[39m [36m####[39m [37m####[39m [90m####[39m [91m####[39m [92m####[39m [93m####[39m [94m####[39m [95m####[39m [96m####[39m [97m####[39m
[30m####[39m [31m####[39m [32m####[39m [33m####[39m [34m####[39m [35m####[39m [36m####[39m [37m####[39m [90m####[39m [91m####[39m [92m####[39m [93m####[39m [94m####[39m [95m####[39m [96m####[39m [97m####[39m
[30m####[39m [31m####[39m [32m####[39m [33m####[39m [34m####[39m [35m####[39m [36m####[39m [37m####[39m [90m####[39m [91m####[39m [92m####[39m [93m####[39m [94m####[39m [95m####[39m [96m####[39m [97m####[39m
---
Code
ansi_palette_show(colors = truecolor)
Output
bright variants
blck red grn yllw blue mgnt cyan whte blck red grn yllw blue mgnt cyan whte
[38;2;0;0;0m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m [38;2;104;104;104m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m
[38;2;0;0;0m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m [38;2;104;104;104m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m
[38;2;0;0;0m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m [38;2;104;104;104m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m
[38;2;0;0;0m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m [38;2;104;104;104m####[39m [38;2;255;92;87m####[39m [38;2;90;247;142m####[39m [38;2;243;249;157m####[39m [38;2;87;199;255m####[39m [38;2;255;106;193m####[39m [38;2;154;237;254m####[39m [38;2;241;241;240m####[39m
# error
Code
withr::with_options(list(cli.palette = "foobar12"), ansi_palette_show(colors = 256))
Condition
Error:
! [1m[22mCannot find cli ANSI palette [34m"foobar12"[39m
[36mi[39m Know palettes are [34m"dichro"[39m, [34m"vga"[39m, [34m"winxp"[39m, [34m"vscode"[39m, [34m"win10"[39m, [34m"macos"[39m, [34m"putty"[39m, [34m"mirc"[39m, [34m"xterm"[39m, [34m"ubuntu"[39m, [34m"eclipse"[39m, [34m"iterm"[39m, [34m"iterm-pastel"[39m, [34m"iterm-smoooooth"[39m, [34m"iterm-snazzy"[39m, [34m"iterm-solarized"[39m, and [34m"iterm-tango"[39m.
[36mi[39m Maybe the `cli.palette` option is incorrect?
# custom palettes
Code
col_black("black")
Output
[1] [38;5;232mblack[39m
Code
col_red("red")
Output
[1] [38;5;210mred[39m
Code
col_green("green")
Output
[1] [38;5;121mgreen[39m
Code
col_yellow("yellow")
Output
[1] [38;5;229myellow[39m
Code
col_blue("blue")
Output
[1] [38;5;117mblue[39m
Code
col_magenta("magenta")
Output
[1] [38;5;212mmagenta[39m
Code
col_cyan("cyan")
Output
[1] [38;5;159mcyan[39m
Code
col_white("white")
Output
[1] [38;5;254mwhite[39m
Code
col_br_black("br_black")
Output
[1] [38;5;241mbr_black[39m
Code
col_br_red("br_red")
Output
[1] [38;5;210mbr_red[39m
Code
col_br_green("br_green")
Output
[1] [38;5;121mbr_green[39m
Code
col_br_yellow("br_yellow")
Output
[1] [38;5;229mbr_yellow[39m
Code
col_br_blue("br_blue")
Output
[1] [38;5;117mbr_blue[39m
Code
col_br_magenta("br_magenta")
Output
[1] [38;5;212mbr_magenta[39m
Code
col_br_cyan("br_cyan")
Output
[1] [38;5;159mbr_cyan[39m
Code
col_br_white("br_white")
Output
[1] [38;5;254mbr_white[39m
cli/tests/testthat/_snaps/progress-message.md 0000644 0001762 0000144 00000001643 14535354364 021136 0 ustar ligges users # cli_progress_message
Code
capture_cli_messages(fun())
Output
[1] "Simplest progress 'bar', `fn()` 2 twos\n"
# cli_progress_message error
Code
readLines(outfile)
Output
[1] "Simplest progress 'bar', `fn()` 2 twos"
[2] "Error in (function () : oopsie"
---
Code
win2unix(out)
Output
[1] "\033[?25l\rSimplest progress 'bar', `fn()` 2 twos\033[K\r\r\033[K\033[?25hError in (function () : oopsie\n"
# cli_progress_step
Code
msgs
Output
[1] "\ri First step\033[K\r" "\rv First step [1s]\033[K\r"
[3] "\n" "\ri Second step\033[K\r"
[5] "\rv Second step [1s]\033[K\r" "\n"
# cli_progress_step error
Code
win2unix(out)
Output
[1] "i First step\nv First step [1s]\n\ni Second step\nx Second step [1s]\n\nError in (function () : oopsie\n"
cli/tests/testthat/_snaps/rules.md 0000644 0001762 0000144 00000000124 14535354366 016775 0 ustar ligges users # print.cli_rule
Code
rule("foo")
Output
-- foo -------------
cli/tests/testthat/_snaps/code.md 0000644 0001762 0000144 00000000571 14535354344 016557 0 ustar ligges users # issue #154 [plain]
Code
cli_code("a\nb\nc")
Message
a
b
c
# issue #154 [ansi]
Code
cli_code("a\nb\nc")
Message
a
b
c
# issue #154 [unicode]
Code
cli_code("a\nb\nc")
Message
a
b
c
# issue #154 [fancy]
Code
cli_code("a\nb\nc")
Message
a
b
c
cli/tests/testthat/_snaps/utf8.md 0000644 0001762 0000144 00000000141 14535354371 016524 0 ustar ligges users # errors
! Invalid output from UTF-8 R
i Found 1 UTF-8 begin marker and 2 end markers.
cli/tests/testthat/_snaps/ansi-hyperlink.md 0000644 0001762 0000144 00000002346 14535354337 020606 0 ustar ligges users # unknown hyperlink type
Code
make_link("this", "foobar")
Condition
Error in `match.arg()`:
! 'arg' should be one of "email", "file", "fun", "help", "href", "run", "topic", "url", "vignette"
# iterm file links
Code
cli::cli_text("{.file /path/to/file:10}")
Message
']8;;file:///path/to/file#10/path/to/file:10]8;;'
Code
cli::cli_text("{.file /path/to/file:10:20}")
Message
']8;;file:///path/to/file#10:20/path/to/file:10:20]8;;'
# rstudio links
Code
cli::cli_text("{.fun pkg::fun}")
Message
`]8;;ide:help:pkg::funpkg::fun]8;;()`
---
Code
cli::cli_text("{.help fun}")
Message
]8;;ide:help:funfun]8;;
---
Code
cli::cli_text("{.run package::func()}")
Message
]8;;ide:run:package::func()package::func()]8;;
---
Code
cli::cli_text("{.vignette package::title}")
Message
]8;;ide:vignette:package::titlepackage::title]8;;
---
Code
cli::cli_text("{.topic pkg::topic}")
Message
]8;;ide:help:pkg::topicpkg::topic]8;;
# ST hyperlinks
Code
cat(style_hyperlink("text", "https://example.com"))
Output
]8;;https://example.com\text]8;;\
cli/tests/testthat/_snaps/progress-types.md 0000644 0001762 0000144 00000005160 14535355646 020660 0 ustar ligges users # iterator
Code
out
Output
[1] "\r===============>--------------- 50% | ETA: 1s\033[K\r"
[2] "\r\033[K"
---
Code
out
Output
[1] "\r\\ 50 done (100/s) | 3ms\033[K\r" "\r\033[K"
# tasks
Code
out
Output
[1] "\r\\ 50/100 ETA: 1s | \033[K\r" "\r\033[K"
---
Code
out
Output
[1] "\r\\ 50 done (100/s) | 3ms\033[K\r" "\r\033[K"
# download
Code
out
Output
[1] "\r==>---------------------------- | 53 kB/1.0 MB ETA: 1s\033[K\r"
[2] "\r\033[K"
---
Code
out
Output
[1] "\r\\ 53 kB (8.5 MB/s) | 3ms\033[K\r"
[2] "\r\033[K"
# customize with options, iterator
Code
capture_cli_messages(fun("iterator", 100))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("iterator", NA))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("iterator", 100))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("iterator", NA))
Output
[1] "\rnew too 50\033[K\r" "\r\033[K"
# customize with options, tasks
Code
capture_cli_messages(fun("tasks", 100))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("tasks", NA))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("tasks", 100))
Output
[1] "\rnew format 50\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("tasks", NA))
Output
[1] "\rnew too 50\033[K\r" "\r\033[K"
# customize with options, download
Code
capture_cli_messages(fun("download", 1024 * 1024, 512 * 1024))
Output
[1] "\rnew format 524 kB\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("download", NA, 512 * 1024))
Output
[1] "\rnew format 524 kB\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("download", 1024 * 1024, 512 * 1024))
Output
[1] "\rnew format 524 kB\033[K\r" "\r\033[K"
---
Code
capture_cli_messages(fun("download", NA, 512 * 1024))
Output
[1] "\rnew too 524 kB\033[K\r" "\r\033[K"
cli/tests/testthat/_snaps/ansiex.md 0000644 0001762 0000144 00000006630 14535354341 017133 0 ustar ligges users # ansi_substr bad input
Code
ansi_substr("foobar", NULL, 10)
Condition
Error:
! `ansi_substr()` must have non-empty `start` and `stop` arguments
i `start` has length 0
---
Code
ansi_substr("foobar", 10, NULL)
Condition
Error:
! `ansi_substr()` must have non-empty `start` and `stop` arguments
i `stop` has length 0
---
Code
ansi_substr("foobar", "bad", "bad")
Condition
Error:
! `start` and `stop` must not have `NA` values
i `start` has 1 `NA` value, after coercion to integer
i `stop` has 1 `NA` value, after coercion to integer
# ansi_substr corner cases
Code
ansi_substr("abc", "hello", 1)
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`start` and `stop` must not have `NA` values
[36mi[39m `start` has 1 `NA` value, after coercion to integer
# Weird length 'split'
Code
ansi_strsplit(c("ab", "bd"), c("b", "d"))
Condition
[1m[33mError[39m:[22m
[33m![39m [1m[22m`split` must be character of length <= 1, or must coerce to that
[36mi[39m `split` is (or was coerced to) a character vector
# ansi_strtrim with zero-length ellipsis
Code
ansi_strtrim("12345", 1, ellipsis = "")
Output
[1] 1
Code
ansi_strtrim("12345", 3, ellipsis = "")
Output
[1] 123
Code
ansi_strtrim("12345", 5, ellipsis = "")
Output
[1] 12345
# ansi_strtrim errors
Code
ansi_strtrim("foobar", -1)
Condition
Error:
! `width` must be non-negative in `cli::ansi_strtrim()`.
# ansi_strtrim edge cases
Code
ansi_strtrim("foobar", width = 3, ellipsis = "...")
Output
[1] "..."
Code
ansi_strtrim("foobar", width = 2, ellipsis = "...")
Output
[1] ".."
Code
ansi_strtrim("foobar", width = 1, ellipsis = "...")
Output
[1] "."
Code
ansi_strtrim("foobar", width = 0, ellipsis = "...")
Output
[1] ""
# ansi_columns
foo 1 foo 2 foo 3 foo 4
foo 5 foo 6 foo 7 foo 8
foo 9 foo 10
---
123456789012...
# ansi_toupper [plain]
Code
local({
cat_line(x)
cat_line(ansi_toupper(x))
})
Output
Red normal green
RED NORMAL GREEN
# ansi_toupper [ansi]
Code
local({
cat_line(x)
cat_line(ansi_toupper(x))
})
Output
[31mRed [39mnormal [1m[32mgreen[39m[22m
[31mRED [39mNORMAL [1m[32mGREEN[39m[22m
# ansi_tolower [plain]
Code
local({
cat_line(x)
cat_line(ansi_tolower(x))
})
Output
Red NORMAL grEeN
red normal green
# ansi_tolower [ansi]
Code
local({
cat_line(x)
cat_line(ansi_tolower(x))
})
Output
[31mRed [39mNORMAL [1m[32mgrEeN[39m[22m
[31mred [39mnormal [1m[32mgreen[39m[22m
# ansi_chartr [plain]
Code
local({
cat_line(x)
cat_line(ansi_chartr(" R_", "-r*", x))
})
Output
Red normal green
red-normal-green
# ansi_chartr [ansi]
Code
local({
cat_line(x)
cat_line(ansi_chartr(" R_", "-r*", x))
})
Output
[31mRed [39mnormal [1m[32mgreen[39m[22m
[31mred-[39mnormal-[1m[32mgreen[39m[22m
cli/tests/testthat/_snaps/themes.md 0000644 0001762 0000144 00000011111 14535354370 017121 0 ustar ligges users # add/remove/list themes [plain]
Code
cli_par(class = "green")
cli_text(lorem_ipsum())
Message
Non incididunt mollit ullamco duis officia proident. Laborum esse mollit mollit
eiusmod tempor cupidatat. In commodo anim irure nostrud. Deserunt nisi amet
laborum magna aliqua. Do esse consectetur ut deserunt nulla Lorem non. Fugiat
est dolore deserunt aliqua amet et esse dolore elit exercitation sint
exercitation non ipsum.
Code
cli_end()
Message
# add/remove/list themes [ansi]
Code
cli_par(class = "green")
cli_text(lorem_ipsum())
Message
[32mNon incididunt mollit ullamco duis officia proident. Laborum esse mollit mollit[39m
[32meiusmod tempor cupidatat. In commodo anim irure nostrud. Deserunt nisi amet[39m
[32mlaborum magna aliqua. Do esse consectetur ut deserunt nulla Lorem non. Fugiat[39m
[32mest dolore deserunt aliqua amet et esse dolore elit exercitation sint[39m
[32mexercitation non ipsum.[39m
Code
cli_end()
Message
# add/remove/list themes [unicode]
Code
cli_par(class = "green")
cli_text(lorem_ipsum())
Message
Non incididunt mollit ullamco duis officia proident. Laborum esse mollit mollit
eiusmod tempor cupidatat. In commodo anim irure nostrud. Deserunt nisi amet
laborum magna aliqua. Do esse consectetur ut deserunt nulla Lorem non. Fugiat
est dolore deserunt aliqua amet et esse dolore elit exercitation sint
exercitation non ipsum.
Code
cli_end()
Message
# add/remove/list themes [fancy]
Code
cli_par(class = "green")
cli_text(lorem_ipsum())
Message
[32mNon incididunt mollit ullamco duis officia proident. Laborum esse mollit mollit[39m
[32meiusmod tempor cupidatat. In commodo anim irure nostrud. Deserunt nisi amet[39m
[32mlaborum magna aliqua. Do esse consectetur ut deserunt nulla Lorem non. Fugiat[39m
[32mest dolore deserunt aliqua amet et esse dolore elit exercitation sint[39m
[32mexercitation non ipsum.[39m
Code
cli_end()
Message
# explicit formatter is used, and combined
Code
cli_text("this is {.emph it}, really")
Message
this is (((<>))), really
# user's override
Code
local({
start_app(theme = custom, .auto_close = FALSE)
cli_alert("Alert!")
stop_app()
withr::local_options(cli.user_theme = override)
start_app(theme = custom, .auto_close = FALSE)
cli_alert("Alert!")
stop_app()
})
Message
custom:Alert!
custom:Alert!override:
# NULL will undo a style property
Code
local({
cli_alert("this has an arrow")
cli_div(theme = list(.alert = list(before = NULL)))
cli_alert("this does not")
})
Message
> this has an arrow
this does not
# NULL will undo color [ansi]
Code
local({
cli_alert("{.emph {.val this is blue}}")
cli_div(theme = list(span.val = list(color = NULL)))
cli_alert("{.emph {.val this is not}}")
})
Message
> [34m[3m[34m"this is blue"[34m[23m[39m
> [0m[22m[23m[24m[27m[28m[29m[49m[3m[0m[22m[3m[24m[27m[28m[29m[49m"this is not"[0m[22m[23m[24m[27m[28m[29m[49m[23m[39m
---
Code
local({
cli_alert("{.emph {.val this is blue}}")
cli_div(theme = list(span.val = list(color = "none")))
cli_alert("{.emph {.val this is not}}")
})
Message
> [34m[3m[34m"this is blue"[34m[23m[39m
> [0m[22m[23m[24m[27m[28m[29m[49m[3m[0m[22m[3m[24m[27m[28m[29m[49m"this is not"[0m[22m[23m[24m[27m[28m[29m[49m[23m[39m
# NULL will undo background color [ansi]
Code
local({
cli_alert("{.emph {.code this has bg color}}")
cli_div(theme = list(span = list(`background-color` = NULL)))
cli_alert("{.emph {.code this does not}}")
})
Message
> [3m`this has bg color`[23m
> [0m[22m[23m[24m[27m[28m[29m[39m[3m[0m[22m[3m[24m[27m[28m[29m[39m`this does not`[0m[22m[23m[24m[27m[28m[29m[39m[23m[49m
---
Code
local({
cli_alert("{.emph {.code this has bg color}}")
cli_div(theme = list(span = list(`background-color` = "none")))
cli_alert("{.emph {.code this does not}}")
})
Message
> [3m`this has bg color`[23m
> [0m[22m[23m[24m[27m[28m[29m[39m[3m[0m[22m[3m[24m[27m[28m[29m[39m`this does not`[0m[22m[23m[24m[27m[28m[29m[39m[23m[49m
cli/tests/testthat/_snaps/vt.md 0000644 0001762 0000144 00000021262 14535354371 016276 0 ustar ligges users # empty input
Code
vt_output("", width = 20, height = 2)$segment
Output
[1] " " " "
# raw input
Code
vt_output(charToRaw("foobar"), width = 20, height = 2)$segment
Output
[1] "foobar " " "
# overflow
Code
vt_output(strrep("1234567890", 2), width = 19, height = 2)$segment
Output
[1] "1234567890123456789" "0 "
# control characters
Code
vt_output("foo\nbar", width = 20, height = 2)$segment
Output
[1] "foo " "bar "
---
Code
vt_output("foobar\rbaz", width = 20, height = 2)$segment
Output
[1] "bazbar " " "
# scroll up
Code
vt_output(strrep("1234567890", 5), width = 20, height = 2)$segment
Output
[1] "12345678901234567890" "1234567890 "
---
Code
vt_output(paste0(1:10, "\n"), width = 10, height = 5)$segment
Output
[1] "7 " "8 " "9 " "10 " " "
# ANSI SGR [ansi]
Code
vt_output("12\033[31m34\033[1m56\033[39m78\033[21m90", width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 12 FALSE FALSE FALSE FALSE
2 1 1 34 FALSE FALSE FALSE FALSE
3 1 1 56 TRUE FALSE FALSE FALSE
4 1 1 78 TRUE FALSE FALSE FALSE
5 1 1 90 FALSE FALSE FALSE FALSE
6 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE 1
3 FALSE FALSE 1
4 FALSE FALSE
5 FALSE FALSE
6 FALSE FALSE
---
Code
vt_output(style_bold("I'm bold"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 I'm bold TRUE FALSE FALSE FALSE
2 1 1 FALSE FALSE FALSE FALSE
3 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE
3 FALSE FALSE
---
Code
vt_output(style_italic("I'm italic"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 I'm italic FALSE TRUE FALSE FALSE
2 1 1 FALSE FALSE FALSE FALSE
3 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE
3 FALSE FALSE
---
Code
vt_output(style_underline("I'm underlined"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 I'm underlined FALSE FALSE TRUE FALSE
2 1 1 FALSE FALSE FALSE FALSE
3 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE
3 FALSE FALSE
---
Code
vt_output(style_strikethrough("I'm strikethrough"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 I'm strikethrough FALSE FALSE FALSE TRUE
2 1 1 FALSE FALSE FALSE FALSE
3 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE
3 FALSE FALSE
---
Code
vt_output(style_inverse("I'm inverse"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 I'm inverse FALSE FALSE FALSE FALSE
2 1 1 FALSE FALSE FALSE FALSE
3 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE TRUE
2 FALSE FALSE
3 FALSE FALSE
# hyperlinks
Code
link <- style_hyperlink("text", "url")
vt_output(c("pre ", st_from_bel(link), " post"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 pre FALSE FALSE FALSE FALSE
2 1 1 text FALSE FALSE FALSE FALSE
3 1 1 post FALSE FALSE FALSE FALSE
4 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE url
3 FALSE FALSE
4 FALSE FALSE
---
Code
link <- style_hyperlink("text", "url", params = c(f = "x", g = "y"))
vt_output(c("pre ", st_from_bel(link), " post"), width = 20, height = 2)
Output
lineno segmentno segment bold italic underline strikethrough
1 1 1 pre FALSE FALSE FALSE FALSE
2 1 1 text FALSE FALSE FALSE FALSE
3 1 1 post FALSE FALSE FALSE FALSE
4 2 1 FALSE FALSE FALSE FALSE
blink inverse color background_color link link_params
1 FALSE FALSE
2 FALSE FALSE url f = x:g = y
3 FALSE FALSE
4 FALSE FALSE
# erase in line
Code
vt_output("foobar\033[3D\033[K", width = 10, height = 2)$segment
Output
[1] "foo " " "
Code
vt_output("foobar\033[3D\033[0K", width = 10, height = 2)$segment
Output
[1] "foo " " "
Code
vt_output("foobar\033[3D\033[1K", width = 10, height = 2)$segment
Output
[1] " ar " " "
Code
vt_output("foobar\033[3D\033[2K", width = 10, height = 2)$segment
Output
[1] " " " "
# erase in screen
Code
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[J", width = 10, height = 4)$
segment
Output
[1] "foo " "foo " " " " "
Code
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[0J", width = 10, height = 4)$
segment
Output
[1] "foo " "foo " " " " "
Code
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[1J", width = 10, height = 4)$
segment
Output
[1] " " " ar " "foobar2 " " "
Code
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[2Jx", width = 10, height = 4)$
segment
Output
[1] " " " x " " " " "
Code
vt_output("foo\nfoobar\nfoobar2\033[A\033[4D\033[3Jx", width = 10, height = 4)$
segment
Output
[1] " " " x " " " " "
cli/tests/testthat/_snaps/old-r/ 0000755 0001762 0000144 00000000000 14313121025 016313 5 ustar ligges users cli/tests/testthat/_snaps/old-r/inline-2.md 0000644 0001762 0000144 00000000377 14313121071 020262 0 ustar ligges users # various errors
Code
cli_text("xx {__cannot-parse-this__} yy")
Condition
Error:
! Could not parse cli `{}` expression: `__cannot-parse-th...`.
Caused by error:
! :1:1: unexpected input
1: _
^
cli/tests/testthat/_snaps/prettycode.md 0000644 0001762 0000144 00000014521 14535354360 020025 0 ustar ligges users # reserved [plain]
Code
cat(code_highlight("function () { }", list(reserved = "bold")))
Output
function () { }
Code
cat(code_highlight("if (1) NULL else NULL", list(reserved = "bold")))
Output
if (1) NULL else NULL
Code
cat(code_highlight("repeat {}", list(reserved = "bold")))
Output
repeat {}
Code
cat(code_highlight("while (1) {}", list(reserved = "bold")))
Output
while (1) {}
Code
cat(code_highlight("for (i in x) next", list(reserved = "bold")))
Output
for (i in x) next
Code
cat(code_highlight("for (i in x) break", list(reserved = "bold")))
Output
for (i in x) break
# reserved [ansi]
Code
cat(code_highlight("function () { }", list(reserved = "bold")))
Output
[1mfunction[22m () { }
Code
cat(code_highlight("if (1) NULL else NULL", list(reserved = "bold")))
Output
[1mif[22m (1) NULL [1melse[22m NULL
Code
cat(code_highlight("repeat {}", list(reserved = "bold")))
Output
[1mrepeat[22m {}
Code
cat(code_highlight("while (1) {}", list(reserved = "bold")))
Output
[1mwhile[22m (1) {}
Code
cat(code_highlight("for (i in x) next", list(reserved = "bold")))
Output
[1mfor[22m (i [1min[22m x) [1mnext[22m
Code
cat(code_highlight("for (i in x) break", list(reserved = "bold")))
Output
[1mfor[22m (i [1min[22m x) [1mbreak[22m
# number [plain]
Code
cat(code_highlight("1 + 1.0 + -1 + 2L + Inf", list(number = "bold")))
Output
1 + 1.0 + -1 + 2L + Inf
Code
cat(code_highlight("NA + NA_real_ + NA_integer_ + NA_character_", list(number = "bold")))
Output
NA + NA_real_ + NA_integer_ + NA_character_
Code
cat(code_highlight("TRUE + FALSE", list(number = "bold")))
Output
TRUE + FALSE
# number [ansi]
Code
cat(code_highlight("1 + 1.0 + -1 + 2L + Inf", list(number = "bold")))
Output
[1m1[22m + [1m1.0[22m + -[1m1[22m + [1m2L[22m + [1mInf[22m
Code
cat(code_highlight("NA + NA_real_ + NA_integer_ + NA_character_", list(number = "bold")))
Output
[1mNA[22m + [1mNA_real_[22m + [1mNA_integer_[22m + [1mNA_character_[22m
Code
cat(code_highlight("TRUE + FALSE", list(number = "bold")))
Output
[1mTRUE[22m + [1mFALSE[22m
# null [plain]
Code
cat(code_highlight("NULL", list(null = "bold")))
Output
NULL
# null [ansi]
Code
cat(code_highlight("NULL", list(null = "bold")))
Output
[1mNULL[22m
# operator [plain]
Code
cat(code_highlight("~ ! 1 - 2 + 3:4 * 5 / 6 ^ 7", list(operator = "bold")))
Output
~ ! 1 - 2 + 3:4 * 5 / 6 ^ 7
Code
cat(code_highlight("? 1 %% 2 %+% 2 < 3 & 4 > 5 && 6 == 7 | 8 <= 9 || 10 >= 11",
list(operator = "bold")))
Output
? 1 %% 2 %+% 2 < 3 & 4 > 5 && 6 == 7 | 8 <= 9 || 10 >= 11
Code
cat(code_highlight("a <- 10; 20 -> b; c = 30; a$b; a@b", list(operator = "bold")))
Output
a <- 10; 20 -> b; c = 30; a$b; a@b
# operator [ansi]
Code
cat(code_highlight("~ ! 1 - 2 + 3:4 * 5 / 6 ^ 7", list(operator = "bold")))
Output
[1m~[22m [1m![22m 1 [1m-[22m 2 [1m+[22m 3[1m:[22m4 [1m*[22m 5 [1m/[22m 6 [1m^[22m 7
Code
cat(code_highlight("? 1 %% 2 %+% 2 < 3 & 4 > 5 && 6 == 7 | 8 <= 9 || 10 >= 11",
list(operator = "bold")))
Output
[1m?[22m 1 [1m%%[22m 2 [1m%+%[22m 2 [1m<[22m 3 [1m&[22m 4 [1m>[22m 5 [1m&&[22m 6 [1m==[22m 7 [1m|[22m 8 [1m<=[22m 9 [1m||[22m 10 [1m>=[22m 11
Code
cat(code_highlight("a <- 10; 20 -> b; c = 30; a$b; a@b", list(operator = "bold")))
Output
a [1m<-[22m 10; 20 [1m->[22m b; c [1m=[22m 30; a[1m$[22mb; a[1m@[22mb
# call [plain]
Code
cat(code_highlight("ls(2)", list(call = "bold")))
Output
ls(2)
# call [ansi]
Code
cat(code_highlight("ls(2)", list(call = "bold")))
Output
[1mls[22m(2)
# string [plain]
Code
cat(code_highlight("'s' + \"s\"", list(string = "bold")))
Output
's' + "s"
# string [ansi]
Code
cat(code_highlight("'s' + \"s\"", list(string = "bold")))
Output
[1m's'[22m + [1m"s"[22m
# comment [plain]
Code
cat(code_highlight(c("# COM", " ls() ## ANOT"), list(comment = "bold")))
Output
# COM ls() ## ANOT
# comment [ansi]
Code
cat(code_highlight(c("# COM", " ls() ## ANOT"), list(comment = "bold")))
Output
[1m# COM[22m ls() [1m## ANOT[22m
# bracket [plain]
Code
cat(code_highlight("foo <- function(x){x}", list(bracket = list("bold"))))
Output
foo <- function(x){x}
# bracket [ansi]
Code
cat(code_highlight("foo <- function(x){x}", list(bracket = list("bold"))))
Output
foo <- function[1m([22mx[1m)[22m[1m{[22mx[1m}[22m
# code_theme_list
Code
code_theme_list()
Output
[1] "Ambiance" "Chaos" "Chrome"
[4] "Clouds" "Clouds Midnight" "Cobalt"
[7] "Crimson Editor" "Dawn" "Dracula"
[10] "Dreamweaver" "Eclipse" "Idle Fingers"
[13] "Katzenmilch" "Kr Theme" "Material"
[16] "Merbivore" "Merbivore Soft" "Mono Industrial"
[19] "Monokai" "Pastel On Dark" "Solarized Dark"
[22] "Solarized Light" "Textmate (default)" "Tomorrow"
[25] "Tomorrow Night" "Tomorrow Night Blue" "Tomorrow Night Bright"
[28] "Tomorrow Night 80s" "Twilight" "Vibrant Ink"
[31] "Xcode"
# new language features, raw strings [ansi]
Code
cat(code_highlight("\"old\" + r\"(\"new\"\"\")\"", list(string = "bold",
reserved = "italic")))
Output
[1m"old"[22m + [3mr[23m[1m"("new""")"[22m
# new language features, pipe [ansi]
Code
cat(code_highlight("dir() |> toupper()", list(operator = "bold")))
Output
dir() [1m|>[22m toupper()
# new language features, lambda functions [ansi]
Code
cat(code_highlight("\\(x) x * 2", list(reserved = "bold")))
Output
[1m\[22m(x) x * 2
cli/tests/testthat/_snaps/new/ 0000755 0001762 0000144 00000000000 14535536335 016113 5 ustar ligges users cli/tests/testthat/_snaps/new/headers.md 0000644 0001762 0000144 00000003664 14535354347 020062 0 ustar ligges users # headers [plain]
Code
local({
cli_div(class = "testcli", theme = test_style())
cli_h1("HEADER")
cli_h2("Header")
cli_h3("Header")
x <- "foobar"
xx <- 100
cli_h2("{xx}. header: {x}")
})
Message
HEADER
Header
Header
100. header: foobar
# headers [ansi]
Code
local({
cli_div(class = "testcli", theme = test_style())
cli_h1("HEADER")
cli_h2("Header")
cli_h3("Header")
x <- "foobar"
xx <- 100
cli_h2("{xx}. header: {x}")
})
Message
[1m[3m[1m[3mHEADER[3m[1m[23m[22m
[1m[1mHeader[1m[22m
[4m[4mHeader[4m[24m
[1m[1m[1m100[1m. header: [1mfoobar[1m[1m[22m
# headers [unicode]
Code
local({
cli_div(class = "testcli", theme = test_style())
cli_h1("HEADER")
cli_h2("Header")
cli_h3("Header")
x <- "foobar"
xx <- 100
cli_h2("{xx}. header: {x}")
})
Message
HEADER
Header
Header
100. header: foobar
# headers [fancy]
Code
local({
cli_div(class = "testcli", theme = test_style())
cli_h1("HEADER")
cli_h2("Header")
cli_h3("Header")
x <- "foobar"
xx <- 100
cli_h2("{xx}. header: {x}")
})
Message
[1m[3m[1m[3mHEADER[3m[1m[23m[22m
[1m[1mHeader[1m[22m
[4m[4mHeader[4m[24m
[1m[1m[1m100[1m. header: [1mfoobar[1m[1m[22m
# issue #218
Code
cli_h1("one {1} two {2} three {3}")
Message
-- one 1 two 2 three 3 ---------------------------------------------------------
Code
cli_h2("one {1} two {2} three {3}")
Message
-- one 1 two 2 three 3 --
cli/tests/testthat/_snaps/deep-lists.md 0000644 0001762 0000144 00000002766 14535354345 017727 0 ustar ligges users # deep lists ul
Code
for (i in 1:4) test_ul(i)
Message
* Level 1
* Level 1
* Level 2
* Level 1
* Level 2
* Level 3
* Level 1
* Level 2
* Level 3
* Level 4
# deep lists ol
Code
for (i in 1:4) test_ol(i)
Message
1. Level 1
1. Level 1
1. Level 2
1. Level 1
1. Level 2
1. Level 3
1. Level 1
1. Level 2
1. Level 3
1. Level 4
# deep lists ol ul
Code
for (i in 1:4) test_ol_ul(i)
Message
1. Level 1
* Level 2
1. Level 1
* Level 2
1. Level 3
* Level 4
1. Level 1
* Level 2
1. Level 3
* Level 4
1. Level 5
* Level 6
1. Level 1
* Level 2
1. Level 3
* Level 4
1. Level 5
* Level 6
1. Level 7
* Level 8
# deep lists ul ol
Code
for (i in 1:4) test_ul_ol(i)
Message
* Level 1
1. Level 2
* Level 1
1. Level 2
* Level 3
1. Level 4
* Level 1
1. Level 2
* Level 3
1. Level 4
* Level 5
1. Level 6
* Level 1
1. Level 2
* Level 3
1. Level 4
* Level 5
1. Level 6
* Level 7
1. Level 8
cli/tests/testthat/_snaps/links.md 0000644 0001762 0000144 00000067416 14535354355 017002 0 ustar ligges users # {.email} [plain-none]
Code
cli_text("{.email bugs.bunny@acme.com}")
Message
'bugs.bunny@acme.com'
# {.email} [fancy-none]
Code
cli_text("{.email bugs.bunny@acme.com}")
Message
[34mbugs.bunny@acme.com[39m
# {.email} [plain-all]
Code
cli_text("{.email bugs.bunny@acme.com}")
Message
']8;;mailto:bugs.bunny@acme.combugs.bunny@acme.com]8;;'
# {.email} [fancy-all]
Code
cli_text("{.email bugs.bunny@acme.com}")
Message
]8;;mailto:bugs.bunny@acme.com[34mbugs.bunny@acme.com[39m]8;;
# {.email} vectors [plain-none]
Code
emails <- paste0("bugs.bunny-", 1:3, "@acme.com")
cli_text("{.email {emails}}")
Message
'bugs.bunny-1@acme.com', 'bugs.bunny-2@acme.com', and 'bugs.bunny-3@acme.com'
# {.email} vectors [fancy-none]
Code
emails <- paste0("bugs.bunny-", 1:3, "@acme.com")
cli_text("{.email {emails}}")
Message
[34mbugs.bunny-1@acme.com[39m, [34mbugs.bunny-2@acme.com[39m, and [34mbugs.bunny-3@acme.com[39m
# {.email} vectors [plain-all]
Code
emails <- paste0("bugs.bunny-", 1:3, "@acme.com")
cli_text("{.email {emails}}")
Message
']8;;mailto:bugs.bunny-1@acme.combugs.bunny-1@acme.com]8;;', ']8;;mailto:bugs.bunny-2@acme.combugs.bunny-2@acme.com]8;;', and ']8;;mailto:bugs.bunny-3@acme.combugs.bunny-3@acme.com]8;;'
# {.email} vectors [fancy-all]
Code
emails <- paste0("bugs.bunny-", 1:3, "@acme.com")
cli_text("{.email {emails}}")
Message
]8;;mailto:bugs.bunny-1@acme.com[34mbugs.bunny-1@acme.com[39m]8;;, ]8;;mailto:bugs.bunny-2@acme.com[34mbugs.bunny-2@acme.com[39m]8;;, and ]8;;mailto:bugs.bunny-3@acme.com[34mbugs.bunny-3@acme.com[39m]8;;
# {.file} and {.path} [plain-none]
Code
cli_text("{.file /absolute/path}")
Message
'/absolute/path'
Code
cli_text("{.file file:///absolute/path}")
Message
'file:///absolute/path'
Code
cli_text("{.path /absolute/path}")
Message
'/absolute/path'
Code
cli_text("{.path file:///absolute/path}")
Message
'file:///absolute/path'
---
Code
cli_text("{.file relative/path}")
Message
'relative/path'
Code
cli_text("{.file ./relative/path}")
Message
'./relative/path'
Code
cli_text("{.path relative/path}")
Message
'relative/path'
Code
cli_text("{.path ./relative/path}")
Message
'./relative/path'
---
Code
cli_text("{.file ~/relative/path}")
Message
'~/relative/path'
Code
cli_text("{.path ~/relative/path}")
Message
'~/relative/path'
---
Code
paths <- c("~/foo", "bar", "file:///abs")
cli_text("{.file {paths}}")
Message
'~/foo', 'bar', and 'file:///abs'
---
Code
paths <- c("foo ", " bar ", "file:///a bs ")
cli_text("{.file {paths}}")
Message
'foo ', ' bar ', and 'file:///a bs '
---
Code
name <- cli::style_hyperlink("/foo/bar", "/foo/bar")
cli_text("{.file {name}}")
Message
'/foo/bar'
---
Code
cli_text("{.file /absolute/path:12}")
Message
'/absolute/path:12'
Code
cli_text("{.file file:///absolute/path:5}")
Message
'file:///absolute/path:5'
Code
cli_text("{.path /absolute/path:123}")
Message
'/absolute/path:123'
Code
cli_text("{.path file:///absolute/path:51}")
Message
'file:///absolute/path:51'
---
Code
cli_text("{.file relative/path:12}")
Message
'relative/path:12'
Code
cli_text("{.file ./relative/path:5}")
Message
'./relative/path:5'
Code
cli_text("{.path relative/path:123}")
Message
'relative/path:123'
Code
cli_text("{.path ./relative/path:51}")
Message
'./relative/path:51'
---
Code
cli_text("{.file ~/relative/path:12}")
Message
'~/relative/path:12'
Code
cli_text("{.path ~/relative/path:5}")
Message
'~/relative/path:5'
---
Code
cli_text("{.file /absolute/path:12:5}")
Message
'/absolute/path:12:5'
Code
cli_text("{.file file:///absolute/path:5:100}")
Message
'file:///absolute/path:5:100'
Code
cli_text("{.path /absolute/path:123:1}")
Message
'/absolute/path:123:1'
Code
cli_text("{.path file:///absolute/path:51:6}")
Message
'file:///absolute/path:51:6'
---
Code
cli_text("{.file relative/path:12:13}")
Message
'relative/path:12:13'
Code
cli_text("{.file ./relative/path:5:20}")
Message
'./relative/path:5:20'
Code
cli_text("{.path relative/path:123:21}")
Message
'relative/path:123:21'
Code
cli_text("{.path ./relative/path:51:2}")
Message
'./relative/path:51:2'
---
Code
cli_text("{.file ~/relative/path:12:23}")
Message
'~/relative/path:12:23'
Code
cli_text("{.path ~/relative/path:5:2}")
Message
'~/relative/path:5:2'
---
Code
paths <- c("~/foo", "bar:10", "file:///abs:10:20")
cli_text("{.file {paths}}")
Message
'~/foo', 'bar:10', and 'file:///abs:10:20'
# {.file} and {.path} [fancy-none]
Code
cli_text("{.file /absolute/path}")
Message
[34m/absolute/path[39m
Code
cli_text("{.file file:///absolute/path}")
Message
[34mfile:///absolute/path[39m
Code
cli_text("{.path /absolute/path}")
Message
[34m/absolute/path[39m
Code
cli_text("{.path file:///absolute/path}")
Message
[34mfile:///absolute/path[39m
---
Code
cli_text("{.file relative/path}")
Message
[34mrelative/path[39m
Code
cli_text("{.file ./relative/path}")
Message
[34m./relative/path[39m
Code
cli_text("{.path relative/path}")
Message
[34mrelative/path[39m
Code
cli_text("{.path ./relative/path}")
Message
[34m./relative/path[39m
---
Code
cli_text("{.file ~/relative/path}")
Message
[34m~/relative/path[39m
Code
cli_text("{.path ~/relative/path}")
Message
[34m~/relative/path[39m
---
Code
paths <- c("~/foo", "bar", "file:///abs")
cli_text("{.file {paths}}")
Message
[34m~/foo[39m, [34mbar[39m, and [34mfile:///abs[39m
---
Code
paths <- c("foo ", " bar ", "file:///a bs ")
cli_text("{.file {paths}}")
Message
'[34mfoo[39m[44m [49m', '[44m [49m[34mbar[39m[44m [49m', and '[34mfile:///a bs[39m[44m [49m'
---
Code
name <- cli::style_hyperlink("/foo/bar", "/foo/bar")
cli_text("{.file {name}}")
Message
[34m/foo/bar[39m
---
Code
cli_text("{.file /absolute/path:12}")
Message
[34m/absolute/path:12[39m
Code
cli_text("{.file file:///absolute/path:5}")
Message
[34mfile:///absolute/path:5[39m
Code
cli_text("{.path /absolute/path:123}")
Message
[34m/absolute/path:123[39m
Code
cli_text("{.path file:///absolute/path:51}")
Message
[34mfile:///absolute/path:51[39m
---
Code
cli_text("{.file relative/path:12}")
Message
[34mrelative/path:12[39m
Code
cli_text("{.file ./relative/path:5}")
Message
[34m./relative/path:5[39m
Code
cli_text("{.path relative/path:123}")
Message
[34mrelative/path:123[39m
Code
cli_text("{.path ./relative/path:51}")
Message
[34m./relative/path:51[39m
---
Code
cli_text("{.file ~/relative/path:12}")
Message
[34m~/relative/path:12[39m
Code
cli_text("{.path ~/relative/path:5}")
Message
[34m~/relative/path:5[39m
---
Code
cli_text("{.file /absolute/path:12:5}")
Message
[34m/absolute/path:12:5[39m
Code
cli_text("{.file file:///absolute/path:5:100}")
Message
[34mfile:///absolute/path:5:100[39m
Code
cli_text("{.path /absolute/path:123:1}")
Message
[34m/absolute/path:123:1[39m
Code
cli_text("{.path file:///absolute/path:51:6}")
Message
[34mfile:///absolute/path:51:6[39m
---
Code
cli_text("{.file relative/path:12:13}")
Message
[34mrelative/path:12:13[39m
Code
cli_text("{.file ./relative/path:5:20}")
Message
[34m./relative/path:5:20[39m
Code
cli_text("{.path relative/path:123:21}")
Message
[34mrelative/path:123:21[39m
Code
cli_text("{.path ./relative/path:51:2}")
Message
[34m./relative/path:51:2[39m
---
Code
cli_text("{.file ~/relative/path:12:23}")
Message
[34m~/relative/path:12:23[39m
Code
cli_text("{.path ~/relative/path:5:2}")
Message
[34m~/relative/path:5:2[39m
---
Code
paths <- c("~/foo", "bar:10", "file:///abs:10:20")
cli_text("{.file {paths}}")
Message
[34m~/foo[39m, [34mbar:10[39m, and [34mfile:///abs:10:20[39m
# {.file} and {.path} [plain-all]
Code
cli_text("{.file /absolute/path}")
Message
']8;;file:///absolute/path/absolute/path]8;;'
Code
cli_text("{.file file:///absolute/path}")
Message
']8;;file:///absolute/pathfile:///absolute/path]8;;'
Code
cli_text("{.path /absolute/path}")
Message
']8;;file:///absolute/path/absolute/path]8;;'
Code
cli_text("{.path file:///absolute/path}")
Message
']8;;file:///absolute/pathfile:///absolute/path]8;;'
---
Code
cli_text("{.file relative/path}")
Message
']8;;file:///testthat/home/relative/pathrelative/path]8;;'
Code
cli_text("{.file ./relative/path}")
Message
']8;;file:///testthat/home/./relative/path./relative/path]8;;'
Code
cli_text("{.path relative/path}")
Message
']8;;file:///testthat/home/relative/pathrelative/path]8;;'
Code
cli_text("{.path ./relative/path}")
Message
']8;;file:///testthat/home/./relative/path./relative/path]8;;'
---
Code
cli_text("{.file ~/relative/path}")
Message
']8;;file:///my/home/relative/path~/relative/path]8;;'
Code
cli_text("{.path ~/relative/path}")
Message
']8;;file:///my/home/relative/path~/relative/path]8;;'
---
Code
paths <- c("~/foo", "bar", "file:///abs")
cli_text("{.file {paths}}")
Message
']8;;file:///my/home/foo~/foo]8;;', ']8;;file:///testthat/home/barbar]8;;', and ']8;;file:///absfile:///abs]8;;'
---
Code
paths <- c("foo ", " bar ", "file:///a bs ")
cli_text("{.file {paths}}")
Message
']8;;file:///testthat/home/foo foo]8;; ', ' ]8;;file:///testthat/home/ bar bar]8;; ', and ']8;;file:///a bs file:///a bs]8;; '
---
Code
name <- cli::style_hyperlink("/foo/bar", "/foo/bar")
cli_text("{.file {name}}")
Message
']8;;/foo/bar/foo/bar]8;;'
---
Code
cli_text("{.file /absolute/path:12}")
Message
']8;line = 12:col = 1;file:///absolute/path/absolute/path:12]8;;'
Code
cli_text("{.file file:///absolute/path:5}")
Message
']8;line = 5:col = 1;file:///absolute/pathfile:///absolute/path:5]8;;'
Code
cli_text("{.path /absolute/path:123}")
Message
']8;line = 123:col = 1;file:///absolute/path/absolute/path:123]8;;'
Code
cli_text("{.path file:///absolute/path:51}")
Message
']8;line = 51:col = 1;file:///absolute/pathfile:///absolute/path:51]8;;'
---
Code
cli_text("{.file relative/path:12}")
Message
']8;line = 12:col = 1;file:///testthat/home/relative/pathrelative/path:12]8;;'
Code
cli_text("{.file ./relative/path:5}")
Message
']8;line = 5:col = 1;file:///testthat/home/./relative/path./relative/path:5]8;;'
Code
cli_text("{.path relative/path:123}")
Message
']8;line = 123:col = 1;file:///testthat/home/relative/pathrelative/path:123]8;;'
Code
cli_text("{.path ./relative/path:51}")
Message
']8;line = 51:col = 1;file:///testthat/home/./relative/path./relative/path:51]8;;'
---
Code
cli_text("{.file ~/relative/path:12}")
Message
']8;line = 12:col = 1;file:///my/home/relative/path~/relative/path:12]8;;'
Code
cli_text("{.path ~/relative/path:5}")
Message
']8;line = 5:col = 1;file:///my/home/relative/path~/relative/path:5]8;;'
---
Code
cli_text("{.file /absolute/path:12:5}")
Message
']8;line = 12:col = 5;file:///absolute/path/absolute/path:12:5]8;;'
Code
cli_text("{.file file:///absolute/path:5:100}")
Message
']8;line = 5:col = 100;file:///absolute/pathfile:///absolute/path:5:100]8;;'
Code
cli_text("{.path /absolute/path:123:1}")
Message
']8;line = 123:col = 1;file:///absolute/path/absolute/path:123:1]8;;'
Code
cli_text("{.path file:///absolute/path:51:6}")
Message
']8;line = 51:col = 6;file:///absolute/pathfile:///absolute/path:51:6]8;;'
---
Code
cli_text("{.file relative/path:12:13}")
Message
']8;line = 12:col = 13;file:///testthat/home/relative/pathrelative/path:12:13]8;;'
Code
cli_text("{.file ./relative/path:5:20}")
Message
']8;line = 5:col = 20;file:///testthat/home/./relative/path./relative/path:5:20]8;;'
Code
cli_text("{.path relative/path:123:21}")
Message
']8;line = 123:col = 21;file:///testthat/home/relative/pathrelative/path:123:21]8;;'
Code
cli_text("{.path ./relative/path:51:2}")
Message
']8;line = 51:col = 2;file:///testthat/home/./relative/path./relative/path:51:2]8;;'
---
Code
cli_text("{.file ~/relative/path:12:23}")
Message
']8;line = 12:col = 23;file:///my/home/relative/path~/relative/path:12:23]8;;'
Code
cli_text("{.path ~/relative/path:5:2}")
Message
']8;line = 5:col = 2;file:///my/home/relative/path~/relative/path:5:2]8;;'
---
Code
paths <- c("~/foo", "bar:10", "file:///abs:10:20")
cli_text("{.file {paths}}")
Message
']8;;file:///my/home/foo~/foo]8;;', ']8;line = 10:col = 1;file:///testthat/home/barbar:10]8;;', and ']8;line = 10:col = 20;file:///absfile:///abs:10:20]8;;'
# {.file} and {.path} [fancy-all]
Code
cli_text("{.file /absolute/path}")
Message
]8;;file:///absolute/path[34m/absolute/path[39m]8;;
Code
cli_text("{.file file:///absolute/path}")
Message
]8;;file:///absolute/path[34mfile:///absolute/path[39m]8;;
Code
cli_text("{.path /absolute/path}")
Message
]8;;file:///absolute/path[34m/absolute/path[39m]8;;
Code
cli_text("{.path file:///absolute/path}")
Message
]8;;file:///absolute/path[34mfile:///absolute/path[39m]8;;
---
Code
cli_text("{.file relative/path}")
Message
]8;;file:///testthat/home/relative/path[34mrelative/path[39m]8;;
Code
cli_text("{.file ./relative/path}")
Message
]8;;file:///testthat/home/./relative/path[34m./relative/path[39m]8;;
Code
cli_text("{.path relative/path}")
Message
]8;;file:///testthat/home/relative/path[34mrelative/path[39m]8;;
Code
cli_text("{.path ./relative/path}")
Message
]8;;file:///testthat/home/./relative/path[34m./relative/path[39m]8;;
---
Code
cli_text("{.file ~/relative/path}")
Message
]8;;file:///my/home/relative/path[34m~/relative/path[39m]8;;
Code
cli_text("{.path ~/relative/path}")
Message
]8;;file:///my/home/relative/path[34m~/relative/path[39m]8;;
---
Code
paths <- c("~/foo", "bar", "file:///abs")
cli_text("{.file {paths}}")
Message
]8;;file:///my/home/foo[34m~/foo[39m]8;;, ]8;;file:///testthat/home/bar[34mbar[39m]8;;, and ]8;;file:///abs[34mfile:///abs[39m]8;;
---
Code
paths <- c("foo ", " bar ", "file:///a bs ")
cli_text("{.file {paths}}")
Message
']8;;file:///testthat/home/foo [34mfoo[39m]8;;[44m [49m', '[44m [49m]8;;file:///testthat/home/ bar [34mbar[39m]8;;[44m [49m', and ']8;;file:///a bs [34mfile:///a bs[39m]8;;[44m [49m'
---
Code
name <- cli::style_hyperlink("/foo/bar", "/foo/bar")
cli_text("{.file {name}}")
Message
]8;;/foo/bar[34m/foo/bar[39m]8;;
---
Code
cli_text("{.file /absolute/path:12}")
Message
]8;line = 12:col = 1;file:///absolute/path[34m/absolute/path:12[39m]8;;
Code
cli_text("{.file file:///absolute/path:5}")
Message
]8;line = 5:col = 1;file:///absolute/path[34mfile:///absolute/path:5[39m]8;;
Code
cli_text("{.path /absolute/path:123}")
Message
]8;line = 123:col = 1;file:///absolute/path[34m/absolute/path:123[39m]8;;
Code
cli_text("{.path file:///absolute/path:51}")
Message
]8;line = 51:col = 1;file:///absolute/path[34mfile:///absolute/path:51[39m]8;;
---
Code
cli_text("{.file relative/path:12}")
Message
]8;line = 12:col = 1;file:///testthat/home/relative/path[34mrelative/path:12[39m]8;;
Code
cli_text("{.file ./relative/path:5}")
Message
]8;line = 5:col = 1;file:///testthat/home/./relative/path[34m./relative/path:5[39m]8;;
Code
cli_text("{.path relative/path:123}")
Message
]8;line = 123:col = 1;file:///testthat/home/relative/path[34mrelative/path:123[39m]8;;
Code
cli_text("{.path ./relative/path:51}")
Message
]8;line = 51:col = 1;file:///testthat/home/./relative/path[34m./relative/path:51[39m]8;;
---
Code
cli_text("{.file ~/relative/path:12}")
Message
]8;line = 12:col = 1;file:///my/home/relative/path[34m~/relative/path:12[39m]8;;
Code
cli_text("{.path ~/relative/path:5}")
Message
]8;line = 5:col = 1;file:///my/home/relative/path[34m~/relative/path:5[39m]8;;
---
Code
cli_text("{.file /absolute/path:12:5}")
Message
]8;line = 12:col = 5;file:///absolute/path[34m/absolute/path:12:5[39m]8;;
Code
cli_text("{.file file:///absolute/path:5:100}")
Message
]8;line = 5:col = 100;file:///absolute/path[34mfile:///absolute/path:5:100[39m]8;;
Code
cli_text("{.path /absolute/path:123:1}")
Message
]8;line = 123:col = 1;file:///absolute/path[34m/absolute/path:123:1[39m]8;;
Code
cli_text("{.path file:///absolute/path:51:6}")
Message
]8;line = 51:col = 6;file:///absolute/path[34mfile:///absolute/path:51:6[39m]8;;
---
Code
cli_text("{.file relative/path:12:13}")
Message
]8;line = 12:col = 13;file:///testthat/home/relative/path[34mrelative/path:12:13[39m]8;;
Code
cli_text("{.file ./relative/path:5:20}")
Message
]8;line = 5:col = 20;file:///testthat/home/./relative/path[34m./relative/path:5:20[39m]8;;
Code
cli_text("{.path relative/path:123:21}")
Message
]8;line = 123:col = 21;file:///testthat/home/relative/path[34mrelative/path:123:21[39m]8;;
Code
cli_text("{.path ./relative/path:51:2}")
Message
]8;line = 51:col = 2;file:///testthat/home/./relative/path[34m./relative/path:51:2[39m]8;;
---
Code
cli_text("{.file ~/relative/path:12:23}")
Message
]8;line = 12:col = 23;file:///my/home/relative/path[34m~/relative/path:12:23[39m]8;;
Code
cli_text("{.path ~/relative/path:5:2}")
Message
]8;line = 5:col = 2;file:///my/home/relative/path[34m~/relative/path:5:2[39m]8;;
---
Code
paths <- c("~/foo", "bar:10", "file:///abs:10:20")
cli_text("{.file {paths}}")
Message
]8;;file:///my/home/foo[34m~/foo[39m]8;;, ]8;line = 10:col = 1;file:///testthat/home/bar[34mbar:10[39m]8;;, and ]8;line = 10:col = 20;file:///abs[34mfile:///abs:10:20[39m]8;;
# {.fun} [plain-none]
Code
cli_text("{.fun myfun}")
Message
`myfun()`
Code
cli_text("{.fun mypackage::myfun}")
Message
`mypackage::myfun()`
---
Code
funs <- paste0("mypkg::myfun", 1:3)
cli_text("{.fun {funs}}")
Message
`mypkg::myfun1()`, `mypkg::myfun2()`, and `mypkg::myfun3()`
# {.fun} [plain-all]
Code
cli_text("{.fun myfun}")
Message
`myfun()`
Code
cli_text("{.fun mypackage::myfun}")
Message
`]8;;x-r-help:mypackage::myfunmypackage::myfun]8;;()`
---
Code
funs <- paste0("mypkg::myfun", 1:3)
cli_text("{.fun {funs}}")
Message
`]8;;x-r-help:mypkg::myfun1mypkg::myfun1]8;;()`, `]8;;x-r-help:mypkg::myfun2mypkg::myfun2]8;;()`, and `]8;;x-r-help:mypkg::myfun3mypkg::myfun3]8;;()`
# turning off help [plain-all]
Code
cli_text("{.fun pkg::func}")
Message
`pkg::func()`
# {.help} [plain-none]
Code
cli_text("{.help pkg::fun}")
Message
`?pkg::fun()`
Code
cli_text("{.help [link text](pkg::fun)}")
Message
link text (`?pkg::fun()`)
---
Code
funcs <- paste0("pkg::fun", 1:3)
cli_text("{.help {funcs}}")
Message
`?pkg::fun1()`, `?pkg::fun2()`, and `?pkg::fun3()`
# {.help} [plain-all]
Code
cli_text("{.help pkg::fun}")
Message
]8;;x-r-help:pkg::funpkg::fun]8;;
Code
cli_text("{.help [link text](pkg::fun)}")
Message
]8;;x-r-help:pkg::funlink text]8;;
---
Code
funcs <- paste0("pkg::fun", 1:3)
cli_text("{.help {funcs}}")
Message
]8;;x-r-help:pkg::fun1pkg::fun1]8;;, ]8;;x-r-help:pkg::fun2pkg::fun2]8;;, and ]8;;x-r-help:pkg::fun3pkg::fun3]8;;
# {.href} [plain-none]
Code
cli_text("{.href https://cli.r-lib.org}")
Message
Code
cli_text("{.href [linktext](https://cli.r-lib.org)}")
Message
linktext ()
Code
cli_text("{.href [link text](https://cli.r-lib.org)}")
Message
link text ()
# {.href} [plain-all]
Code
cli_text("{.href https://cli.r-lib.org}")
Message
<]8;;https://cli.r-lib.orghttps://cli.r-lib.org]8;;>
Code
cli_text("{.href [linktext](https://cli.r-lib.org)}")
Message
]8;;https://cli.r-lib.orglinktext]8;;
Code
cli_text("{.href [link text](https://cli.r-lib.org)}")
Message
]8;;https://cli.r-lib.orglink text]8;;
# {.href} vectors [plain-none]
Code
url <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.href {url}}")
Message
, , and
# {.href} vectors [plain-all]
Code
url <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.href {url}}")
Message
<]8;;https://cli.r-lib.org/1https://cli.r-lib.org/1]8;;>, <]8;;https://cli.r-lib.org/2https://cli.r-lib.org/2]8;;>, and
<]8;;https://cli.r-lib.org/3https://cli.r-lib.org/3]8;;>
# {.run} [plain-none]
Code
cli_text("{.run pkg::fun(param)}")
Message
`pkg::fun(param)`
Code
cli_text("{.run [run(p1, p2)](pkg::fun(p1, p2, other = 'foo'))}")
Message
`run(p1, p2)`
# {.run} [plain-all]
Code
cli_text("{.run pkg::fun(param)}")
Message
]8;;x-r-run:pkg::fun(param)pkg::fun(param)]8;;
Code
cli_text("{.run [run(p1, p2)](pkg::fun(p1, p2, other = 'foo'))}")
Message
]8;;x-r-run:pkg::fun(p1, p2, other = 'foo')run(p1, p2)]8;;
# {.run} vectors [plain-none]
Code
codes <- paste0("pkg::fun", 1:3, "()")
cli_text("{.run {codes}}")
Message
`pkg::fun1()`, `pkg::fun2()`, and `pkg::fun3()`
# {.run} vectors [plain-all]
Code
codes <- paste0("pkg::fun", 1:3, "()")
cli_text("{.run {codes}}")
Message
]8;;x-r-run:pkg::fun1()pkg::fun1()]8;;, ]8;;x-r-run:pkg::fun2()pkg::fun2()]8;;, and ]8;;x-r-run:pkg::fun3()pkg::fun3()]8;;
# {.topic} [plain-none]
Code
cli_text("{.topic pkg::topic}")
Message
`?pkg::topic`
Code
cli_text("{.topic [link text](pkg::topic)}")
Message
link text (`?pkg::topic`)
---
Code
topics <- paste0("pkg::topic", 1:3)
cli_text("{.topic {topics}}")
Message
`?pkg::topic1`, `?pkg::topic2`, and `?pkg::topic3`
# {.topic} [plain-all]
Code
cli_text("{.topic pkg::topic}")
Message
]8;;x-r-help:pkg::topicpkg::topic]8;;
Code
cli_text("{.topic [link text](pkg::topic)}")
Message
]8;;x-r-help:pkg::topiclink text]8;;
---
Code
topics <- paste0("pkg::topic", 1:3)
cli_text("{.topic {topics}}")
Message
]8;;x-r-help:pkg::topic1pkg::topic1]8;;, ]8;;x-r-help:pkg::topic2pkg::topic2]8;;, and ]8;;x-r-help:pkg::topic3pkg::topic3]8;;
# {.url} [plain-none]
Code
cli_text("{.url https://cli.r-lib.org}")
Message
# {.url} [fancy-none]
Code
cli_text("{.url https://cli.r-lib.org}")
Message
[3m[34m[39m[23m
# {.url} [plain-all]
Code
cli_text("{.url https://cli.r-lib.org}")
Message
<]8;;https://cli.r-lib.orghttps://cli.r-lib.org]8;;>
# {.url} [fancy-all]
Code
cli_text("{.url https://cli.r-lib.org}")
Message
[3m[34m<]8;;https://cli.r-lib.orghttps://cli.r-lib.org]8;;>[39m[23m
# {.url} vector [plain-none]
Code
urls <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.url {urls}}")
Message
, , and
# {.url} vector [fancy-none]
Code
urls <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.url {urls}}")
Message
[3m[34m[39m[23m, [3m[34m[39m[23m, and
[3m[34m[39m[23m
# {.url} vector [plain-all]
Code
urls <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.url {urls}}")
Message
<]8;;https://cli.r-lib.org/1https://cli.r-lib.org/1]8;;>, <]8;;https://cli.r-lib.org/2https://cli.r-lib.org/2]8;;>, and
<]8;;https://cli.r-lib.org/3https://cli.r-lib.org/3]8;;>
# {.url} vector [fancy-all]
Code
urls <- paste0("https://cli.r-lib.org/", 1:3)
cli_text("{.url {urls}}")
Message
[3m[34m<]8;;https://cli.r-lib.org/1https://cli.r-lib.org/1]8;;>[39m[23m, [3m[34m<]8;;https://cli.r-lib.org/2https://cli.r-lib.org/2]8;;>[39m[23m, and
[3m[34m<]8;;https://cli.r-lib.org/3https://cli.r-lib.org/3]8;;>[39m[23m
# linked {.url} [plain-all]
Code
link <- c("https://cli.r-lib.org", style_hyperlink("text",
"https://cli.r-lib.org"))
cli_text("{.url {link}}")
Message
<]8;;https://cli.r-lib.orghttps://cli.r-lib.org]8;;> and <]8;;https://cli.r-lib.orgtext]8;;>
# {.vignette} [plain-none]
Code
cli_text("{.vignette pkg::name}")
Message
`vignette(pkg::name)`
Code
cli_text("{.vignette [link text](pkg::name)}")
Message
link text (`vignette(pkg::name)`)
---
Code
vignettes <- paste0("pkg::topic", 1:3)
cli_text("{.vignette {vignettes}}")
Message
`vignette(pkg::topic1)`, `vignette(pkg::topic2)`, and `vignette(pkg::topic3)`
# {.vignette} [plain-all]
Code
cli_text("{.vignette pkg::name}")
Message
]8;;x-r-vignette:pkg::namepkg::name]8;;
Code
cli_text("{.vignette [link text](pkg::name)}")
Message
]8;;x-r-vignette:pkg::namelink text]8;;
---
Code
vignettes <- paste0("pkg::topic", 1:3)
cli_text("{.vignette {vignettes}}")
Message
]8;;x-r-vignette:pkg::topic1pkg::topic1]8;;, ]8;;x-r-vignette:pkg::topic2pkg::topic2]8;;, and ]8;;x-r-vignette:pkg::topic3pkg::topic3]8;;
cli/tests/testthat/_snaps/hash.md 0000644 0001762 0000144 00000007346 14535354346 016601 0 ustar ligges users # hash_emoji
Code
hash_emoji(character())$names
Output
list()
Code
hash_emoji("")$names
Output
[[1]]
[1] "teacup without handle" "rhinoceros" "flushed face"
Code
hash_emoji("x")$names
Output
[[1]]
[1] "mage: dark skin tone" "spoon" "fuel pump"
Code
hash_emoji(NA_character_)$names
Output
[[1]]
[1] NA NA NA
Code
hash_emoji(NA)$names
Output
[[1]]
[1] NA NA NA
Code
hash_emoji(c(NA, "", "foo", NA))$names
Output
[[1]]
[1] NA NA NA
[[2]]
[1] "teacup without handle" "rhinoceros" "flushed face"
[[3]]
[1] "sun behind cloud" "raised back of hand: dark skin tone"
[3] "children crossing"
[[4]]
[1] NA NA NA
# hash_raw_emoji
Code
hash_raw_emoji(raw())$names
Output
[1] "teacup without handle" "rhinoceros" "flushed face"
Code
hash_raw_emoji(as.raw(0))$names
Output
[1] "diamond with a dot" "raised fist" "face with thermometer"
Code
hash_raw_emoji(charToRaw("foobar"))$names
Output
[1] "fishing pole" "money with wings" "eagle"
# hash_obj_emoji
Code
hash_obj_emoji("")$names
Output
[1] "woman pilot: medium skin tone" "cat with wry smile"
[3] "couple with heart"
Code
hash_obj_emoji(raw(0))$names
Output
[1] "fire" "man teacher: medium-light skin tone"
[3] "carp streamer"
Code
hash_obj_emoji(1:10)$names
Output
[1] "backhand index pointing right: medium-light skin tone"
[2] "woman office worker: medium skin tone"
[3] "tiger face"
Code
hash_obj_emoji(mtcars)$names
Output
[1] "woman judge: medium skin tone" "pause button"
[3] "flag: North Korea"
# hash_animal
Code
hash_animal(character())$words
Output
list()
Code
hash_animal("")$words
Output
[[1]]
[1] "dogtired" "conventional" "olingo"
Code
hash_animal("x")$words
Output
[[1]]
[1] "goodhearted" "lovelorn" "amphiuma"
Code
hash_animal(NA_character_)$words
Output
[[1]]
[1] NA NA NA
Code
hash_animal(NA)$words
Output
[[1]]
[1] NA NA NA
Code
hash_animal(c(NA, "", "foo", NA))$words
Output
[[1]]
[1] NA NA NA
[[2]]
[1] "dogtired" "conventional" "olingo"
[[3]]
[1] "sacrilegious" "diet" "lion"
[[4]]
[1] NA NA NA
# hash_raw_animal
Code
hash_raw_animal(raw())$words
Output
[1] "dogtired" "conventional" "olingo"
Code
hash_raw_animal(as.raw(0))$words
Output
[1] "scarabaeiform" "surly" "goldfish"
Code
hash_raw_animal(charToRaw("foobar"))$words
Output
[1] "unevolving" "degrading" "harrier"
# hash_obj_animal
Code
hash_obj_animal("")$words
Output
[1] "pathworky" "wondrous" "minibeast"
Code
hash_obj_animal(raw(0))$words
Output
[1] "undestructive" "unequal" "indianglassfish"
Code
hash_obj_animal(1:10)$words
Output
[1] "benignant" "profound" "ambushbug"
Code
hash_obj_animal(mtcars)$words
Output
[1] "novice" "flushed" "australianshelduck"
cli/tests/testthat/_snaps/rlang-errors.md 0000644 0001762 0000144 00000024262 14535354366 020271 0 ustar ligges users # cli_abort [plain]
Code
local({
n <- "boo"
cli_abort(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
})
Condition
Error:
! `n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
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}."))
})
Condition
Error:
! Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
---
Code
c(err$message, err$body)
Output
x
"`n` must be a numeric vector" "You've supplied a vector."
# cli_abort [ansi]
Code
local({
n <- "boo"
cli_abort(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
})
Condition
[1m[33mError[39m:[22m
[1m[22m[33m![39m `n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
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}."))
})
Condition
[1m[33mError[39m:[22m
[1m[22m[33m![39m Must index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
---
Code
c(err$message, err$body)
Output
"`n` must be a numeric vector"
x
"You've supplied a \033[34m\033[39m vector."
# cli_abort [unicode]
Code
local({
n <- "boo"
cli_abort(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
})
Condition
Error:
! `n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
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}."))
})
Condition
Error:
! Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
---
Code
c(err$message, err$body)
Output
x
"`n` must be a numeric vector" "You've supplied a vector."
# cli_abort [fancy]
Code
local({
n <- "boo"
cli_abort(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
})
Condition
[1m[33mError[39m:[22m
[1m[22m[33m![39m `n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
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}."))
})
Condition
[1m[33mError[39m:[22m
[1m[22m[33m![39m Must index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
---
Code
c(err$message, err$body)
Output
"`n` must be a numeric vector"
x
"You've supplied a \033[34m\033[39m vector."
# cli_warn [plain]
Code
n <- "boo"
cli_warn(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Condition
Warning:
`n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
cli_warn(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Condition
Warning:
Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
# cli_warn [ansi]
Code
n <- "boo"
cli_warn(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Condition
[1m[33mWarning[39m:[22m
[1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
cli_warn(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Condition
[1m[33mWarning[39m:[22m
[1m[22mMust index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
# cli_warn [unicode]
Code
n <- "boo"
cli_warn(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Condition
Warning:
`n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
cli_warn(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Condition
Warning:
Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
# cli_warn [fancy]
Code
n <- "boo"
cli_warn(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Condition
[1m[33mWarning[39m:[22m
[1m[22m`n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
cli_warn(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Condition
[1m[33mWarning[39m:[22m
[1m[22mMust index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
# cli_inform [plain]
Code
n <- "boo"
cli_inform(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Message
`n` must be a numeric vector
x You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
cli_inform(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Message
Must index an existing element:
i There are 26 elements.
x You've tried to subset element 100.
# cli_inform [ansi]
Code
n <- "boo"
cli_inform(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Message
[1m[22m`n` must be a numeric vector
[31mx[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
cli_inform(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Message
[1m[22mMust index an existing element:
[36mi[39m There are 26 elements.
[31mx[39m You've tried to subset element 100.
# cli_inform [unicode]
Code
n <- "boo"
cli_inform(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Message
`n` must be a numeric vector
✖ You've supplied a vector.
---
Code
local({
len <- 26
idx <- 100
cli_inform(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Message
Must index an existing element:
ℹ There are 26 elements.
✖ You've tried to subset element 100.
# cli_inform [fancy]
Code
n <- "boo"
cli_inform(c("{.var n} must be a numeric vector", x = "You've supplied a {.cls {class(n)}} vector."))
Message
[1m[22m`n` must be a numeric vector
[31m✖[39m You've supplied a [34m[39m vector.
---
Code
local({
len <- 26
idx <- 100
cli_inform(c("Must index an existing element:", i = "There {?is/are} {len} element{?s}.",
x = "You've tried to subset element {idx}."))
})
Message
[1m[22mMust index an existing element:
[36mℹ[39m There are 26 elements.
[31m✖[39m You've tried to subset element 100.
# cli_abort width in RStudio
Code
local({
len <- 26
idx <- 100
cli_abort(c(lorem_ipsum(1, 3), i = lorem_ipsum(1, 3), x = lorem_ipsum(1, 3)))
})
Condition
Error:
! Duis quis magna incididunt nulla commodo minim non exercitation
nostrud ullamco dolor exercitation ut veniam. Fugiat irure tempor commodo
voluptate ut. In et tempor excepteur quis.
i Et nisi ad quis ad cupidatat tempor laborum est excepteur aliqua veniam ex.
Sunt magna veniam Lorem elit enim et pariatur aliqua occaecat mollit
consequat dolore in mollit. Officia labore reprehenderit culpa dolore quis
nisi do aliqua commodo deserunt fugiat cupidatat nostrud ad.
x Ad laboris consectetur esse minim pariatur irure do anim anim. Mollit ad
cupidatat ullamco ullamco nulla elit in.
# color in RStudio [ansi]
Code
col <- get_rstudio_fg_color0()
cat(col("this is the new color"))
Output
[30mthis is the new color[39m
# update_rstudio_color [ansi]
Code
cat(update_rstudio_color("color me interested"))
Output
[32mcolor me interested[39m
cli/tests/testthat/_snaps/containers.md 0000644 0001762 0000144 00000005104 14535354345 020010 0 ustar ligges users # auto closing
Code
local({
cli_div(theme = list(`.xx .emph` = list(before = "itsu:")))
f <- (function() {
cli_par(class = "xx")
cli_text("foo {.emph blah} bar")
})
f()
cli_text("foo {.emph blah} bar")
})
Message
foo itsu:blah bar
foo blah bar
# opt out of auto closing
Code
local({
cli_div(theme = list(`.xx .emph` = list(before = "itsu:")))
id <- NULL
f <- (function() {
id <<- cli_par(class = "xx", .auto_close = FALSE)
cli_text("foo {.emph blah} bar")
})
f()
cli_text("foo {.emph blah} bar")
expect_false(is.null(id))
cli_end(id)
cli_text("foo {.emph blah} bar")
})
Message
foo itsu:blah bar
foo itsu:blah bar
foo blah bar
# auto closing with special env
Code
local({
cli_div(theme = list(`.xx .emph` = list(before = "itsu:")))
f <- (function() {
g()
cli_text("foo {.emph blah} bar")
})
g <- (function() {
cli_par(class = "xx", .auto_close = TRUE, .envir = parent.frame())
cli_text("foo {.emph blah} bar")
})
f()
cli_text("foo {.emph blah} bar")
})
Message
foo itsu:blah bar
foo itsu:blah bar
foo blah bar
# div with special style
Code
f <- (function() {
cli_div(theme = list(`.xx .emph` = list(before = "itsu:")))
cli_par(class = "xx")
cli_text("foo {.emph blah} bar")
})
f()
Message
foo itsu:blah bar
Code
cli_text("foo {.emph blah} bar")
Message
foo blah bar
# margin is squashed
Code
local({
cli_div(theme = list(par = list(`margin-top` = 4, `margin-bottom` = 4)))
cli_text("three lines")
cli_par()
cli_par()
cli_par()
cli_text("until here")
cli_end()
cli_end()
cli_end()
cli_par()
cli_par()
cli_par()
cli_text("no space, still")
cli_end()
cli_end()
cli_end()
cli_text("three lines again")
})
Message
three lines
until here
no space, still
three lines again
# before and after work properly
Code
local({
cli_div(theme = list(`div.alert-success` = list(before = "!!!")))
cli_alert_success("{.pkg foobar} is good")
})
Message
!!!foobar is good
cli/tests/testthat/_snaps/alerts.md 0000644 0001762 0000144 00000004272 14535354336 017142 0 ustar ligges users # generic
Code
local({
cli_div(theme = list(.alert = list(before = "GENERIC! ")))
cli_alert("wow")
})
Message
GENERIC! wow
# success [plain]
Code
local({
cli_alert_success("wow")
})
Message
v wow
# success [ansi]
Code
local({
cli_alert_success("wow")
})
Message
[32mv[39m wow
# success [unicode]
Code
local({
cli_alert_success("wow")
})
Message
✔ wow
# success [fancy]
Code
local({
cli_alert_success("wow")
})
Message
[32m✔[39m wow
# danger [plain]
Code
local({
cli_alert_danger("wow")
})
Message
x wow
# danger [ansi]
Code
local({
cli_alert_danger("wow")
})
Message
[31mx[39m wow
# danger [unicode]
Code
local({
cli_alert_danger("wow")
})
Message
✖ wow
# danger [fancy]
Code
local({
cli_alert_danger("wow")
})
Message
[31m✖[39m wow
# warning [plain]
Code
local({
cli_alert_warning("wow")
})
Message
! wow
# warning [ansi]
Code
local({
cli_alert_warning("wow")
})
Message
[33m![39m wow
# warning [unicode]
Code
local({
cli_alert_warning("wow")
})
Message
! wow
# warning [fancy]
Code
local({
cli_alert_warning("wow")
})
Message
[33m![39m wow
# info [plain]
Code
local({
cli_alert_info("wow")
})
Message
i wow
# info [ansi]
Code
local({
cli_alert_info("wow")
})
Message
[36mi[39m wow
# info [unicode]
Code
local({
cli_alert_info("wow")
})
Message
ℹ wow
# info [fancy]
Code
local({
cli_alert_info("wow")
})
Message
[36mℹ[39m wow
# before and after can have spaces
Code
local({
cli_div(theme = list(.alert = list(before = "x ", after = " x")))
cli_alert("continuing that first alert", wrap = TRUE)
})
Message
x continuing that first alert x
cli/tests/testthat/_snaps/utils.md 0000644 0001762 0000144 00000006305 14535354371 017006 0 ustar ligges users # ruler
Code
ruler(20)
Output
----+----1----+----2
12345678901234567890
# na.omit
Code
na.omit(character())
Output
character(0)
Code
na.omit(integer())
Output
integer(0)
Code
na.omit(1:5)
Output
[1] 1 2 3 4 5
Code
na.omit(c(1, NA, 2, NA))
Output
[1] 1 2
Code
na.omit(c(NA_integer_, NA_integer_))
Output
integer(0)
Code
na.omit(list(1, 2, 3))
Output
[[1]]
[1] 1
[[2]]
[1] 2
[[3]]
[1] 3
# str_trim
Code
str_trim("foo")
Output
[1] "foo"
Code
str_trim(character())
Output
character(0)
Code
str_trim(" foo")
Output
[1] "foo"
Code
str_trim("foo ")
Output
[1] "foo"
Code
str_trim(" foo ")
Output
[1] "foo"
Code
str_trim(c(NA_character_, " foo ", NA_character_, " bar "))
Output
[1] NA "foo" NA "bar"
# leading_space
Code
paste0("-", leading_space("foo"), "-")
Output
[1] "--"
Code
paste0("-", leading_space(" foo"), "-")
Output
[1] "- -"
Code
paste0("-", leading_space(" foo "), "-")
Output
[1] "- -"
Code
paste0("-", leading_space(" \t foo "), "-")
Output
[1] "- \t -"
Code
paste0("-", leading_space(" foo "), "-")
Output
[1] "- -"
Code
paste0("-", leading_space(" foo "), "-")
Output
[1] "- -"
# trailing_space
Code
paste0("-", trailing_space("foo"), "-")
Output
[1] "--"
Code
paste0("-", trailing_space("foo "), "-")
Output
[1] "- -"
Code
paste0("-", trailing_space(" foo "), "-")
Output
[1] "- -"
Code
paste0("-", trailing_space(" foo \t "), "-")
Output
[1] "- \t -"
Code
paste0("-", trailing_space(" foo "), "-")
Output
[1] "- -"
Code
paste0("-", trailing_space(" foo "), "-")
Output
[1] "- -"
# abbrev
Code
abbrev("123456789012345")
Output
[1] 1234567...
Code
abbrev("12345678901")
Output
[1] 1234567...
Code
abbrev("1234567890")
Output
[1] 1234567890
Code
abbrev("123456789")
Output
[1] 123456789
Code
abbrev("12345")
Output
[1] 12345
Code
abbrev("1")
Output
[1] 1
Code
abbrev("")
Output
[1]
Code
abbrev("\033[31m1234567890\033[39m")
Output
[1] [31m1234567890[39m
Code
abbrev(c("\033[31m1234567890\033[39m", "", "1234567890123"), 5)
Output
[1] [31m12[39m...
[2]
[3] 12...
Code
abbrev(rep("\033[31m1234567890\033[39m", 5), 5)
Output
}}\preformatted{list(
"par.output h1" = list("background-color" = "red", color = "#e0e0e0"),
"par.output h2" = list("background-color" = "orange", color = "#e0e0e0"),
"par.output h3" = list("background-color" = "blue", color = "#e0e0e0")
)
}\if{html}{\out{
}}
Create a custom alert type:
\if{html}{\out{}}\preformatted{list(
".alert-start" = list(before = symbol$play),
".alert-stop" = list(before = symbol$stop)
)
}\if{html}{\out{
}}
}
cli/man/hash_md5.Rd 0000644 0001762 0000144 00000002746 14521175065 013572 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hash.R
\name{hash_md5}
\alias{hash_md5}
\alias{hash_raw_md5}
\alias{hash_obj_md5}
\alias{hash_file_md5}
\title{MD5 hash}
\usage{
hash_md5(x)
hash_raw_md5(x)
hash_obj_md5(x, serialize_version = 2)
hash_file_md5(paths)
}
\arguments{
\item{x}{Character vector. If not a character vector, then
\code{\link[=as.character]{as.character()}} is used to try to coerce it into one. \code{NA} entries
will have an \code{NA} hash.}
\item{serialize_version}{Workspace format version to use, see
\code{\link[base:serialize]{base::serialize()}}.}
\item{paths}{Character vector of file names.}
}
\value{
\code{hash_md5()} returns a character vector of hexadecimal MD5
hashes.
\code{hash_raw_md5()} returns a character scalar.
\code{hash_obj_md5()} returns a character scalar.
}
\description{
Calculate the MD5 hash of each element of a character vector.
}
\details{
\code{hash_raw_md5()} calculates the MD5 hash of the bytes
of a raw vector.
\code{hash_obj_md5()} calculates the MD5 hash of an R
object. The object is serialized into a binary vector first.
\code{hash_file_md5()} calculates the MD5 hash of one or more
files.
}
\examples{
hash_md5(c("foo", NA, "bar", ""))
}
\seealso{
\code{\link[tools:md5sum]{tools::md5sum()}} for a base R MD5 function that works on
files.
Other hash functions:
\code{\link{hash_animal}()},
\code{\link{hash_emoji}()},
\code{\link{hash_sha1}()},
\code{\link{hash_sha256}()}
}
\concept{hash functions}
cli/man/hash_sha256.Rd 0000644 0001762 0000144 00000003030 14521175065 014100 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hash.R
\name{hash_sha256}
\alias{hash_sha256}
\alias{hash_raw_sha256}
\alias{hash_obj_sha256}
\alias{hash_file_sha256}
\title{SHA-256 hash}
\usage{
hash_sha256(x)
hash_raw_sha256(x)
hash_obj_sha256(x, serialize_version = 2)
hash_file_sha256(paths)
}
\arguments{
\item{x}{Character vector. If not a character vector, then
\code{\link[=as.character]{as.character()}} is used to try to coerce it into one. \code{NA} entries
will have an \code{NA} hash.}
\item{serialize_version}{Workspace format version to use, see
\code{\link[base:serialize]{base::serialize()}}.}
\item{paths}{Character vector of file names.}
}
\value{
\code{hash_sha256()} returns a character vector of hexadecimal
SHA-256 hashes.
\code{hash_raw_sha256()} returns a character scalar.
\code{hash_obj_sha256()} returns a character scalar.
\code{hash_file_sha256()} returns a character vector of SHA-256
hashes.
}
\description{
Calculate the SHA-256 hash of each element of a character vector.
}
\details{
\code{hash_raw_sha256()} calculates the SHA-256 hash of the bytes
of a raw vector.
\code{hash_obj_sha256()} calculates the SHA-256 hash of an R
object. The object is serialized into a binary vector first.
\code{hash_file_sha256()} calculates the SHA-256 hash of one or
more files.
}
\examples{
hash_sha256(c("foo", NA, "bar", ""))
}
\seealso{
Other hash functions:
\code{\link{hash_animal}()},
\code{\link{hash_emoji}()},
\code{\link{hash_md5}()},
\code{\link{hash_sha1}()}
}
\concept{hash functions}
cli/man/ansi_trimws.Rd 0000644 0001762 0000144 00000002124 14143453131 014420 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansiex.R
\name{ansi_trimws}
\alias{ansi_trimws}
\title{Remove leading and/or trailing whitespace from an ANSI string}
\usage{
ansi_trimws(x, which = c("both", "left", "right"))
}
\arguments{
\item{x}{ANSI string vector.}
\item{which}{Whether to remove leading or trailing whitespace or both.}
}
\value{
ANSI string, with the whitespace removed.
}
\description{
This function is similar to \code{\link[base:trimws]{base::trimws()}} but works on ANSI strings,
and keeps color and other styling.
}
\examples{
trimws(paste0(" ", col_red("I am red"), " "))
ansi_trimws(paste0(" ", col_red("I am red"), " "))
trimws(col_red(" I am red "))
ansi_trimws(col_red(" I am red "))
}
\seealso{
Other ANSI string operations:
\code{\link{ansi_align}()},
\code{\link{ansi_columns}()},
\code{\link{ansi_nchar}()},
\code{\link{ansi_strsplit}()},
\code{\link{ansi_strtrim}()},
\code{\link{ansi_strwrap}()},
\code{\link{ansi_substring}()},
\code{\link{ansi_substr}()},
\code{\link{ansi_toupper}()}
}
\concept{ANSI string operations}
cli/man/utf8_nchar.Rd 0000644 0001762 0000144 00000002671 14143453131 014131 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utf8.R
\name{utf8_nchar}
\alias{utf8_nchar}
\title{Count the number of characters in a character vector}
\usage{
utf8_nchar(x, type = c("chars", "bytes", "width", "graphemes", "codepoints"))
}
\arguments{
\item{x}{Character vector, it is converted to UTF-8.}
\item{type}{Whether to count graphemes (characters), code points,
bytes, or calculate the display width of the string.}
}
\value{
Numeric vector, the length of the strings in the character
vector.
}
\description{
By default it counts Unicode grapheme clusters, instead of code points.
}
\examples{
# Grapheme example, emoji with combining characters. This is a single
# grapheme, consisting of five Unicode code points:
# * `\U0001f477` is the construction worker emoji
# * `\U0001f3fb` is emoji modifier that changes the skin color
# * `\u200d` is the zero width joiner
# * `\u2640` is the female sign
# * `\ufe0f` is variation selector 16, requesting an emoji style glyph
emo <- "\U0001f477\U0001f3fb\u200d\u2640\ufe0f"
cat(emo)
utf8_nchar(emo, "chars") # = graphemes
utf8_nchar(emo, "bytes")
utf8_nchar(emo, "width")
utf8_nchar(emo, "codepoints")
# For comparision, the output for width depends on the R version used:
nchar(emo, "chars")
nchar(emo, "bytes")
nchar(emo, "width")
}
\seealso{
Other UTF-8 string manipulation:
\code{\link{utf8_graphemes}()},
\code{\link{utf8_substr}()}
}
\concept{UTF-8 string manipulation}
cli/man/ansi_collapse.Rd 0000644 0001762 0000144 00000004761 14521175065 014715 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/glue.R
\name{ansi_collapse}
\alias{ansi_collapse}
\title{Collapse a vector into a string scalar}
\usage{
ansi_collapse(
x,
sep = ", ",
sep2 = " and ",
last = ", and ",
trunc = Inf,
width = Inf,
ellipsis = symbol$ellipsis,
style = c("both-ends", "head")
)
}
\arguments{
\item{x}{Character vector, or an object with an \code{as.character()} method
to collapse.}
\item{sep}{Separator. A character string.}
\item{sep2}{Separator for the special case that \code{x} contains only two
elements. A character string.}
\item{last}{Last separator, if there is no truncation. E.g. use
\code{", and "} for the \href{https://en.wikipedia.org/wiki/Serial_comma}{serial comma}. A character string.}
\item{trunc}{Maximum number of elements to show. For \code{style = "head"}
at least \code{trunc = 1} is used. For \code{style = "both-ends"} at least
\code{trunc = 5} is used, even if a smaller number is specified.}
\item{width}{Limit for the display width of the result, in characters.
This is a hard limit, and the output will never exceed it.
This argument is not implemented for the \code{"both-ends"} style, which
always uses \code{Inf}, with a warning if a finite \code{width} value is set.}
\item{ellipsis}{Character string to use at the place of the truncation.
By default, the Unicode ellipsis character is used if the console is
UTF-8, and three dots otherwise.}
\item{style}{Truncation style:
\itemize{
\item \code{both-ends}: the default, shows the beginning and end of the vector,
and skips elements in the middle if needed.
\item \code{head}: shows the beginning of the vector, and skips elements at the
end, if needed.
}}
}
\value{
Character scalar. It is \code{NA_character_} if any elements in \code{x}
are \code{NA}.
}
\description{
Features:
\itemize{
\item custom separator (\code{sep}),
\item custom separator for length-two input (\code{sep2}),
\item custom last separator (\code{last}),
\item adds ellipsis to truncated strings,
\item uses Unicode ellipsis character on UTF-8 console,
\item can collapse "from both ends", with \code{style = "both-ends"},
\item can consider a limit for the display width of the result, in characters,
\item handles ANSI control sequences correctly when measuring display width.
}
}
\examples{
ansi_collapse(letters)
# truncate
ansi_collapse(letters, trunc = 5)
# head style
ansi_collapse(letters, trunc = 5, style = "head")
}
\seealso{
\code{glue_collapse} in the glue package inspired this function.
}
cli/man/cli_abort.Rd 0000644 0001762 0000144 00000011250 14500305721 014015 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rlang.R
\name{cli_abort}
\alias{cli_abort}
\alias{cli_warn}
\alias{cli_inform}
\title{Signal an error, warning or message with a cli formatted
message}
\usage{
cli_abort(
message,
...,
call = .envir,
.envir = parent.frame(),
.frame = .envir
)
cli_warn(message, ..., .envir = parent.frame())
cli_inform(message, ..., .envir = parent.frame())
}
\arguments{
\item{message}{It is formatted via a call to \code{\link[=cli_bullets]{cli_bullets()}}.}
\item{...}{Passed to \code{\link[rlang:abort]{rlang::abort()}}, \code{\link[rlang:abort]{rlang::warn()}} or
\code{\link[rlang:abort]{rlang::inform()}}.}
\item{call}{The execution environment of a currently running
function, e.g. \code{call = caller_env()}. The corresponding function
call is retrieved and mentioned in error messages as the source
of the error.
You only need to supply \code{call} when throwing a condition from a
helper function which wouldn't be relevant to mention in the
message.
Can also be \code{NULL} or a \link[rlang:topic-defuse]{defused function call} to
respectively not display any call or hard-code a code to display.
For more information about error calls, see \ifelse{html}{\link[rlang:topic-error-call]{Including function calls in error messages}}{\link[rlang:topic-error-call]{Including function calls in error messages}}.}
\item{.envir}{Environment to evaluate the glue expressions in.}
\item{.frame}{The throwing context. Used as default for
\code{.trace_bottom}, and to determine the internal package to mention
in internal errors when \code{.internal} is \code{TRUE}.}
}
\description{
These functions let you create error, warning or diagnostic
messages with cli formatting, including inline styling,
pluralization and glue substitutions.
}
\details{
\if{html}{\out{}}\preformatted{n <- "boo"
cli_abort(c(
"\{.var n\} must be a numeric vector",
"x" = "You've supplied a \{.cls \{class(n)\}\} vector."
))
}\if{html}{\out{
}}\if{html}{\out{
#> Error: #> ! `n` must be a numeric vector #> ✖ You've supplied a <character> vector. #> Run `rlang::last_error()` to see where the error occurred.
}}\preformatted{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\}."
))
}\if{html}{\out{
}}\if{html}{\out{
#> Error: #> ! Must index an existing element: #> ℹ There are 26 elements. #> ✖ You've tried to subset element 100. #> Run `rlang::last_error()` to see where the error occurred.
}}\preformatted{cli_verbatim("This has\\nthree\\nlines,")
}\if{html}{\out{
}}\if{html}{\out{
#> This has #> three #> lines,
}}\preformatted{cli_verbatim("No string \{interpolation\} or \{.emph styling\} here")
}\if{html}{\out{
}}\if{html}{\out{
#> No string \{interpolation\} or \{.emph styling\} here
}}\preformatted{cnt <- cli_par()
cli_text("First paragraph.")
cli_end(cnt)
cnt <- cli_par()
cli_text("Second paragraph.")
cli_end(cnt)
}\if{html}{\out{
}}\if{html}{\out{
#> First paragraph. #> #> Second paragraph. #>
}}\preformatted{list <- cli_ul()
cli_li("Item one:")
cli_li("Item two:")
cli_par()
cli_text("Still item two.")
cli_end(list)
cli_text("Not in the list any more")
}\if{html}{\out{
}}\if{html}{\out{
#> • Item one: #> • Item two: #> Still item two. #> #> Not in the list any more
}}\preformatted{cli_par()
cli_text("First paragraph")
cli_end()
cli_par()
cli_text("Second paragraph")
cli_end()
}\if{html}{\out{
}}\if{html}{\out{
#> First paragraph #> #> Second paragraph #>
}}\preformatted{fun <- function() \{
cli_div(id = "mydiv")
cli_par(class = "myclass")
cli:::cli_debug_doc()
\}
fun()
}\if{html}{\out{
}}\if{html}{\out{
#> <cli document> #> <body id="body"> #> <div id="mydiv"> +theme #> <par id="cli-82040-64" class="myclass">
}}\preformatted{clifun <- function() \{
cli_par()
cli_text(cli:::lorem_ipsum())
\}
clifun()
clifun()
}\if{html}{\out{
}}\if{html}{\out{
#> Sunt anim ullamco Lorem qui mollit anim est in deserunt adipisicing. #> Enim deserunt laborum ad qui qui. Anim esse non anim magna Lorem #> consequat dolore labore cupidatat magna et. Esse nulla eiusmod Lorem #> exercitation cupidatat velit enim exercitation excepteur non officia #> incididunt. Id laborum dolore commodo Lorem esse ea sint proident. #> #> Fugiat mollit in Lorem velit qui exercitation ipsum consectetur ad #> nisi ut eu do ullamco. Mollit officia reprehenderit culpa Lorem est #> reprehenderit excepteur enim magna incididunt ea. Irure nisi ad #> exercitation deserunt enim anim excepteur quis minim laboris veniam #> nulla pariatur. Enim irure aute nulla irure qui non. Minim velit #> proident sunt sint. Proident sit occaecat ex aute. #>
}}\preformatted{n <- "boo"
stop(format_error(c(
"\{.var n\} must be a numeric vector",
"x" = "You've supplied a \{.cls \{class(n)\}\} vector."
)))
}\if{html}{\out{
}}\if{html}{\out{
#> Error: `n` must be a numeric vector #> ✖ You've supplied a <character> vector.
}}\preformatted{len <- 26
idx <- 100
stop(format_error(c(
"Must index an existing element:",
"i" = "There \{?is/are\} \{len\} element\{?s\}.",
"x" = "You've tried to subset element \{idx\}."
)))
}\if{html}{\out{
}}\if{html}{\out{
#> Error: Must index an existing element: #> ℹ There are 26 elements. #> ✖ You've tried to subset element 100.
}}\preformatted{f <- function() \{
cli_progress_step("Downloading data")
Sys.sleep(2)
cli_progress_step("Importing data")
Sys.sleep(1)
cli_progress_step("Cleaning data")
Sys.sleep(2)
cli_progress_step("Fitting model")
Sys.sleep(3)
\}
f()
}\if{html}{\out{
}}
\if{html}{\figure{progress-step.svg}}
}
\subsection{Spinner}{
You can add a spinner to some or all steps with \code{spinner = TRUE},
but note that this will only work if you call \code{\link[=cli_progress_update]{cli_progress_update()}}
regularly.
\if{html}{\out{}}\preformatted{f <- function() \{
cli_progress_step("Downloading data", spinner = TRUE)
for (i in 1:100) \{ Sys.sleep(2/100); cli_progress_update() \}
cli_progress_step("Importing data")
Sys.sleep(1)
cli_progress_step("Cleaning data")
Sys.sleep(2)
cli_progress_step("Fitting model", spinner = TRUE)
for (i in 1:100) \{ Sys.sleep(3/100); cli_progress_update() \}
\}
f()
}\if{html}{\out{
}}
\if{html}{\figure{progress-step-spin.svg}}
}
\subsection{Dynamic messages}{
You can make the step messages dynamic, using glue templates.
Since \code{cli_progress_step()} show that message immediately, we need
to initialize \code{msg} first.
\if{html}{\out{}}\preformatted{f <- function() \{
msg <- ""
cli_progress_step("Downloading data\{msg\}", spinner = TRUE)
for (i in 1:100) \{
Sys.sleep(2/100)
msg <- glue::glue(", got file \{i\}/100")
cli_progress_update()
\}
cli_progress_step("Importing data")
Sys.sleep(1)
cli_progress_step("Cleaning data")
Sys.sleep(2)
cli_progress_step("Fitting model", spinner = TRUE)
for (i in 1:100) \{ Sys.sleep(3/100); cli_progress_update() \}
\}
f()
}\if{html}{\out{
}}
\if{html}{\figure{progress-step-dynamic.svg}}
}
\subsection{Termination messages}{
You can specify a different message for successful and/or
unsuccessful termination:
\if{html}{\out{}}\preformatted{f <- function() \{
size <- 0L
cli_progress_step(
"Downloading data.",
msg_done = "Downloaded \{prettyunits::pretty_bytes(size)\}.",
spinner = TRUE
)
for (i in 1:100) \{
Sys.sleep(3/100)
size <- size + 8192
cli_progress_update()
\}
\}
f()
}\if{html}{\out{
}}
\if{html}{\figure{progress-step-msg.svg}}
}
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
Other progress bar functions:
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_builtin_handlers}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_num}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_styles}()},
\code{\link{progress-variables}}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_rule}},
\code{\link{cli_status_update}()},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{progress bar functions}
cli/man/cli_status_update.Rd 0000644 0001762 0000144 00000004136 14500305721 015600 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/status-bar.R
\name{cli_status_update}
\alias{cli_status_update}
\title{Update the status bar (superseded)}
\usage{
cli_status_update(
id = NULL,
msg = NULL,
msg_done = NULL,
msg_failed = NULL,
.envir = parent.frame()
)
}
\arguments{
\item{id}{Id of the status bar to update. Defaults to the current
status bar container.}
\item{msg}{Text to update the status bar with. \code{NULL} if you don't want
to change it.}
\item{msg_done}{Updated "done" message. \code{NULL} if you don't want to
change it.}
\item{msg_failed}{Updated "failed" message. \code{NULL} if you don't want to
change it.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\value{
Id of the status bar container.
}
\description{
\strong{The \verb{cli_status_*()} functions are superseded by
the \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}} functions,
because they have a better default behavior.}
Update the status bar
}
\seealso{
This function supports \link[=inline-markup]{inline markup}.
The \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[=cli_progress_step]{cli_progress_step()}}
functions, for a superior API.
Other status bar:
\code{\link{cli_process_start}()},
\code{\link{cli_status_clear}()},
\code{\link{cli_status}()}
Other functions supporting inline markup:
\code{\link{cli_abort}()},
\code{\link{cli_alert}()},
\code{\link{cli_blockquote}()},
\code{\link{cli_bullets_raw}()},
\code{\link{cli_bullets}()},
\code{\link{cli_dl}()},
\code{\link{cli_h1}()},
\code{\link{cli_li}()},
\code{\link{cli_ol}()},
\code{\link{cli_process_start}()},
\code{\link{cli_progress_along}()},
\code{\link{cli_progress_bar}()},
\code{\link{cli_progress_message}()},
\code{\link{cli_progress_output}()},
\code{\link{cli_progress_step}()},
\code{\link{cli_rule}},
\code{\link{cli_status}()},
\code{\link{cli_text}()},
\code{\link{cli_ul}()},
\code{\link{format_error}()},
\code{\link{format_inline}()}
}
\concept{functions supporting inline markup}
\concept{status bar}
cli/man/cli_h1.Rd 0000644 0001762 0000144 00000005534 14500305721 013226 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_h1}
\alias{cli_h1}
\alias{cli_h2}
\alias{cli_h3}
\title{CLI headings}
\usage{
cli_h1(text, id = NULL, class = NULL, .envir = parent.frame())
cli_h2(text, id = NULL, class = NULL, .envir = parent.frame())
cli_h3(text, id = NULL, class = NULL, .envir = parent.frame())
}
\arguments{
\item{text}{Text of the heading. It can contain inline markup.}
\item{id}{Id of the heading element, string. It can be used in themes.}
\item{class}{Class of the heading element, string. It can be used in
themes.}
\item{.envir}{Environment to evaluate the glue expressions in.}
}
\description{
cli has three levels of headings.
}
\details{
This is how the headings look with the default builtin theme.
\if{html}{\out{}}\preformatted{cli_h1("Header \{.emph 1\}")
cli_h2("Header \{.emph 2\}")
cli_h3("Header \{.emph 3\}")
}\if{html}{\out{
}}\if{html}{\out{
#> #> ── Header 1 ────────────────────────────────────────────────────────── #> #> ── Header 2 ── #> #> ── Header 3
}}\preformatted{demo_spinners("clock")
}\if{html}{\out{
}}
\if{html}{\figure{demo-spinners.svg}}
}
\seealso{
Other spinners:
\code{\link{get_spinner}()},
\code{\link{list_spinners}()},
\code{\link{make_spinner}()}
}
\concept{spinners}
cli/man/make_ansi_style.Rd 0000644 0001762 0000144 00000004141 14200445676 015242 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ansi.R
\name{make_ansi_style}
\alias{make_ansi_style}
\title{Create a new ANSI style}
\usage{
make_ansi_style(..., bg = FALSE, grey = FALSE, colors = num_ansi_colors())
}
\arguments{
\item{...}{The style to create. See details and examples below.}
\item{bg}{Whether the color applies to the background.}
\item{grey}{Whether to specifically create a grey color.
This flag is included, because ANSI 256 has a finer color scale
for greys, then the usual 0:5 scale for red, green and blue components.
It is only used for RGB color specifications (either numerically
or via a hexadecimal string), and it is ignored on eight color ANSI
terminals.}
\item{colors}{Number of colors, detected automatically
by default.}
}
\value{
A function that can be used to color (style) strings.
}
\description{
Create a function that can be used to add ANSI styles to text.
}
\details{
The \code{...} style argument can be any of the following:
\itemize{
\item A cli ANSI style function of class \code{cli_ansi_style}. This is returned
as is, without looking at the other arguments.
\item An R color name, see \code{\link[grDevices:colors]{grDevices::colors()}}.
\item A 6- or 8-digit hexadecimal color string, e.g. \verb{#ff0000} means
red. Transparency (alpha channel) values are ignored.
\item A one-column matrix with three rows for the red, green
and blue channels, as returned by \code{\link[grDevices:col2rgb]{grDevices::col2rgb()}}.
}
\code{make_ansi_style()} detects the number of colors to use
automatically (this can be overridden using the \code{colors}
argument). If the number of colors is less than 256 (detected or given),
then it falls back to the color in the ANSI eight color mode that
is closest to the specified (RGB or R) color.
}
\examples{
make_ansi_style("orange")
make_ansi_style("#123456")
make_ansi_style("orange", bg = TRUE)
orange <- make_ansi_style("orange")
orange("foobar")
cat(orange("foobar"))
}
\seealso{
Other ANSI styling:
\code{\link{ansi-styles}},
\code{\link{combine_ansi_styles}()},
\code{\link{num_ansi_colors}()}
}
\concept{ANSI styling}
cli/man/cat_line.Rd 0000644 0001762 0000144 00000002531 14143453131 013641 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cat.R
\name{cat_line}
\alias{cat_line}
\alias{cat_bullet}
\alias{cat_boxx}
\alias{cat_rule}
\alias{cat_print}
\title{\code{cat()} helpers}
\usage{
cat_line(..., col = NULL, background_col = NULL, file = stdout())
cat_bullet(
...,
col = NULL,
background_col = NULL,
bullet = "bullet",
bullet_col = NULL,
file = stdout()
)
cat_boxx(..., file = stdout())
cat_rule(..., file = stdout())
cat_print(x, file = "")
}
\arguments{
\item{...}{For \code{cat_line()} and \code{cat_bullet()}, pasted together with
\code{collapse = "\\n"}. For \code{cat_rule()} and \code{cat_boxx()} passed on to
\code{\link[=rule]{rule()}} and \code{\link[=boxx]{boxx()}} respectively.}
\item{col, background_col, bullet_col}{Colors for text, background, and
bullets respectively.}
\item{file}{Output destination. Defaults to standard output.}
\item{bullet}{Name of bullet character. Indexes into \link{symbol}}
\item{x}{An object to print.}
}
\description{
These helpers provide useful wrappers around \code{\link[=cat]{cat()}}: most importantly
they all set \code{sep = ""}, and \code{cat_line()} automatically adds a newline.
}
\examples{
cat_line("This is ", "a ", "line of text.", col = "red")
cat_bullet(letters[1:5])
cat_bullet(letters[1:5], bullet = "tick", bullet_col = "green")
cat_rule()
}
cli/man/hash_emoji.Rd 0000644 0001762 0000144 00000005170 14521175065 014202 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hash.R
\name{hash_emoji}
\alias{hash_emoji}
\alias{hash_raw_emoji}
\alias{hash_obj_emoji}
\title{Emoji hash}
\usage{
hash_emoji(x, size = 3)
hash_raw_emoji(x, size = 3)
hash_obj_emoji(x, size = 3, serialize_version = 2)
}
\arguments{
\item{x}{Character vector. \code{NA} entries will have an \code{NA} hash.}
\item{size}{Number of emojis to use in a hash. Currently it has to
be from 1 through 4.}
\item{serialize_version}{Workspace format version to use, see
\code{\link[base:serialize]{base::serialize()}}.}
}
\value{
\code{hash_emoji()} returns a data frame with columns
\itemize{
\item \code{hash}: the emoji hash, a string of the requested size.
\item \code{emojis}: list column with the emoji characters in character
vectors. Note that an emoji might have multiple code points.
\item \code{text}: text representation of \code{hash}, comma separated.
\item \code{names}: list column with the text representations of \code{emojis}, in
character vectors.
}
\code{hash_raw_emoji()} and \code{hash_obj_emoji()} return a list with
entries:
\itemize{
\item \code{hash}: the emoji hash, a string of requested size,
\item \code{emojis}: the individual emoji characters in a character vector,
\item \code{text}: text representation of \code{hash}, comma separated,
\item \code{names}: names of the emojis, in a character vector.
}
}
\description{
Emoji hash
}
\details{
It uses the first 13 hexadecimal characters (out of the 32) of the MD5
hash of the input, and converts them into an emoji representation.
It uses a manually selected subset of all emojis, that tend to be
displayed correctly.
\subsection{Number of possible hash values}{
cli uses 2280 possible emojis. This is the number of
different hashes you can get for different values of \code{size}:\tabular{rr}{
\code{size} \tab size of hash table space \cr
1 \tab 2,280 \cr
2 \tab 5,198,400 \cr
3 \tab 11,852,352,000 \cr
4 \tab 27,023,362,560,000 \cr
}
}
\code{hash_raw_emoji()} calculates the emoji hash of the bytes
of a raw vector.
\code{hash_obj_emoji()} calculates the emoji hash of an R
object. The object is serialized into a binary vector first.
}
\examples{
hash_emoji(c("foo", NA, "bar", ""))$text
# if you increase `size`, the shorter hash is a prefix of the longer:
hash_emoji("foobar", 1)$text
hash_emoji("foobar", 2)$text
hash_emoji("foobar", 3)$text
hash_emoji("foobar", 4)$text
}
\seealso{
the emoji package for a comprehensive list of emojis
Other hash functions:
\code{\link{hash_animal}()},
\code{\link{hash_md5}()},
\code{\link{hash_sha1}()},
\code{\link{hash_sha256}()}
}
\concept{hash functions}
cli/man/chunks/ 0000755 0001762 0000144 00000000000 14535436706 013104 5 ustar ligges users cli/man/chunks/FAQ.Rmd 0000644 0001762 0000144 00000005144 14143453131 014145 0 ustar ligges users
```{r, include = FALSE}
knitr::opts_chunk$set(
R.options = list(
cli.num_colors = 1L,
cli.unicode = FALSE
),
results = "hold",
comment = "#>",
cache = TRUE
)
```
## My platform supports ANSI colors, why does cli not use them?
It is probably a mistake in the ANSI support detection algorithm.
Please open an issue at https://github.com/r-lib/cli/issues and do not forget to tell us the details of your platform and terminal or GUI.
## How do I turn off ANSI colors and styles?
Set the `NO_COLOR` environment variable to a non-empty value.
You can do this in your `.Renviron` file (use `usethis::edit_r_environ()`).
If you want to do this for testthat tests, then consider using the 3rd edition on testthat, which does turn off ANSI styling automatically inside `test_that()`.
## cli does not show the output before `file.choose()`
Try calling `flush.console()` to flush the console, before `file.choose()`.
If flushing does not work and you are in RStudio, then it is probably this RStudio bug: https://github.com/rstudio/rstudio/issues/8040
See more details at https://github.com/r-lib/cli/issues/151
## Why are heading separators wider than my screen in RStudio?
The display width of some Unicode characters ambiguous in the Unicode standard.
Some software treats them as narrow (one column on the screen), other as wide (two columns).
In some terminal emulators (for example iTerm2), you can configure the preferred behavior.
Unfortunately the box drawing characters that cli uses also have ambiguous width.
In RStudio the behavior depends on the font.
In particular, Consolas, Courier and Inconsolata treats them as wide characters, so cli output will not look great with these.
Some good, modern fonts that look good include Menlo, Fira Code and Source Code Pro.
If you do not want to change your font, you can also turn off Unicode output, by setting the `cli.unicode` option:
```r
options(cli.unicode = FALSE)
```
A related issue: https://github.com/r-lib/cli/issues/320
## Is there a suggested font to use with cli?
In modern terminals, cli output usually looks good.
If you see too wide heading separators in RStudio, then see the previous question: Why are heading separators wider than my screen in RStudio?.
If some output is garbled, then cli probably misdetected Unicode support for your terminal or font.
You can try choosing a different font.
In our experience output looks good with Menlo, Fira Code and Source Code Pro.
Alternatively you can turn off Unicode output:
```r
options(cli.unicode = FALSE)
```
If you think this is our fault, then please also file an issue at https://github.com/r-lib/cli/issues
cli/man/chunks/pluralization.Rmd 0000644 0001762 0000144 00000013236 14143453131 016434 0 ustar ligges users ---
editor_options:
markdown:
wrap: sentence
---
```{r, include = FALSE, cache = FALSE}
knitr::opts_chunk$set(
R.options = list(
cli.num_colors = 1L,
cli.unicode = FALSE
),
results = "hold",
comment = "#>",
cache = TRUE
)
```
# Introduction
cli has tools to create messages that are printed correctly in singular and plural forms.
This usually requires minimal extra work, and increases the quality of the messages greatly.
In this document we first show some pluralization examples that you can use as guidelines.
Hopefully these are intuitive enough, so that they can be used without knowing the exact cli pluralization rules.
If you need pluralization without the semantic cli functions, see the `pluralize()` function.
# Examples
## Pluralization markup
In the simplest case the message contains a single `{}` glue substitution, which specifies the quantity that is used to select between the singular and plural forms.
Pluralization uses markup that is similar to glue, but uses the `{?` and `}` delimiters:
```{r}
library(cli)
nfile <- 0; cli_text("Found {nfile} file{?s}.")
nfile <- 1; cli_text("Found {nfile} file{?s}.")
nfile <- 2; cli_text("Found {nfile} file{?s}.")
```
Here the value of `nfile` is used to decide whether the singular or plural form of `file` is used.
This is the most common case for English messages.
## Irregular plurals
If the plural form is more difficult than a simple `s` suffix, then the singular and plural forms can be given, separated with a forward slash:
```{r}
ndir <- 1; cli_text("Found {ndir} director{?y/ies}.")
ndir <- 5; cli_text("Found {ndir} director{?y/ies}.")
```
## Use `"no"` instead of zero
For readability, it is better to use the `no()` helper function to include a count in a message.
`no()` prints the word `"no"` if the count is zero, and prints the numeric count otherwise:
```{r}
nfile <- 0; cli_text("Found {no(nfile)} file{?s}.")
nfile <- 1; cli_text("Found {no(nfile)} file{?s}.")
nfile <- 2; cli_text("Found {no(nfile)} file{?s}.")
```
## Use the length of character vectors
With the auto-collapsing feature of cli it is easy to include a list of objects in a message.
When cli interprets a character vector as a pluralization quantity, it takes the length of the vector:
```{r}
pkgs <- "pkg1"
cli_text("Will remove the {.pkg {pkgs}} package{?s}.")
pkgs <- c("pkg1", "pkg2", "pkg3")
cli_text("Will remove the {.pkg {pkgs}} package{?s}.")
```
Note that the length is only used for non-numeric vectors (when `is.numeric(x)` return `FALSE`).
If you want to use the length of a numeric vector, convert it to character via `as.character()`.
You can combine collapsed vectors with `"no"`, like this:
```{r}
pkgs <- character()
cli_text("Will remove {?no/the/the} {.pkg {pkgs}} package{?s}.")
pkgs <- c("pkg1", "pkg2", "pkg3")
cli_text("Will remove {?no/the/the} {.pkg {pkgs}} package{?s}.")
```
When the pluralization markup contains three alternatives, like above, the first one is used for zero, the second for one, and the third one for larger quantities.
## Choosing the right quantity
When the text contains multiple glue `{}` substitutions, the one right before the pluralization markup is used.
For example:
```{r}
nfiles <- 3; ndirs <- 1
cli_text("Found {nfiles} file{?s} and {ndirs} director{?y/ies}")
```
This is sometimes not the the correct one.
You can explicitly specify the correct quantity using the `qty()` function.
This sets that quantity without printing anything:
```{r}
nupd <- 3; ntotal <- 10
cli_text("{nupd}/{ntotal} {qty(nupd)} file{?s} {?needs/need} updates")
```
Note that if the message only contains a single `{}` substitution, then this may appear before or after the pluralization markup.
If the message contains multiple `{}` substitutions *after* pluralization markup, an error is thrown.
Similarly, if the message contains no `{}` substitutions at all, but has pluralization markup, an error is thrown.
# Rules
The exact rules of cli pluralization.
There are two sets of rules.
The first set specifies how a quantity is associated with a `{?}` pluralization markup.
The second set describes how the `{?}` is parsed and interpreted.
## Quantities
1. `{}` substitutions define quantities.
If the value of a `{}` substitution is numeric (when `is.numeric(x)` holds), then it has to have length one to define a quantity.
This is only enforced if the `{}` substitution is used for pluralization.
The quantity is defined as the value of `{}` then, rounded with `as.integer()`.
If the value of `{}` is not numeric, then its quantity is defined as its length.
2. If a message has `{?}` markup but no `{}` substitution, an error is thrown.
3. If a message has exactly one `{}` substitution, its value is used as the pluralization quantity for all `{?}` markup in the message.
4. If a message has multiple `{}` substitutions, then for each `{?}` markup cli uses the quantity of the `{}` substitution that precedes it.
5. If a message has multiple `{}` substitutions and has pluralization markup without a preceding `{}` substitution, an error is thrown.
## Pluralization markup
1. Pluralization markup starts with `{?` and ends with `}`.
It may not contain `{` and `}` characters, so it may not contain `{}` substitutions either.
2. Alternative words or suffixes are separated by `/`.
3. If there is a single alternative, then *nothing* is used if `quantity == 1` and this single alternative is used if `quantity != 1`.
4. If there are two alternatives, the first one is used for `quantity == 1`, the second one for `quantity != 1` (including \``quantity == 0`).
5. If there are three alternatives, the first one is used for `quantity == 0`, the second one for `quantity == 1`, and the third one otherwise.
cli/man/cli_progress_demo.Rd 0000644 0001762 0000144 00000003711 14143453131 015563 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress-variables.R
\name{cli_progress_demo}
\alias{cli_progress_demo}
\title{cli progress bar demo}
\usage{
cli_progress_demo(
name = NULL,
status = NULL,
type = c("iterator", "tasks", "download", "custom"),
total = NA,
.envir = parent.frame(),
...,
at = if (is_interactive()) NULL else 50,
show_after = 0,
live = NULL,
delay = 0,
start = as.difftime(5, units = "secs")
)
}
\arguments{
\item{name}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{status}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{type}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{total}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{.envir}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{...}{Passed to \code{\link[=cli_progress_bar]{cli_progress_bar()}}.}
\item{at}{The number of progress units to show and capture the progress
bar at. If \code{NULL}, then a sequence of states is generated to show the
progress from beginning to end.}
\item{show_after}{Delay to show the progress bar. Overrides the
\code{cli.progress_show_after} option.}
\item{live}{Whether to show the progress bat on the screen, or just
return the recorded updates. Defaults to the value of the
\code{cli.progress_demo_live} options. If unset, then it is \code{TRUE} in
interactive sessions.}
\item{delay}{Delay between progress bar updates.}
\item{start}{Time to subtract from the start time, to simulate a
progress bar that takes longer to run.}
}
\value{
List with class \code{cli_progress_demo}, which has a print and a
format method for pretty printing. The \code{lines} entry contains the
output lines, each corresponding to one update.
}
\description{
Useful for experimenting with format strings and for documentation.
It creates a progress bar, iterates it until it terminates and saves the
progress updates.
}
cli/man/symbol.Rd 0000644 0001762 0000144 00000001243 14143453131 013367 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/symbol.R
\name{symbol}
\alias{symbol}
\alias{list_symbols}
\title{Various handy symbols to use in a command line UI}
\format{
A named list, see \code{names(symbol)} for all sign names.
}
\usage{
symbol
list_symbols()
}
\description{
Various handy symbols to use in a command line UI
}
\details{
On Windows they have a fallback to less fancy symbols.
\code{list_symbols()} prints a table with all symbols to the screen.
}
\examples{
cat(symbol$tick, " SUCCESS\n", symbol$cross, " FAILURE\n", sep = "")
## All symbols
cat(paste(format(names(symbol), width = 20),
unlist(symbol)), sep = "\n")
}
cli/man/cli_fmt.Rd 0000644 0001762 0000144 00000001325 14312603722 013501 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_fmt}
\alias{cli_fmt}
\title{Capture the output of cli functions instead of printing it}
\usage{
cli_fmt(expr, collapse = FALSE, strip_newline = FALSE)
}
\arguments{
\item{expr}{Expression to evaluate, containing \verb{cli_*()} calls,
typically.}
\item{collapse}{Whether to collapse the output into a single character
scalar, or return a character vector with one element for each line.}
\item{strip_newline}{Whether to strip the trailing newline.}
}
\description{
Capture the output of cli functions instead of printing it
}
\examples{
cli_fmt({
cli_alert_info("Loading data file")
cli_alert_success("Loaded data file")
})
}
cli/man/pretty_print_code.Rd 0000644 0001762 0000144 00000000767 14317007616 015637 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prettycode.R
\name{pretty_print_code}
\alias{pretty_print_code}
\title{Turn on pretty-printing functions at the R console}
\usage{
pretty_print_code()
}
\description{
Defines a print method for functions, in the current session, that supports
syntax highlighting.
}
\details{
The new print method takes priority over the built-in one. Use
\code{\link[base:message]{base::suppressMessages()}} to suppress the alert message.
}
cli/man/cli_div.Rd 0000644 0001762 0000144 00000004634 14332664317 013514 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cli.R
\name{cli_div}
\alias{cli_div}
\title{Generic CLI container}
\usage{
cli_div(
id = NULL,
class = NULL,
theme = NULL,
.auto_close = TRUE,
.envir = parent.frame()
)
}
\arguments{
\item{id}{Element id, a string. If \code{NULL}, then a new id is generated
and returned.}
\item{class}{Class name, sting. Can be used in themes.}
\item{theme}{A custom theme for the container. See \link{themes}.}
\item{.auto_close}{Whether to close the container, when the calling
function finishes (or \code{.envir} is removed, if specified).}
\item{.envir}{Environment to evaluate the glue expressions in. It is
also used to auto-close the container if \code{.auto_close} is \code{TRUE}.}
}
\value{
The id of the new container element, invisibly.
}
\description{
See \link{containers}. A \code{cli_div} container is special, because it may
add new themes, that are valid within the container.
}
\details{
\subsection{Custom themes}{
\if{html}{\out{}}\preformatted{d <- cli_div(theme = list(h1 = list(color = "cyan",
"font-weight" = "bold")))
cli_h1("Custom title")
cli_end(d)
}\if{html}{\out{
}}\if{html}{\out{
#>
#> Custom title
}}\preformatted{div <- function() \{
cli_div(class = "tmp", theme = list(.tmp = list(color = "yellow")))
cli_text("This is yellow")
\}
div()
cli_text("This is not yellow any more")
}\if{html}{\out{
}}\if{html}{\out{
#> This is yellow
#> This is not yellow any more
}}\preformatted{nbld <- 11
tbld <- prettyunits::pretty_sec(5.6)
cli_alert_success("Built \{.emph \{nbld\}\} status report\{?s\} in \{tbld\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ✔ Built 11 status reports in 5.6s.
}}\preformatted{cfl <- "~/.cache/files/latest.cache"
cli_alert_info("Updating cache file \{.path \{cfl\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ℹ Updating cache file ~/.cache/files/latest.cache.
}}\preformatted{cfl <- "~/.cache/files/latest.cache"
cli_alert_warning("Failed to update cache file \{.path \{cfl\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ! Failed to update cache file ~/.cache/files/latest.cache.
}}\preformatted{cfl <- "~/.config/report.yaml"
cli_alert_danger("Cannot validate config file at \{.path \{cfl\}\}.")
}\if{html}{\out{
}}\if{html}{\out{
#> ✖ Cannot validate config file at ~/.config/report.yaml.
}}\preformatted{cli_alert_info("Data columns: \{.val \{names(mtcars)\}\}.")
cli_alert_info("Data columns: \{.val \{names(mtcars)\}\}.", wrap = TRUE)
}\if{html}{\out{
}}\if{html}{\out{
#> ℹ Data columns: "mpg", "cyl", "disp", "hp", "drat", "wt", "qsec", "vs", "am", "g #> ear", and "carb". #> ℹ Data columns: "mpg", "cyl", "disp", "hp", "drat", "wt", "qsec", #> "vs", "am", "gear", and "carb".