Merge pull request #561 from r-lib/fix/format-inline-keep-newline

Author: gaborcsardi

NEWS.md

@@ -11,6 +11,9 @@
   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.
+
 # cli 3.5.0
 
 * New `keypress()` function to read a single key press from a terminal.

R/cli.R

@@ -102,17 +102,24 @@ 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.
 #' @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) {
+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)
+  }
   opts <- options(cli.width = Inf)
   on.exit(options(opts), add = TRUE)
   cli_fmt(
-    cli_text(..., .envir = .envir),
+    cli_text(str, .envir = .envir),
     collapse = collapse,
     strip_newline = TRUE
   )

man/format_inline.Rd

@@ -398,3 +398,41 @@
       Caused by error:
       ! non-numeric argument to binary operator
 
+# format_inline and newlines
+
+    Code
+      format_inline("foo\nbar", keep_newlines = TRUE)
+    Output
+      [1] "foo\nbar"
+    Code
+      format_inline("\nfoo\n\nbar\n", keep_newlines = TRUE)
+    Output
+      [1] "\nfoo\n\nbar\n"
+    Code
+      format_inline("foo\fbar", keep_newlines = TRUE)
+    Output
+      [1] "foo\nbar"
+    Code
+      format_inline("\ffoo\f\fbar\f", keep_newlines = TRUE)
+    Output
+      [1] "\nfoo\n\nbar\n"
+
+---
+
+    Code
+      format_inline("foo\nbar", keep_newlines = FALSE)
+    Output
+      [1] "foo bar"
+    Code
+      format_inline("\nfoo\n\nbar\n", keep_newlines = FALSE)
+    Output
+      [1] "foo\n\nbar"
+    Code
+      format_inline("foo\fbar", keep_newlines = FALSE)
+    Output
+      [1] "foo\nbar"
+    Code
+      format_inline("\ffoo\f\fbar\f", keep_newlines = FALSE)
+    Output
+      [1] "\nfoo\n\nbar\n"
+

tests/testthat/_snaps/inline-2.md

@@ -181,3 +181,18 @@ test_that("various errors", {
     transform = function(x) sanitize_call(sanitize_srcref(x))
   )
 })
+
+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)
+  })
+  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)
+  })
+})