At issue is that each Commons components has its own style and sometimes its own custom Checkstyle configuration in its own location. My preference is: - Store a default Checkstyle, SpotBugs, JApiCmp, and JaCoCo configuration in Commons Parent under src/site/resources - Avoid bikeshedding for what should be in these above files by picking Commons Lang's versions of these files. - Since Commons Collections does not define a Checkstyle, it can inherit it from Commons Parent - Other components can migrate to the Commons Parent configurations at a time of their own choosing. Gary
On Tue, Feb 18, 2020 at 1:43 PM Alex Herbert <alex.d.herb...@gmail.com> wrote: > There have been a few PRs recently in collections with simple formatting > errors. These should be picked up by checkstyle to prevent correction > after merge. > > The [collections] checkstyle configuration is old. If I replace it with > the Checkstyle version close to the Sun standard [1] then there are a > lot of errors (>3000). With a few rule changes to ignore items the > number of errors is down to about 2000. A lot of these are things that > should be corrected and would be good to have to filter PRs: > > JavadocMethod 188 > > JavadocStyle 517 > > JavadocType 186 > > JavadocVariable 177 > > WhitespaceAround 86 > > WhitespaceAfter 68 > > RedundantModifier 40 > > Indentation 177 > > Header 31 (for the Apache licence) > > I suggest updating the checkstyle config to at least catch these. I can > either use the config that flagged these errors and remove rules that > are not enforced or add these rules to the current config. > > I'm thinking a total refresh of the config and then removal of items > that are not to be enforced is the way to go. These can gradually be > reintroduced as the code gets fixed over time (because I don't think I > will be able to do it all any time soon). > > Any opinions on this effort? > > Alex > > [1] > > https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/sun_checks.xml > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > >
