kemitix/kemitix-checkstyle-ruleset
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README.md: update to builder generated version

Browse source
This commit is contained in:
Paul Campbell 2017-01-05 23:43:53 +00:00
parent 1fa27f2071
commit 0dd1ec4990
1 changed files with 12 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -156,11 +156,9 @@ from the previous.
* [ForbidThrowAnonymousExceptions](#forbidthrowanonymousexceptions) - sevntu - disabled * [ForbidThrowAnonymousExceptions](#forbidthrowanonymousexceptions) - sevntu - disabled
* [ForbidWildcardAsReturnType](#forbidwildcardasreturntype) - sevntu - enabled * [ForbidWildcardAsReturnType](#forbidwildcardasreturntype) - sevntu - enabled
* [GenericWhitespace](#genericwhitespace) - checkstyle - enabled * [GenericWhitespace](#genericwhitespace) - checkstyle - enabled
* [Header](#header) - checkstyle - disabled * [Header](#header) - checkstyle - enabled
* [HiddenField](#hiddenfield) - checkstyle - enabled * [HiddenField](#hiddenfield) - checkstyle - enabled
* [HideUtilityClassConstructor](#hideutilityclassconstructor) - checkstyle - enabled * [HideUtilityClassConstructor](#hideutilityclassconstructor) - checkstyle - enabled
* [HideUtilityClassConstructor](#hideutilityclassconstructor-1) - sevntu - disabled
* [IllegalCatchExtended](#illegalcatchextended) - sevntu - disabled
* [IllegalCatch](#illegalcatch) - checkstyle - enabled * [IllegalCatch](#illegalcatch) - checkstyle - enabled
* [IllegalImport](#illegalimport) - checkstyle - enabled * [IllegalImport](#illegalimport) - checkstyle - enabled
* [IllegalInstantiation](#illegalinstantiation) - checkstyle - disabled * [IllegalInstantiation](#illegalinstantiation) - checkstyle - disabled
@ -172,11 +170,9 @@ from the previous.
* [ImportOrder](#importorder) - checkstyle - disabled * [ImportOrder](#importorder) - checkstyle - disabled
* [Indentation](#indentation) - checkstyle - disabled * [Indentation](#indentation) - checkstyle - disabled
* [InnerAssignment](#innerassignment) - checkstyle - enabled * [InnerAssignment](#innerassignment) - checkstyle - enabled
* [InnerClass](#innerclass) - sevntu - disabled
* [InnerTypeLast](#innertypelast) - checkstyle - enabled * [InnerTypeLast](#innertypelast) - checkstyle - enabled
* [InterfaceIsType](#interfaceistype) - checkstyle - enabled * [InterfaceIsType](#interfaceistype) - checkstyle - enabled
* [InterfaceTypeParameterName](#interfacetypeparametername) - checkstyle - enabled * [InterfaceTypeParameterName](#interfacetypeparametername) - checkstyle - enabled
* [InterfaceTypeParameterName](#interfacetypeparametername-1) - sevntu - disabled
* [JavadocMethod](#javadocmethod) - checkstyle - enabled * [JavadocMethod](#javadocmethod) - checkstyle - enabled
* [JavadocPackage](#javadocpackage) - checkstyle - enabled * [JavadocPackage](#javadocpackage) - checkstyle - enabled
* [JavadocParagraph](#javadocparagraph) - checkstyle - enabled * [JavadocParagraph](#javadocparagraph) - checkstyle - enabled
@ -186,7 +182,6 @@ from the previous.
* [JavadocVariable](#javadocvariable) - checkstyle - disabled * [JavadocVariable](#javadocvariable) - checkstyle - disabled
* [JavaNCSS](#javancss) - checkstyle - enabled * [JavaNCSS](#javancss) - checkstyle - enabled
* [LeftCurly](#leftcurly) - checkstyle - enabled * [LeftCurly](#leftcurly) - checkstyle - enabled
* [LineLengthExtended](#linelengthextended) - sevntu - disabled
* [LineLength](#linelength) - checkstyle - enabled * [LineLength](#linelength) - checkstyle - enabled
* [LocalFinalVariableName](#localfinalvariablename) - checkstyle - enabled * [LocalFinalVariableName](#localfinalvariablename) - checkstyle - enabled
* [LocalVariableName](#localvariablename) - checkstyle - enabled * [LocalVariableName](#localvariablename) - checkstyle - enabled
@ -206,9 +201,7 @@ from the previous.
* [ModifiedControlVariable](#modifiedcontrolvariable) - checkstyle - enabled * [ModifiedControlVariable](#modifiedcontrolvariable) - checkstyle - enabled
* [ModifierOrder](#modifierorder) - checkstyle - enabled * [ModifierOrder](#modifierorder) - checkstyle - enabled
* [MultipleStringLiterals](#multiplestringliterals) - checkstyle - enabled * [MultipleStringLiterals](#multiplestringliterals) - checkstyle - enabled
* [MultipleStringLiteralsExtended](#multiplestringliteralsextended) - sevntu - disabled
* [MultipleVariableDeclarations](#multiplevariabledeclarations) - checkstyle - enabled * [MultipleVariableDeclarations](#multiplevariabledeclarations) - checkstyle - enabled
* [MultipleVariableDeclarationsExtended](#multiplevariabledeclarationsextended) - sevntu - disabled
* [MutableException](#mutableexception) - checkstyle - enabled * [MutableException](#mutableexception) - checkstyle - enabled
* [NameConventionForJunit4TestClasses](#nameconventionforjunit4testclasses) - sevntu - enabled * [NameConventionForJunit4TestClasses](#nameconventionforjunit4testclasses) - sevntu - enabled
* [NeedBraces](#needbraces) - checkstyle - enabled * [NeedBraces](#needbraces) - checkstyle - enabled
@ -254,7 +247,6 @@ from the previous.
* [RequireThis](#requirethis) - checkstyle - enabled * [RequireThis](#requirethis) - checkstyle - enabled
* [ReturnBooleanFromTernary](#returnbooleanfromternary) - sevntu - enabled * [ReturnBooleanFromTernary](#returnbooleanfromternary) - sevntu - enabled
* [ReturnCount](#returncount) - checkstyle - enabled * [ReturnCount](#returncount) - checkstyle - enabled
* [ReturnCountExtended](#returncountextended) - sevntu - disabled
* [ReturnNullInsteadOfBoolean](#returnnullinsteadofboolean) - sevntu - enabled * [ReturnNullInsteadOfBoolean](#returnnullinsteadofboolean) - sevntu - enabled
* [RightCurly](#rightcurly) - checkstyle - enabled * [RightCurly](#rightcurly) - checkstyle - enabled
* [SeparatorWrap](#separatorwrap) - checkstyle - enabled * [SeparatorWrap](#separatorwrap) - checkstyle - enabled
@ -283,7 +275,6 @@ from the previous.
* [UniformEnumConstantName](#uniformenumconstantname) - sevntu - enabled * [UniformEnumConstantName](#uniformenumconstantname) - sevntu - enabled
* [UniqueProperties](#uniqueproperties) - checkstyle - enabled * [UniqueProperties](#uniqueproperties) - checkstyle - enabled
* [UnnecessaryParentheses](#unnecessaryparentheses) - checkstyle - enabled * [UnnecessaryParentheses](#unnecessaryparentheses) - checkstyle - enabled
* [UnnecessaryParenthesesExtended](#unnecessaryparenthesesextended) - sevntu - disabled
* [UnusedImports](#unusedimports) - checkstyle - enabled * [UnusedImports](#unusedimports) - checkstyle - enabled
* [UpperEll](#upperell) - checkstyle - enabled * [UpperEll](#upperell) - checkstyle - enabled
* [UselessSingleCatch](#uselesssinglecatch) - sevntu - enabled * [UselessSingleCatch](#uselesssinglecatch) - sevntu - enabled
@ -303,6 +294,7 @@ The following is a list of each of the checks and the expectations each has on y
Rules are listed in alphabetical order. Rules are listed in alphabetical order.
#### [AbbreviationAsWordInName](http://checkstyle.sourceforge.net/config_naming.html#AbbreviationAsWordInName) #### [AbbreviationAsWordInName](http://checkstyle.sourceforge.net/config_naming.html#AbbreviationAsWordInName)
Enforces proper `CamelCase` and avoids sequences of consecutive uppercase characters in identifiers. Does not apply to @Overridden methods. Enforces proper `CamelCase` and avoids sequences of consecutive uppercase characters in identifiers. Does not apply to @Overridden methods.
@ -2297,6 +2289,7 @@ Checks that tokens are surrounded by whitespace.
### Sevntu ### Sevntu
#### [AvoidConstantAsFirstOperandInCondition](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidConstantAsFirstOperandInConditionCheck.html) #### [AvoidConstantAsFirstOperandInCondition](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidConstantAsFirstOperandInConditionCheck.html)
Checks that condition expressions don't become less readable by attempting to use a constant on the left-hand-side of a comparison. Checks that condition expressions don't become less readable by attempting to use a constant on the left-hand-side of a comparison.
@ -2674,6 +2667,7 @@ Boolean isEnabled() {
return null; return null;
} }
```` ````
#### [SimpleAccessorNameNotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/SimpleAccessorNameNotationCheck.html) #### [SimpleAccessorNameNotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/SimpleAccessorNameNotationCheck.html)
Checks that setters and getters follow the normal setField(), getField() and isField() pattern, where 'Field' is the name of the field being accessed. Checks that setters and getters follow the normal setField(), getField() and isField() pattern, where 'Field' is the name of the field being accessed.
@ -2750,6 +2744,7 @@ These checks are not enabled. Notes are included for each explaining why.
### Checkstyle ### Checkstyle
#### [ArrayTrailingComma](http://checkstyle.sourceforge.net/config_coding.html#ArrayTrailingComma) #### [ArrayTrailingComma](http://checkstyle.sourceforge.net/config_coding.html#ArrayTrailingComma)
Couldn't get my IDE's (IntelliJ) code style to match. Couldn't get my IDE's (IntelliJ) code style to match.
@ -2758,8 +2753,6 @@ Couldn't get my IDE's (IntelliJ) code style to match.
Doesn't recognise Lombok's `val` as being `final`. Doesn't recognise Lombok's `val` as being `final`.
Checks that local variables are `final` if they are never modified after declaration.
#### [IllegalInstantiation](http://checkstyle.sourceforge.net/config_coding.html#IllegalInstantiation) #### [IllegalInstantiation](http://checkstyle.sourceforge.net/config_coding.html#IllegalInstantiation)
Not really suitable for a template ruleset as it requires an explicit list of classes to apply to. Not really suitable for a template ruleset as it requires an explicit list of classes to apply to.
@ -2808,8 +2801,6 @@ Already covered by the [OneTopLevelClass](#onetoplevelclass) check.
[UnusedImports](#unusedimports) performs all the same checks and more. [UnusedImports](#unusedimports) performs all the same checks and more.
Checks for redundant `import`s. Checks for duplicates, imports from the `java.lang` package or from the current package.
#### [Regexp](http://checkstyle.sourceforge.net/config_regexp.html#Regexp) #### [Regexp](http://checkstyle.sourceforge.net/config_regexp.html#Regexp)
Generic rule; doesn't embody a 'quality' check. Generic rule; doesn't embody a 'quality' check.
@ -2830,7 +2821,7 @@ Generic rule; doesn't embody a 'quality' check.
Generic rule; doesn't embody a 'quality' check. Generic rule; doesn't embody a 'quality' check.
#### [RegexpSingleline](http://checkstyle.sourceforge.net/config_regexp.html#c) #### [RegexpSinglelineJava](http://checkstyle.sourceforge.net/config_regexp.html#RegexpSinglelineJava)
Generic rule; doesn't embody a 'quality' check. Generic rule; doesn't embody a 'quality' check.
@ -2858,13 +2849,14 @@ Generic rule; doesn't embody a 'quality' check.
As the sevntu check are considered experimental not all those that are not enabled are listed here. Only where they are disabled due to a conflict with my 'style' or there is another irreconcilable difference that prevents them from being enabled, will they be documented to prevent repeated investigations. As the sevntu check are considered experimental not all those that are not enabled are listed here. Only where they are disabled due to a conflict with my 'style' or there is another irreconcilable difference that prevents them from being enabled, will they be documented to prevent repeated investigations.
#### [AvoidConditionInversion](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/AvoidConditionInversionCheck.html) #### [AvoidConditionInversion](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/AvoidConditionInversionCheck.html)
Should already be covered by [SimplifyBooleanExpression](simplifybooleanexpression). Should already be covered by [SimplifyBooleanExpression](simplifybooleanexpression).
#### [AvoidDefaultSerializableInInnerClasses](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.html) #### [AvoidDefaultSerializableInInnerClasses](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.html)
> TODO: enable TODO: enable
#### [AvoidModifiersForTypes](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidModifiersForTypesCheck.html) #### [AvoidModifiersForTypes](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidModifiersForTypesCheck.html)
@ -2884,11 +2876,11 @@ The [DeclarationOrder](#declarationorder) check already imposes an order for cla
#### [EmptyPublicCtorInClass](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/EmptyPublicCtorInClassCheck.html) #### [EmptyPublicCtorInClass](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/EmptyPublicCtorInClassCheck.html)
> TODO: enable TODO: enable
#### [FinalizeImplementation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html) #### [FinalizeImplementation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html)
> TODO: enable TODO: enable
#### [ForbidAnnotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.html) #### [ForbidAnnotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.html)
@ -2906,52 +2898,16 @@ Generic rule; doesn't embody a 'quality' check.
[IllegalThrows](#illegalthrows) performs a similar check. [IllegalThrows](#illegalthrows) performs a similar check.
#### [HideUtilityClassConstructor](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/HideUtilityClassConstructorCheck.html)
See [HideUtilityClassConstructor](#hideutilityclassconstructor).
#### [IllegalCatchExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/IllegalCatchExtendedCheck.html)
See [IllegalCatch](#illegalcatch).
#### [InnerClass](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/InnerClassCheck.html)
See [InnerTypeLast](#innertypelast).
#### [InterfaceTypeParameterName](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/naming/InterfaceTypeParameterNameCheck.html)
See [InterfaceTypeParameterName](#interfacetypeparametername).
#### [LineLengthExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/sizes/LineLengthExtendedCheck.html)
See [LineLength](#linelength)
#### [MultipleStringLiteralsExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/MultipleStringLiteralsExtendedCheck.html)
See [MultipleStringLiteralsExtended](#multiplestringliteralsextended).
#### [MultipleVariableDeclarationsExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/MultipleVariableDeclarationsExtendedCheck.html)
See [MultipleVariableDeclarations](#multiplevariabledeclarations).
#### [RequiredParameterForAnnotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/RequiredParameterForAnnotationCheck.html) #### [RequiredParameterForAnnotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/RequiredParameterForAnnotationCheck.html)
Generic rule; doesn't embody a 'quality' check. Generic rule; doesn't embody a 'quality' check.
#### [ReturnCountExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/ReturnCountExtendedCheck.html)
See [ReturnCount](#returncount).
#### [StaticMethodCandidate](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/StaticMethodCandidateCheck.html) #### [StaticMethodCandidate](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/StaticMethodCandidateCheck.html)
Can't handle private methods called by reflection, which may cause issues with Spring and other DI frameworks. Can't handle private methods called by reflection, which may cause issues with Spring and other DI frameworks.
#### [UnnecessaryParenthesesExtended](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/UnnecessaryParenthesesExtendedCheck.html)
See [UnnecessaryParentheses](#unnecessaryparentheses).
#### [WhitespaceBeforeArrayInitializer](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/WhitespaceBeforeArrayInitializerCheck.html) #### [WhitespaceBeforeArrayInitializer](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/WhitespaceBeforeArrayInitializerCheck.html)
> TODO: enable TODO: enable
[Effective Java]: http://amzn.to/2aSz6GE [Effective Java]: http://amzn.to/2aSz6GE