styler icon indicating copy to clipboard operation
styler copied to clipboard

Mention `air` in README and clarify relation to `{styler}`?

Open IndrajeetPatil opened this issue 9 months ago • 2 comments
trafficstars

At some point, the issue is going to come up about the compatibility between the new R formatter from Posit and {styler}.

Maybe README should mention this tool and clarify their consilience or lack thereof (e.g. should users use both?, only use either of them?, etc.)?

IndrajeetPatil avatar Feb 18 '25 13:02 IndrajeetPatil

I am still trying to work out the differences between the two, but I don't think using both in the same repo makes sense. I suggested to Lionel and Davis that they could run air on styler's test suit to see how much overlap in formatting there is between {styler} and air, but I don't know if they are interested. This comparison could also be carried out by a third-party / in a different repo. For me, integration with third-party tooling is relevant, i.e. if I use pre-commit hooks for {styler}, I don't want to use air. Once we better understand air and how it's different from {styler}, I suggest to write a vignette on it. I don't know if we need to put it in the README. In the long run, I assume for new projects, people are going to use air, unless they depend on a feature air does not support. E.g. I don't know if air supports quarto documents, but it does not yet support pre-commit (but I offered to help with that, should be easy).

lorenzwalthert avatar Feb 18 '25 14:02 lorenzwalthert

If you are mentioning air why not tergo as well - github.com/kpagacz/tergo?

It's similar in design, slightly bit faster. Has an R package, a VSCode extension as well and is a project that started earlier than air. Less marketing for sure, but it doesn't have some kinks that air still has, eg.: https://github.com/posit-dev/air/issues/257 https://github.com/posit-dev/air/issues/234

kpagacz avatar Mar 01 '25 06:03 kpagacz