Other style guides

[krlmlr]

What would it take to support the following styles?

• @yihui's, e.g. in tinytex
  • e.g., use = for assignment, use ' for strings
• @wlandau's in drake
  • start argument list on the following line in a function declaration, no space between ) and {

I'm sure there's a related postponed issue, but I haven't looked.

Edit: This is now documented in a few vignettes and we have a GitHub template for custom style guides.

[lorenzwalthert]

I think there is no postponed issue with concrete plans on other style guides. However, I created a style guide that removes all comments in #334 (comment), and that was quick. So I think it's not a lot of work. For me, the question is also how we want to handle style guides other than the tidyverse style guide in general:

• Should third-party style guides (contributed by anyone) be implemented in styler or distributed via an another package we maintain (e.g. named styleguides) that collects style guides or should people write their own packages when they implement style guides? We could even put the tidyverse style guide into style_guides and make styler a pure infrastructure package.
• How can we ensure that contributed style guides are of high quality? Do we require third-party style guides to pass certain unit tests? Should the testing framework be used that was developed to unit test the tidyverse style guide? If other style guides are implemented in styler, I think we need to rethink the organisation of our unit tests.

I think these questions are important to make explicit decisions on as the number of third-party style guides may grow over time and a consistent strategy should be adopted. What's your @krlmlr take on that?

[krlmlr]

For these two I'd be fine if they lived in styler but were not exported for now. It feels like we need to play with a "proof of concept" first before thinking about organization. I'd let the handling of additional style guides be part of the upcoming GSoC project.

[lorenzwalthert]

In styler and not exported sounds good to me.

[lorenzwalthert]

Reference: The package oneliner implements a third-party style guide as a package and might help shaping a refined understanding of how we could organise and distribute new style guides.

[lorenzwalthert]

I am currently working on implementing a style guide for the mlr package within styler: mlr-org/mlr#2278

[riccardoporreca]

On the topic of supporting custom style guides, you might also want to consider the possibility of
selecting the style guide used by the RStudio addins.
I have actually an implementation of this as an additional "Set style" addin in fork miraisolutions/styler, which I have been using already to play with some style guide customization.
I did not open a dedicated issue / PR, but would be happy to do so.
Direct link to the diff.

[lorenzwalthert]

Thanks @riccardoporreca. I'll fork your fork (haha) and try it out when I get the chance. I first want to submit styler 1.02. to CRAN

[riccardoporreca]

Sure, go ahead with the styler %>% fork %>% fork when you get a chance.
Happy 1.0.2 release.

[lorenzwalthert]

Working on the mlr style guide. Reference: mlr-org/mlr#2278