Checkstyle

[brenuart]

Should we add some checks during the build to enforce some coding conventions?
I'm thinking about SPACES instead of TABS for instances... (because I'm pretty confident I will forget once again to configure my IDE accordingly)...

Something like maven-checkstyle-plugin with a very limited set of checks may be ?
Are you aware of any other tool ?

[philsttr]

Yeah, I'll work on that.

[brenuart]

Check this for a first quick setup: https://github.com/brenuart/logstash-logback-encoder/tree/checkstyle

[philsttr]

Fixed in bb42b6b

I'll convert this discussion to an issue after github re-enables that functionality. Converting between issues <-> discussions is currently disabled due to some bugs.

[philsttr]

Apparently github only supports moving issues -> discussion. Not from discussion -> issue.

[brenuart]

Made my first PR since long - first time I see the check style rules in action ;-)
A first comment about the RightCurly rule. This rule complains about the following code:

if (condition == true) {
   ... do something ...
}
else {
   ... do something else...
}

According to the rule this should be written as follows:

if (condition == true) {
   ... do something ...
} else {
   ... do something else...
}

Personally, I prefer the first option as it clearly separates the if and else blocks thanks to the extra (nearly) blank line.
Same for a catch block:

try {
   ... do something ...
}
catch(Exception e) {
  ... do something else ...
}
finally {
  ...
}

will be refused and should instead be written as follows:

try {
   ... do something ...
} catch(IOException e) {
  ... do something else ...
} finally {
 ...
}

Again, I prefer the first approach for the same reasons as above.

All of this is of course a matter of taste... but since the introduction of checkstyle is rather new, I was wondering if these rules were added "on purpose" or "by default". So my feedback...

[philsttr]

I created the rules to match the majority practice used in the existing codebase, so the entire codebase did not need to be reformatted. I know formatting is very opinionated, but I'd like to not reformat the existing code.

[brenuart]

Ok.. I'll get use to it. Just a matter of finding how to configuré Eclipse to help me with this.

[jug]

could also use .editorconfig to format the code already during editing for IDEs