Checkstyle rules ready for implementation #7068
Description
Guideline
We have read through the list of check-style checks and found a set we would like to start with. Please feel free to create PRs with on or more rules in them, but:
- If a check touch more than 3 files, please make a separate PR with just one check in it - then it is much faster to review.
- All check witch is trivial and is already in place (not file modifications needed) can be included in one PR. Do as many as you like.
- If the check require configuration, test it and present it at a developer meeting.
- The "Maybe later" section list checks we will test out later or we suspect more work is needed upfront. If you want to use some of these, please present in a dev meeting first. We are likly to add these when we encounter a "problem" in a review. They are good ways of documenting what is expected.
- When you start implementing a check, select it. When the PR is ready, add a link to the PR behind.
Checks
We list rules here that can be added (mostly one-by-one) to our project:
- ArrayTrailingComma
- ArrayTypeStyle
- AvoidDoubleBraceInitialization
- AvoidNoArgumentSuperConstructorCall
- AvoidStarImport (Replace spotless with Checkstyle and OpenRewrite #6988)
- ClassMemberImpliedModifier
- ClassTypeParameterName
- ConstantName
- ConstructorsDeclarationGrouping
- DeclarationOrder
- DefaultComesLast
- EmptyStatement
- EqualsAvoidNull
- EqualsHashCode
- ExplicitInitialization
- FallThrough
- HexLiteralCase
- HiddenField
- HideUtilityClassConstructor
- InnerAssignment
- InnerTypeLast
- MagicNumber
- MissingDeprecated
- ModifierOrder
- MultipleStringLiterals
- MutableException
- NeedBraces (Add NeedBraces rule to Checkstyle and OpenRewrite #7059)
- NestedForDepth
- NestedIfDepth
- NestedTryDepth
- NoCodeInFile
- NonEmptyAtclauseDescription
- OneTopLevelClass
- OuterTypeFilename
- OverloadMethodsDeclarationOrder
- PackageDeclaration
- PackageName
- ParameterAssignment
- PatternVariableAssignment
- RedundantImport (Replace spotless with Checkstyle and OpenRewrite #6988)
- RequireEmptyLineBeforeBlockTagGroup
- SealedShouldHavePermitsList
- SimplifyBooleanReturn
- StringLiteralEquality
- TrailingComment (Add TrailingComment module to checkstyle #7138)
- UniqueProperties
- UnnecessaryNullCheckWithInstanceOf
- UnusedImports (Replace spotless with Checkstyle and OpenRewrite #6988)
- UnusedLocalVariable (Add Checkstyle and OpenRewrite rules to avoid unused local variables #7020)
- UpperEll
- WhenShouldBeUsed
Maybe later
- *Complexity
- DescendantToken
- DesignForExtension
- ExecutableStatementCount
- FileLength
- IllegalImport
- IllegalTokenText
- MissingJavadocMethod
- MissingJavadocType
- NoClone
- UnusedCatchParameterShouldBeUnnamed
- UnusedLambdaParameterShouldBeUnnamed
- VisibilityModifier
- AnonInnerLength
For Raptor and maybe A*:
Some checks might not be important to have on all code, but for AStar and Raptor checks witch might impact performance could be added.
- FinalClass