format_inline() now keeps all whitespace as is by default

And has a new argument: `keep_whitespace` to choose the old
behavior.

Author: gaborcsardi

NEWS.md

@@ -11,8 +11,8 @@
   unconditionally, as before.) See the the `cli.progress_show_after`
   option in `?cli-config` for details (#542).
 
-* `format_inline()` now has a new argument `keep_newlines`, and it keeps
-  newline characters by default.
+* `format_inline()` now has a new argument `keep_whitespace`, and it keeps
+  whitespace, including newline and form feed characters by default.
 
 # cli 3.5.0
 

R/cli.R

@@ -102,24 +102,21 @@ cli_fmt <- function(expr, collapse = FALSE, strip_newline = FALSE) {
 #' @param .envir Environment to evaluate the expressions in.
 #' @param collapse Whether to collapse the result if it has multiple
 #'   lines, e.g. because of `\f` characters.
-#' @param keep_newlines Whether to keep newlines in the result, or treat
-#'   them as regular space characters.
+#' @param keep_whitespace Whether to keep all whitepace (spaces, newlines
+#'   and form feeds) as is in the input.
 #' @return Character scalar, the formatted string.
 #'
 #' @export
 #' @examples
 #' format_inline("A message for {.emph later}, thanks {.fn format_inline}.")
 
 format_inline <- function(..., .envir = parent.frame(), collapse = TRUE,
-                          keep_newlines = TRUE) {
-  str <- paste0(unlist(list(...), use.names = FALSE), collapse = "")
-  if (keep_newlines) {
-    str <- gsub("\n", "\f", str, fixed = TRUE)
-  }
+                          keep_whitespace = TRUE) {
   opts <- options(cli.width = Inf)
   on.exit(options(opts), add = TRUE)
+  fun <- if (keep_whitespace) cli_inline else cli_text
   cli_fmt(
-    cli_text(str, .envir = .envir),
+    fun(..., .envir = .envir),
     collapse = collapse,
     strip_newline = TRUE
   )
@@ -208,6 +205,15 @@ cli_text <- function(..., .envir = parent.frame()) {
   cli__message("text", list(text = glue_cmd(..., .envir = .envir, .call = sys.call())))
 }
 
+cli_inline <- function(..., .envir = parent.frame()) {
+  cli__message(
+    "inline_text",
+    list(
+      text = glue_cmd(..., .envir = .envir, .call = sys.call(), .trim = FALSE)
+    )
+  )
+}
+
 #' CLI verbatim text
 #'
 #' It is not wrapped, but printed as is. Long lines will overflow.

R/cliapp.R

@@ -40,6 +40,10 @@ cliapp <- function(theme = getOption("cli.theme"),
       clii_text(app, text),
 
     ## Text, not wrapped
+    inline_text = function(text)
+      clii_inline_text(app, text),
+
+    ## Text, not wrapped, verbatim
     verbatim = function(...)
       clii_verbatim(app, ...),
 
@@ -114,9 +118,9 @@ cliapp <- function(theme = getOption("cli.theme"),
     get_current_style = function()
       utils::tail(app$styles, 1)[[1]],
 
-    xtext = function(text = NULL, .list = NULL, indent = 0, padding = 0)
+    xtext = function(text = NULL, .list = NULL, indent = 0, padding = 0, wrap = TRUE)
       clii__xtext(app, text, .list = .list, indent = indent,
-                  padding = padding),
+                  padding = padding, wrap = wrap),
 
     vspace = function(n = 1)
       clii__vspace(app, n),
@@ -163,6 +167,10 @@ clii_text <- function(app, text) {
   app$xtext(text)
 }
 
+clii_inline_text <- function(app, text) {
+  app$xtext(text, wrap = FALSE)
+}
+
 clii_verbatim <- function(app, ..., .envir) {
   style <- app$get_current_style()
   text <- unlist(strsplit(unlist(list(...)), "\n", fixed = TRUE))

R/glue.R

@@ -11,7 +11,7 @@
 
 glue <- function(text, .envir = parent.frame(),
                  .transformer = identity_transformer,
-                 .open = "{", .close = "}", .cli = FALSE) {
+                 .open = "{", .close = "}", .cli = FALSE, .trim = TRUE) {
 
   text <- paste0(text, collapse = "")
 
@@ -23,7 +23,9 @@ glue <- function(text, .envir = parent.frame(),
     return(text)
   }
 
-  text <- trim(text)
+  if (.trim) {
+    text <- trim(text)
+  }
 
   f <- function(expr) {
     eval_func <- as.character(.transformer(expr, .envir) %||% character())

R/inline.R

@@ -231,7 +231,8 @@ clii__inline <- function(app, text, .list) {
       .envir = t$values,
       .transformer = inline_transformer,
       .open = paste0("<", t$values$marker),
-      .close = paste0(t$values$marker, ">")
+      .close = paste0(t$values$marker, ">"),
+      .trim = FALSE
     )
   })
   paste(out, collapse = "")
@@ -323,15 +324,16 @@ make_cmd_transformer <- function(values, .call = NULL) {
   }
 }
 
-glue_cmd <- function(..., .envir, .call = sys.call(-1)) {
+glue_cmd <- function(..., .envir, .call = sys.call(-1), .trim = TRUE) {
   str <- paste0(unlist(list(...), use.names = FALSE), collapse = "")
   values <- new.env(parent = emptyenv())
   transformer <- make_cmd_transformer(values, .call = .call)
   pstr <- glue(
     str,
     .envir = .envir,
     .transformer = transformer,
-    .cli = TRUE
+    .cli = TRUE,
+    .trim = .trim
   )
   glue_delay(
     str = post_process_plurals(pstr, values),

R/internals.R

@@ -3,7 +3,7 @@ call_if_fun <- function(x) {
   if (is.function(x)) x() else x
 }
 
-clii__xtext <- function(app, text, .list, indent, padding, ln = TRUE) {
+clii__xtext <- function(app, text, .list, indent, padding, ln = TRUE, wrap = TRUE) {
   style <- app$get_current_style()
   text <- app$inline(text, .list = .list)
   exdent <- style$`text-exdent` %||% 0L
@@ -17,11 +17,15 @@ clii__xtext <- function(app, text, .list, indent, padding, ln = TRUE) {
 
   if (!is.null(style$fmt)) text <- style$fmt(text)
 
-  text <- ansi_strwrap(
-    text,
-    exdent = exdent,
-    width = app$get_width(extra = padding)
-  )
+  if (wrap) {
+    text <- ansi_strwrap(
+      text,
+      exdent = exdent,
+      width = app$get_width(extra = padding)
+    )
+  } else {
+    text <- ansi_simplify(text)
+  }
 
   app$cat_ln(text, indent = indent, padding)
   invisible(app)

man/format_inline.Rd

@@ -401,38 +401,38 @@
 # format_inline and newlines
 
     Code
-      format_inline("foo\nbar", keep_newlines = TRUE)
+      format_inline("foo\nbar")
     Output
       [1] "foo\nbar"
     Code
-      format_inline("\nfoo\n\nbar\n", keep_newlines = TRUE)
+      format_inline("\nfoo\n\nbar\n")
     Output
       [1] "\nfoo\n\nbar\n"
     Code
-      format_inline("foo\fbar", keep_newlines = TRUE)
+      format_inline("foo\fbar")
     Output
-      [1] "foo\nbar"
+      [1] "foo\fbar"
     Code
-      format_inline("\ffoo\f\fbar\f", keep_newlines = TRUE)
+      format_inline("\ffoo\f\fbar\f")
     Output
-      [1] "\nfoo\n\nbar\n"
+      [1] "\ffoo\f\fbar\f"
 
 ---
 
     Code
-      format_inline("foo\nbar", keep_newlines = FALSE)
+      format_inline("foo\nbar", keep_whitespace = FALSE)
     Output
       [1] "foo bar"
     Code
-      format_inline("\nfoo\n\nbar\n", keep_newlines = FALSE)
+      format_inline("\nfoo\n\nbar\n", keep_whitespace = FALSE)
     Output
       [1] "foo\n\nbar"
     Code
-      format_inline("foo\fbar", keep_newlines = FALSE)
+      format_inline("foo\fbar", keep_whitespace = FALSE)
     Output
       [1] "foo\nbar"
     Code
-      format_inline("\ffoo\f\fbar\f", keep_newlines = FALSE)
+      format_inline("\ffoo\f\fbar\f", keep_whitespace = FALSE)
     Output
       [1] "\nfoo\n\nbar\n"
 

tests/testthat/_snaps/inline-2.md

@@ -184,15 +184,16 @@ test_that("various errors", {
 
 test_that("format_inline and newlines", {
   expect_snapshot({
-    format_inline("foo\nbar", keep_newlines = TRUE)
-    format_inline("\nfoo\n\nbar\n", keep_newlines = TRUE)
-    format_inline("foo\fbar", keep_newlines = TRUE)
-    format_inline("\ffoo\f\fbar\f", keep_newlines = TRUE)
+    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_newlines = FALSE)
-    format_inline("\nfoo\n\nbar\n", keep_newlines = FALSE)
-    format_inline("foo\fbar", keep_newlines = FALSE)
-    format_inline("\ffoo\f\fbar\f", keep_newlines = FALSE)
+    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)
   })
 })