Scalastyle config for "Scala Style Guide"

[evis]

It would be so nice to have scalastyle config for this guide. This way we could enforce these rules in Scala projects automatically.

[bzitzow]

+1

[SethTisue]

or Scalafmt

[jvican]

@evis mind sending a PR?

[SethTisue]

Perhaps Scalafmt's default configuration already is mostly consistent with the guide? And the same for Scalastyle? In other words, perhaps this is essentially already done...?

thinking out loud, but: I wonder if a way to improve the guide would be, in each section of the guide, add a sort of footnote or info box that says what from that section is currently enforced by scalastyle and/or scalafmt. or maybe that level of detail isn't necessary, I don't know.

in any case, it's not clear to me what is actually actionable on this ticket.

[evis]

mind sending a PR?

I thought about it, for sure. I tried to make scalastyle config for guide, but found a lot of guide conventions, which aren't covered by standard scalastyle rules. So, we need to implement these scalastyle rules. Or just make partial config, which doesn't cover all style conventions suggested by guide.

Perhaps Scalafmt's default configuration already is mostly consistent with the guide?

Not sure, will check it.

And the same for Scalastyle?

Definitely not, see above.

in each section of the guide, add a sort of footnote or info box that says what from that section is currently enforced by scalastyle and/or scalafmt. or maybe that level of detail isn't necessary, I don't know. in any case, it's not clear to me what is actually actionable on this ticket.

That level isn't really necessary imo. I'd like to just have link to scalastyle (scalafmt too?) config, which encorces style described in guide.

[evis]

One may check incomplete scalastyle config here: https://github.com/evis/scala-style-guide-enforce/blob/master/scalastyle_config.xml

There are still 29 TODOs, though, due to lack of corresponding scalastyle implemented rules... :(