Repository navigation
Include naming conventions #276
Description
Since I really like the idea of using one fixed and common set of rules defined by a dependency, esp. when developing spring based applications, I was wondering why naming checks are not included in the default checkstyle rule set. I know those are common sense, but esp. for new Java devs, maybe also coming from different languages like Python, it would be great to also enforce these rules:
<module name="ConstantName" />
<module name="CatchParameterName" />
<module name="ClassTypeParameterName" />
<module name="InterfaceTypeParameterName" />
<module name="LambdaParameterName" />
<module name="LocalVariableName" />
<module name="MemberName" />
<module name="MethodName" />
<module name="MethodTypeParameterName" />
<module name="RecordTypeParameterName" />
<module name="ParameterName" />
<module name="PackageName" />
<module name="TypeName" />
What do you think?
Activity
philwebb commentedon May 25, 2021
Most of these look sensible and I'd like to try them. We might need some tweaks to
*ParameterNamebecause we sometimes want to go beyond a single letter.I'm not sure that we can apply the
ConstantNamerule. I think the rule is wrong for a lot of Spring Code becausestaticfinalalone isn't enough to determine if something is a constant.For example, I consider
static final String[] NO_STRINGSto be a constant because it can't change.But,
static final Map<String, String> cacheisn't really a constant and shouldn't be written asCACHE.I'm also not sure about
CatchParameterName. We tend to useexfor all exceptions and throwables and we already haveSpringCatchCheckto enforce some rules.leikingo commentedon May 26, 2021
Interesting take on the
ConstantName. I always struggle to find the right balance there. Do you see astatic final Loggeras a constant? Maybe this rule can be restricted via type (primitives, arrays)? Or maybe I'm overthinking this and some things should be done in the review and cannot be enforced upfront.Regarding the
CatchParameterName, or the single letter in general. Till now, I often went with single letters likeeortbut again, maybe a good way to be more expressive there. Didn't notice theSpringCatchCheckbefore though. I'll consider to adapt to this pattern.philwebb commentedon May 26, 2021
We usually use
static final Logger loggerrather thanLOGGER.