protect literals from Air

[maelle]

No description provided.

[maelle]

cc @schochastics

[maelle]

posit-dev/air#273

[maelle]

I need to think about this a bit more. I don't want to clutter example code with exclusion comments.

[maelle]

(And I don't want to have to mess up with roxygen2 to clean Rd files from exclusion comments)

[schochastics]

Besides literals, are there other things that get messed up?

[DavisVaughan]

How does this skip feature feel? posit-dev/air#279 (still subject to change). Would it help you adopt Air?

[schochastics]

This looks amazing. I guess all we would need to do is add the toml file to the repository?

[DavisVaughan]

That's the idea yea, for example I forked and added an air.toml with this to the root of rigraph:

[format]
skip = ["graph_from_literal", "from_literal"]

and then ran air format . and I see diffs like this, notice how graph_from_literal() doesn't change but other things do (ok maybe that wasn't a great example b/c that graph_from_literal() would not have changed anyways, but that's the idea)

[schochastics]

Awesome, really appreciate the work on this!

[maelle]

wow, this is fantastic!

One thing that might be too niche, but I'm mentioning it in case that's a general use case, is that igraph would also benefitting from excluding a regex, namely make_graph(~ (other occurrences of make_graph() don't use literals) 🤪

[maelle]

Maybe that makes ~ the thing to skip though 🤔

[DavisVaughan]

Hmmmm, I think for the purposes of keeping this feature fairly simple but also extremely performant, we will need to limit it to exact matches. Right now we keep the list of skip functions in a sorted list and perform a binary search to see if we get any matches, which is extremely fast. I think switching to regex would be too slow and likely not justify the amount of actual use cases there are for it. Remember we'd have to run the regex check on every single function call in your document, which can be a lot!

[maelle]

Thanks, this makes sense!