usethis icon indicating copy to clipboard operation
usethis copied to clipboard

Rename `use_tidy_style()` to `use_styler()`

Open DavisVaughan opened this issue 8 months ago • 2 comments
trafficstars

Now that we have use_air() as well https://github.com/r-lib/usethis/pull/2109

Will probably require a little reorganizing of the file that use_tidy_style() lives in, and the pkgdown section it lives in

DavisVaughan avatar Mar 04 '25 15:03 DavisVaughan

Is this what we're thinking?

use_tidy_style() becomes basically a shell that does nothing but messages about current alternatives: use_air() and (a new function) use_styler(). use_styler() gets the existing use_tidy_style() logic.

jennybc avatar Mar 04 '25 16:03 jennybc

Or use_tidy_style() is removed entirely, I'm not sure, but what you suggest also sounds reasonable

DavisVaughan avatar Mar 04 '25 16:03 DavisVaughan

I decided to just deprecate use_tidy_style() in favor of recommending use_air() or direct calls to styler.

jennybc avatar Jul 10 '25 20:07 jennybc

@lorenzwalthert I just wanted to tag you here, to give a heads up that use_tidy_style() is likely being deprecated. From a GitHub search, I think the only impact on styler will be on documentation, i.e. on recommendations to call usethis::use_tidy_style(). I've opened a PR and thought you might want to keep 👀 on this issue.

jennybc avatar Jul 10 '25 21:07 jennybc

Thanks @jennybc, appreciated.

lorenzwalthert avatar Jul 13 '25 10:07 lorenzwalthert