cl_dl output is missing if string contains `#` or `'`

[fmichonneau]

library(cli)

cli_dl(
  c(
    "test_1" = "all good",
    "test_2" = "not #good"
  )
)
#> test_1: all good
#> test_2:

^{Created on 2021-11-02 by the reprex package (v2.0.1)}

[fmichonneau]

it looks like ' and " are also causing some trouble:

cli::cli_dl(c("test_3" = "no' good either"))
#> test_3:

cli::cli_dl(c("test_4" = "no\" good also"))
#> test_4:

[zkamvar]

This was an issue with {glue}: tidyverse/glue#193 and was fixed in the latest release, but now brings up a new problem:

cli::cli_text("{.url https://example.com/#section}")
#> Error in glue_data(.x = NULL, ..., .sep = .sep, .envir = .envir, .open = .open, : Unterminated comment

^{Created on 2021-11-10 by the reprex package (v2.0.1)}

[zkamvar]

This behavior is fixed if you put the strings as variables, however:

url <- "https://example.com/#section"
cli::cli_text("{.url {url}}")
#> <https://example.com/#section>

msg <- "no' good either"
cli::cli_dl(c("test_3" = "{msg}"))  
#> test_3: no' good either

^{Created on 2021-11-10 by the reprex package (v2.0.1)}

This is explicitly tested in

cli/tests/testthat/test-inline.R

Lines 50 to 56 in 1af3d91

	test_that("no glue substitution in expressions that evaluate to a string", {
	expect_snapshot(local({
	msg <- "Message with special characters like } { }} {{"
	cli_text("{msg}")
	cli_text("{.emph {msg}}")
	}))
	})

[jimhester]

I think probably cli should set comment = character() when calling glue to work around the # issue. For the unpaired quote issues I guess we would need to add an option to disable tracking of quotes when parsing.

[zkamvar]

It would certainly help when providing a Klingon translation to messages (in a romanized script):

cli::cli_alert_success("Qapla'")

[gaborcsardi]

This was fixed by 64a389e, but I messed up the issue number reference....

[gaborcsardi]

Unfortunately I'll have to re-open this temporarily because it breaks some revdeps, and there is no way to escape braces with .literal, it seems. So until we change that or come up with another solution, the quotes will not work, and you'll need to substitute them in. The comments will be fine, because glue has a separate argument for ignoring them.