Provide "quote" inline formatter

[hadley]

• When colour available, colours output, and sets background colour for leading or trailing spaces
• When colour not available, surrounds output in ".

Would want to be able to choose the quote marks and the colour.

[hadley]

https://googlesheets4.tidyverse.org/articles/articles/messages-and-errors.html#inline-styling-3

[jennybc]

It's also interesting to think about whether this should just be standard behaviour for some of the built-in inline styles (e.g. {.fun function_name}, {.file path/to/a/file}) or whether this "color plus no-color fallback" should just be a possible and suggested pattern for custom styles.

[hadley]

Should definitely be the case for paths, since trailing spaces are a definite real problem. Probably less so for function names.

[gaborcsardi]

It is already the standard behavior AFAICT:

❯ x <- " weird "; cli::cli_text("qwe {.path {x}} qwe")
qwe ' weird ' qwe

[jennybc]

Ah, so the quotes surrounding {.file} appear conditionally, if there is leading or trailing whitespace.

I tend to think we want the quotes unconditionally, at least in the NO_COLOR case.

I also have a specific scheme for inline style (color) and quoting that helps to make a very important distinction:

• A Google (spread)Sheet is styled as {.file} and, when NO_COLOR, should be double-quoted
• A (work)sheet is styled as {.field} and, when NO_COLOR, should be single-quoted

It is likely that I should create custom inline styles, give them good names, etc.

Although specific, I think my requirements are relevant to the more general question about the quoting behaviour of the inline formatters.

[gaborcsardi]

I don't think we would want to quote generic <span> tags, that's too aggressive. Quoting newly added tags is pretty easy:

cli_div(theme = list(.sheet = list(before = '"', after = '"')))
sh <- "sheet"
cli_alert_success("this is a {.sheet {sh}} here")

#> v this is a "sheet" here

sh <- "      weird sheet  "
cli_alert_success("this is a {.sheet {sh}} here")

#> v this is a "      weird sheet  " here

[hadley]

I kind of like the background colour idea for paths — it seems like a nice general solution.

[gaborcsardi]

@hadley would you set the background color for the whole path, or just for the leading/trailing spaces?

[hadley]

Just the leading/trailing spaces (to make it obvious that's there's something weird going on with your path).

[jennybc]

I'm still concerned that a file path has no inline styling in the NO_COLOR context (if it's free of leading/trailing whitespace). Indicated by the orange arrow below.

(And yes I'm still thinking about how I want to style spreadsheet and worksheet names, in terms of context.)

[gaborcsardi]

I'm still concerned that a file path has no inline styling in the NO_COLOR context (if it's free of leading/trailing whitespace). Indicated by the orange arrow below.

I think usually the text indicates that it is a file or package, etc. But I don't mind always adding the quotes, that's fine as well.

[gaborcsardi]

I'll re-open this to always add the quotes, and also to choose a better marker bg: set it to the same color as the foreground.

[jennybc]

always add the quotes

Do you mean always-always or ... always add quotes when NO_COLOR is non-zero?

I'm advocating for the latter, I think. I think I like the lack of quotes, when we have access to colour. But I could deal with always having quotes (that's what usethis currently does for some inline styles and it's fine).

[gaborcsardi]

Yeah, we can make it conditional on color support as well.