Repository navigation
Metaprogramming: extracting formatted objects #750
Description
Activity
I think the best would be to add an option or function to cli to do this.
OK, glad to know I'm not missing something.
Any initial thoughts on an API? something similar to the {glue} approach? I'm not all that familiar with {cli} internals.
cc @olivroy who has helped out with some related issues here.
I would add a
cli_extract_vars()(internal?) function.Looked at the implementation a little bit. AIUI, we'd want to use
all.vars()(orall.names()) onexprhere:Line 303 in b388132
I'm still not sure the right way to surface that.
I also see that all of the functions like
cli_abort()that support inline formatting are doing so through a call tocli::format_inline().WDYT about a new argument like
.record_names=FALSEto that function which would then alter howglue()is invoked?I also see that all of the functions like
cli_abort()that support inline formatting are doing so through a call tocli::format_inline().That would be very surprising to me. I would think almost none of them call
format_inline().In that case the workhorse is actually
glue_cmd(), which is currently private.Maybe that could be exported with the suggested
.record_namesoption instead?Another idea is an option to strip {cli}-specific markup instead, returning a string that could be passed directly to {glue} with the {cli} logic removed, I think that means returning
codein the above branch."{.arg x} has {length(x)} elements, but it should be {.emph {length(y)}} in {.pkg {.emph {pkg}}}" # --> "x has {length(x)} elements, but it should be {length(y)} in {pkg}"
To support interpreting {cli} calls in
lintr::object_usage_linter()& thereby prevent false positives related to "unused variables", we'd like to examine relevant calls & extracting out the used variables.r-lib/lintr#2252
We do something similar for {glue} already, but the language for {cli} is similar-but-much-richer, e.g. {glue} does not support
{.arg x}-style markup.For {glue}, we use the
.transformerargument to pull out all the names in{}execution regions insideglue()calls:https://github.com/r-lib/lintr/blob/07c55846c1189740b7ac7a83b4b53203e23940ca/R/shared_constants.R#L264-L272
Is there any equivalent for {cli}? I saw #152 but I don't think
cli_format_method()is quite suitable.To be a bit clearer, here's some sample input/output:
We might be able to do something where we regex our way through and delete the
{.markup ...}wrappers, but I think that's less than ideal.