README.md: replace rule index list with a table

This commit is contained in:
Paul Campbell 2017-01-06 13:23:03 +00:00
parent 349c995f66
commit f6ee87e6dc
2 changed files with 206 additions and 202 deletions

390
README.md
View file

@ -91,200 +91,202 @@ from the previous.
## All Checks ## All Checks
* [AbbreviationAsWordInName](#abbreviationaswordinname) - naming - checkstyle - enabled Rule|Level|Source|Enabled|Suppressable
* [AbstractClassName](#abstractclassname) - naming - checkstyle - enabled ----|-----|------|-------|------------
* [AnnotationLocation](#annotationlocation) - layout - checkstyle - enabled [AbbreviationAsWordInName](#abbreviationaswordinname)|naming|checkstyle|Yes|
* [AnnotationUseStyle](#annotationusestyle) - layout - checkstyle - enabled [AbstractClassName](#abstractclassname)|naming|checkstyle|Yes|
* [AnonInnerLength](#anoninnerlength) - complexity - checkstyle - enabled [AnnotationLocation](#annotationlocation)|layout|checkstyle|Yes|
* [ArrayTrailingComma](#arraytrailingcomma) - unspecified - checkstyle - disabled [AnnotationUseStyle](#annotationusestyle)|layout|checkstyle|Yes|
* [ArrayTypeStyle](#arraytypestyle) - layout - checkstyle - enabled [AnonInnerLength](#anoninnerlength)|complexity|checkstyle|Yes|
* [AtclauseOrder](#atclauseorder) - javadoc - checkstyle - enabled [ArrayTrailingComma](#arraytrailingcomma)|unspecified|checkstyle||
* [AvoidConditionInversion](#avoidconditioninversion) - complexity - sevntu - disabled [ArrayTypeStyle](#arraytypestyle)|layout|checkstyle|Yes|
* [AvoidConstantAsFirstOperandInCondition](#avoidconstantasfirstoperandincondition) - tweaks - sevntu - enabled [AtclauseOrder](#atclauseorder)|javadoc|checkstyle|Yes|
* [AvoidDefaultSerializableInInnerClasses](#avoiddefaultserializableininnerclasses) - complexity - sevntu - disabled [AvoidConditionInversion](#avoidconditioninversion)|complexity|sevntu||
* [AvoidEscapedUnicodeCharacters](#avoidescapedunicodecharacters) - tweaks - checkstyle - enabled [AvoidConstantAsFirstOperandInCondition](#avoidconstantasfirstoperandincondition)|tweaks|sevntu|Yes|
* [AvoidHidingCauseException](#avoidhidingcauseexception) - tweaks - sevntu - enabled [AvoidDefaultSerializableInInnerClasses](#avoiddefaultserializableininnerclasses)|complexity|sevntu||
* [AvoidInlineConditionals](#avoidinlineconditionals) - complexity - checkstyle - enabled [AvoidEscapedUnicodeCharacters](#avoidescapedunicodecharacters)|tweaks|checkstyle|Yes|
* [AvoidModifiersForTypes](#avoidmodifiersfortypes) - unspecified - sevntu - disabled [AvoidHidingCauseException](#avoidhidingcauseexception)|tweaks|sevntu|Yes|
* [AvoidNestedBlocks](#avoidnestedblocks) - complexity - checkstyle - enabled [AvoidInlineConditionals](#avoidinlineconditionals)|complexity|checkstyle|Yes|
* [AvoidNotShortCircuitOperatorsForBoolean](#avoidnotshortcircuitoperatorsforboolean) - tweaks - sevntu - enabled [AvoidModifiersForTypes](#avoidmodifiersfortypes)|unspecified|sevntu||
* [AvoidStarImport](#avoidstarimport) - layout - checkstyle - enabled [AvoidNestedBlocks](#avoidnestedblocks)|complexity|checkstyle|Yes|
* [AvoidStaticImport](#avoidstaticimport) - complexity - checkstyle - enabled [AvoidNotShortCircuitOperatorsForBoolean](#avoidnotshortcircuitoperatorsforboolean)|tweaks|sevntu|Yes|
* [BooleanExpressionComplexity](#booleanexpressioncomplexity) - complexity - checkstyle - enabled [AvoidStarImport](#avoidstarimport)|layout|checkstyle|Yes|
* [CatchParameterName](#catchparametername) - naming - checkstyle - enabled [AvoidStaticImport](#avoidstaticimport)|complexity|checkstyle|Yes|
* [CauseParameterInException](#causeparameterinexception) - tweaks - sevntu - disabled [BooleanExpressionComplexity](#booleanexpressioncomplexity)|complexity|checkstyle|Yes|
* [ChildBlockLength](#childblocklength) - complexity - sevntu - disabled [CatchParameterName](#catchparametername)|naming|checkstyle|Yes|
* [ClassDataAbstractionCoupling](#classdataabstractioncoupling) - complexity - checkstyle - enabled [CauseParameterInException](#causeparameterinexception)|tweaks|sevntu||
* [ClassFanOutComplexity](#classfanoutcomplexity) - complexity - checkstyle - enabled [ChildBlockLength](#childblocklength)|complexity|sevntu||
* [ClassTypeParameterName](#classtypeparametername) - naming - checkstyle - enabled [ClassDataAbstractionCoupling](#classdataabstractioncoupling)|complexity|checkstyle|Yes|
* [CommentsIndentation](#commentsindentation) - layout - checkstyle - enabled [ClassFanOutComplexity](#classfanoutcomplexity)|complexity|checkstyle|Yes|
* [ConfusingCondition](#confusingcondition) - complexity - sevntu - enabled [ClassTypeParameterName](#classtypeparametername)|naming|checkstyle|Yes|
* [ConstantName](#constantname) - naming - checkstyle - enabled - insuppressible [CommentsIndentation](#commentsindentation)|layout|checkstyle|Yes|
* [ConstructorWithoutParams](#constructorwithoutparams) - complexity - sevntu - enabled [ConfusingCondition](#confusingcondition)|complexity|sevntu|Yes|
* [CovariantEquals](#covariantequals) - complexity - checkstyle - enabled - insuppressible [ConstantName](#constantname)|naming|checkstyle|Yes|No
* [CustomDeclarationOrder](#customdeclarationorder) - layout - sevntu - disabled [ConstructorWithoutParams](#constructorwithoutparams)|complexity|sevntu|Yes|
* [CyclomaticComplexity](#cyclomaticcomplexity) - complexity - checkstyle - enabled [CovariantEquals](#covariantequals)|complexity|checkstyle|Yes|No
* [DeclarationOrder](#declarationorder) - layout - checkstyle - enabled [CustomDeclarationOrder](#customdeclarationorder)|layout|sevntu||
* [DefaultComesLast](#defaultcomeslast) - tweaks - checkstyle - enabled [CyclomaticComplexity](#cyclomaticcomplexity)|complexity|checkstyle|Yes|
* [DesignForExtension](#designforextension) - complexity - checkstyle - enabled [DeclarationOrder](#declarationorder)|layout|checkstyle|Yes|
* [DiamondOperatorForVariableDefinition](#diamondoperatorforvariabledefinition) - tweaks - sevntu - enabled [DefaultComesLast](#defaultcomeslast)|tweaks|checkstyle|Yes|
* [EitherLogOrThrow](#eitherlogorthrow) - tweaks - sevntu - enabled [DesignForExtension](#designforextension)|complexity|checkstyle|Yes|
* [EmptyBlock](#emptyblock) - tweaks - checkstyle - enabled [DiamondOperatorForVariableDefinition](#diamondoperatorforvariabledefinition)|tweaks|sevntu|Yes|
* [EmptyCatchBlock](#emptycatchblock) - tweaks - checkstyle - enabled [EitherLogOrThrow](#eitherlogorthrow)|tweaks|sevntu|Yes|
* [EmptyForInitializerPad](#emptyforinitializerpad) - layout - checkstyle - enabled [EmptyBlock](#emptyblock)|tweaks|checkstyle|Yes|
* [EmptyForIteratorPad](#emptyforiteratorpad) - layout - checkstyle - enabled [EmptyCatchBlock](#emptycatchblock)|tweaks|checkstyle|Yes|
* [EmptyLineSeparator](#emptylineseparator) - layout - checkstyle - enabled [EmptyForInitializerPad](#emptyforinitializerpad)|layout|checkstyle|Yes|
* [EmptyPublicCtorInClass](#emptypublicctorinclass) - tweaks - sevntu - disabled [EmptyForIteratorPad](#emptyforiteratorpad)|layout|checkstyle|Yes|
* [EmptyStatement](#emptystatement) - layout - checkstyle - enabled [EmptyLineSeparator](#emptylineseparator)|layout|checkstyle|Yes|
* [EnumValueName](#enumvaluename) - naming - sevntu - enabled [EmptyPublicCtorInClass](#emptypublicctorinclass)|tweaks|sevntu||
* [EqualsAvoidNull](#equalsavoidnull) - tweaks - checkstyle - enabled [EmptyStatement](#emptystatement)|layout|checkstyle|Yes|
* [EqualsHashCode](#equalshashcode) - complexity - checkstyle - enabled - insuppressible [EnumValueName](#enumvaluename)|naming|sevntu|Yes|
* [ExecutableStatementCount](#executablestatementcount) - complexity - checkstyle - enabled [EqualsAvoidNull](#equalsavoidnull)|tweaks|checkstyle|Yes|
* [ExplicitInitialization](#explicitinitialization) - tweaks - checkstyle - enabled [EqualsHashCode](#equalshashcode)|complexity|checkstyle|Yes|No
* [FallThrough](#fallthrough) - javadoc - checkstyle - enabled [ExecutableStatementCount](#executablestatementcount)|complexity|checkstyle|Yes|
* [FileLength](#filelength) - complexity - checkstyle - enabled [ExplicitInitialization](#explicitinitialization)|tweaks|checkstyle|Yes|
* [FileTabCharacter](#filetabcharacter) - layout - checkstyle - enabled [FallThrough](#fallthrough)|javadoc|checkstyle|Yes|
* [FinalClass](#finalclass) - complexity - checkstyle - enabled [FileLength](#filelength)|complexity|checkstyle|Yes|
* [FinalizeImplementation](#finalizeimplementation) - unspecified - sevntu - disabled [FileTabCharacter](#filetabcharacter)|layout|checkstyle|Yes|
* [FinalLocalVariable](#finallocalvariable) - unspecified - checkstyle - disabled [FinalClass](#finalclass)|complexity|checkstyle|Yes|
* [FinalParameters](#finalparameters) - tweaks - checkstyle - enabled [FinalizeImplementation](#finalizeimplementation)|unspecified|sevntu||
* [ForbidAnnotation](#forbidannotation) - unspecified - sevntu - disabled [FinalLocalVariable](#finallocalvariable)|unspecified|checkstyle||
* [ForbidCCommentsInMethods](#forbidccommentsinmethods) - layout - sevntu - enabled [FinalParameters](#finalparameters)|tweaks|checkstyle|Yes|
* [ForbidCertainImports](#forbidcertainimports) - unspecified - sevntu - disabled [ForbidAnnotation](#forbidannotation)|unspecified|sevntu||
* [ForbidInstantiation](#forbidinstantiation) - unspecified - sevntu - disabled [ForbidCCommentsInMethods](#forbidccommentsinmethods)|layout|sevntu|Yes|
* [ForbidReturnInFinallyBlock](#forbidreturninfinallyblock) - complexity - sevntu - enabled [ForbidCertainImports](#forbidcertainimports)|unspecified|sevntu||
* [ForbidThrowAnonymousExceptions](#forbidthrowanonymousexceptions) - tweaks - sevntu - disabled [ForbidInstantiation](#forbidinstantiation)|unspecified|sevntu||
* [ForbidWildcardAsReturnType](#forbidwildcardasreturntype) - complexity - sevntu - enabled [ForbidReturnInFinallyBlock](#forbidreturninfinallyblock)|complexity|sevntu|Yes|
* [GenericWhitespace](#genericwhitespace) - layout - checkstyle - enabled [ForbidThrowAnonymousExceptions](#forbidthrowanonymousexceptions)|tweaks|sevntu||
* [Header](#header) - layout - checkstyle - enabled [ForbidWildcardAsReturnType](#forbidwildcardasreturntype)|complexity|sevntu|Yes|
* [HiddenField](#hiddenfield) - tweaks - checkstyle - enabled [GenericWhitespace](#genericwhitespace)|layout|checkstyle|Yes|
* [HideUtilityClassConstructor](#hideutilityclassconstructor) - tweaks - checkstyle - enabled [Header](#header)|layout|checkstyle|Yes|
* [IllegalCatch](#illegalcatch) - tweaks - checkstyle - enabled [HiddenField](#hiddenfield)|tweaks|checkstyle|Yes|
* [IllegalImport](#illegalimport) - tweaks - checkstyle - enabled [HideUtilityClassConstructor](#hideutilityclassconstructor)|tweaks|checkstyle|Yes|
* [IllegalInstantiation](#illegalinstantiation) - unspecified - checkstyle - disabled [IllegalCatch](#illegalcatch)|tweaks|checkstyle|Yes|
* [IllegalThrows](#illegalthrows) - tweaks - checkstyle - enabled [IllegalImport](#illegalimport)|tweaks|checkstyle|Yes|
* [IllegalToken](#illegaltoken) - tweaks - checkstyle - enabled [IllegalInstantiation](#illegalinstantiation)|unspecified|checkstyle||
* [IllegalTokenText](#illegaltokentext) - unspecified - checkstyle - disabled [IllegalThrows](#illegalthrows)|tweaks|checkstyle|Yes|
* [IllegalType](#illegaltype) - tweaks - checkstyle - enabled [IllegalToken](#illegaltoken)|tweaks|checkstyle|Yes|
* [ImportControl](#importcontrol) - unspecified - checkstyle - disabled [IllegalTokenText](#illegaltokentext)|unspecified|checkstyle||
* [ImportOrder](#importorder) - layout - checkstyle - disabled [IllegalType](#illegaltype)|tweaks|checkstyle|Yes|
* [Indentation](#indentation) - layout - checkstyle - disabled [ImportControl](#importcontrol)|unspecified|checkstyle||
* [InnerAssignment](#innerassignment) - tweaks - checkstyle - enabled [ImportOrder](#importorder)|layout|checkstyle||
* [InnerTypeLast](#innertypelast) - tweaks - checkstyle - enabled [Indentation](#indentation)|layout|checkstyle||
* [InterfaceIsType](#interfaceistype) - complexity - checkstyle - enabled [InnerAssignment](#innerassignment)|tweaks|checkstyle|Yes|
* [InterfaceTypeParameterName](#interfacetypeparametername) - naming - checkstyle - enabled [InnerTypeLast](#innertypelast)|tweaks|checkstyle|Yes|
* [JavadocMethod](#javadocmethod) - javadoc - checkstyle - enabled [InterfaceIsType](#interfaceistype)|complexity|checkstyle|Yes|
* [JavadocPackage](#javadocpackage) - javadoc - checkstyle - enabled [InterfaceTypeParameterName](#interfacetypeparametername)|naming|checkstyle|Yes|
* [JavadocParagraph](#javadocparagraph) - javadoc - checkstyle - enabled [JavadocMethod](#javadocmethod)|javadoc|checkstyle|Yes|
* [JavadocStyle](#javadocstyle) - javadoc - checkstyle - enabled [JavadocPackage](#javadocpackage)|javadoc|checkstyle|Yes|
* [JavadocTagContinuationIndentation](#javadoctagcontinuationindentation) - layout - checkstyle - disabled [JavadocParagraph](#javadocparagraph)|javadoc|checkstyle|Yes|
* [JavadocType](#javadoctype) - javadoc - checkstyle - enabled [JavadocStyle](#javadocstyle)|javadoc|checkstyle|Yes|
* [JavadocVariable](#javadocvariable) - javadoc - checkstyle - disabled [JavadocTagContinuationIndentation](#javadoctagcontinuationindentation)|layout|checkstyle||
* [JavaNCSS](#javancss) - complexity - checkstyle - enabled [JavadocType](#javadoctype)|javadoc|checkstyle|Yes|
* [LeftCurly](#leftcurly) - layout - checkstyle - enabled [JavadocVariable](#javadocvariable)|javadoc|checkstyle||
* [LineLength](#linelength) - layout - checkstyle - enabled [JavaNCSS](#javancss)|complexity|checkstyle|Yes|
* [LocalFinalVariableName](#localfinalvariablename) - naming - checkstyle - enabled [LeftCurly](#leftcurly)|layout|checkstyle|Yes|
* [LocalVariableName](#localvariablename) - naming - checkstyle - enabled [LineLength](#linelength)|layout|checkstyle|Yes|
* [LogicConditionNeedOptimization](#logicconditionneedoptimization) - tweaks - sevntu - enabled [LocalFinalVariableName](#localfinalvariablename)|naming|checkstyle|Yes|
* [MagicNumber](#magicnumber) - naming - checkstyle - enabled [LocalVariableName](#localvariablename)|naming|checkstyle|Yes|
* [MapIterationInForEachLoop](#mapiterationinforeachloop) - complexity - sevntu - enabled [LogicConditionNeedOptimization](#logicconditionneedoptimization)|tweaks|sevntu|Yes|
* [MemberName](#membername) - naming - checkstyle - enabled [MagicNumber](#magicnumber)|naming|checkstyle|Yes|
* [MethodCount](#methodcount) - complexity - checkstyle - enabled [MapIterationInForEachLoop](#mapiterationinforeachloop)|complexity|sevntu|Yes|
* [MethodLength](#methodlength) - complexity - checkstyle - enabled [MemberName](#membername)|naming|checkstyle|Yes|
* [MethodName](#methodname) - naming - checkstyle - enabled [MethodCount](#methodcount)|complexity|checkstyle|Yes|
* [MethodParamPad](#methodparampad) - layout - checkstyle - enabled [MethodLength](#methodlength)|complexity|checkstyle|Yes|
* [MethodTypeParameterName](#methodtypeparametername) - naming - checkstyle - enabled [MethodName](#methodname)|naming|checkstyle|Yes|
* [MissingCtor](#missingctor) - tweaks - checkstyle - disabled [MethodParamPad](#methodparampad)|layout|checkstyle|Yes|
* [MissingDeprecated](#missingdeprecated) - javadoc - checkstyle - enabled [MethodTypeParameterName](#methodtypeparametername)|naming|checkstyle|Yes|
* [MissingOverride](#missingoverride) - tweaks - checkstyle - disabled [MissingCtor](#missingctor)|tweaks|checkstyle||
* [MissingSwitchDefault](#missingswitchdefault) - tweaks - checkstyle - enabled [MissingDeprecated](#missingdeprecated)|javadoc|checkstyle|Yes|
* [ModifiedControlVariable](#modifiedcontrolvariable) - tweaks - checkstyle - enabled [MissingOverride](#missingoverride)|tweaks|checkstyle||
* [ModifierOrder](#modifierorder) - naming - checkstyle - enabled [MissingSwitchDefault](#missingswitchdefault)|tweaks|checkstyle|Yes|
* [MultipleStringLiterals](#multiplestringliterals) - naming - checkstyle - enabled [ModifiedControlVariable](#modifiedcontrolvariable)|tweaks|checkstyle|Yes|
* [MultipleVariableDeclarations](#multiplevariabledeclarations) - naming - checkstyle - enabled [ModifierOrder](#modifierorder)|naming|checkstyle|Yes|
* [MutableException](#mutableexception) - tweaks - checkstyle - enabled [MultipleStringLiterals](#multiplestringliterals)|naming|checkstyle|Yes|
* [NameConventionForJunit4TestClasses](#nameconventionforjunit4testclasses) - naming - sevntu - enabled [MultipleVariableDeclarations](#multiplevariabledeclarations)|naming|checkstyle|Yes|
* [NeedBraces](#needbraces) - naming - checkstyle - enabled [MutableException](#mutableexception)|tweaks|checkstyle|Yes|
* [NestedForDepth](#nestedfordepth) - complexity - checkstyle - enabled [NameConventionForJunit4TestClasses](#nameconventionforjunit4testclasses)|naming|sevntu|Yes|
* [NestedIfDepth](#nestedifdepth) - complexity - checkstyle - enabled [NeedBraces](#needbraces)|naming|checkstyle|Yes|
* [NestedSwitch](#nestedswitch) - complexity - sevntu - enabled [NestedForDepth](#nestedfordepth)|complexity|checkstyle|Yes|
* [NestedTryDepth](#nestedtrydepth) - complexity - checkstyle - enabled [NestedIfDepth](#nestedifdepth)|complexity|checkstyle|Yes|
* [NewlineAtEndOfFile](#newlineatendoffile) - layout - checkstyle - enabled [NestedSwitch](#nestedswitch)|complexity|sevntu|Yes|
* [NoClone](#noclone) - tweaks - checkstyle - enabled - insuppressible [NestedTryDepth](#nestedtrydepth)|complexity|checkstyle|Yes|
* [NoFinalizer](#nofinalizer) - tweaks - checkstyle - enabled [NewlineAtEndOfFile](#newlineatendoffile)|layout|checkstyle|Yes|
* [NoLineWrap](#nolinewrap) - layout - checkstyle - enabled [NoClone](#noclone)|tweaks|checkstyle|Yes|No
* [NoMainMethodInAbstractClass](#nomainmethodinabstractclass) - tweaks - sevntu - enabled [NoFinalizer](#nofinalizer)|tweaks|checkstyle|Yes|
* [NonEmptyAtclauseDescription](#nonemptyatclausedescription) - javadoc - checkstyle - enabled [NoLineWrap](#nolinewrap)|layout|checkstyle|Yes|
* [NoWhitespaceAfter](#nowhitespaceafter) - layout - checkstyle - enabled [NoMainMethodInAbstractClass](#nomainmethodinabstractclass)|tweaks|sevntu|Yes|
* [NoWhitespaceBefore](#nowhitespacebefore) - layout - checkstyle - enabled [NonEmptyAtclauseDescription](#nonemptyatclausedescription)|javadoc|checkstyle|Yes|
* [NPathComplexity](#npathcomplexity) - complexity - checkstyle - enabled [NoWhitespaceAfter](#nowhitespaceafter)|layout|checkstyle|Yes|
* [NumericLiteralNeedsUnderscore](#numericliteralneedsunderscore) - naming - sevntu - enabled [NoWhitespaceBefore](#nowhitespacebefore)|layout|checkstyle|Yes|
* [OneStatementPerLine](#onestatementperline) - layout - checkstyle - enabled [NPathComplexity](#npathcomplexity)|complexity|checkstyle|Yes|
* [OneTopLevelClass](#onetoplevelclass) - tweaks - checkstyle - enabled - insuppressible [NumericLiteralNeedsUnderscore](#numericliteralneedsunderscore)|naming|sevntu|Yes|
* [OperatorWrap](#operatorwrap) - layout - checkstyle - enabled [OneStatementPerLine](#onestatementperline)|layout|checkstyle|Yes|
* [OuterTypeFilename](#outertypefilename) - tweaks - checkstyle - enabled - insuppressible [OneTopLevelClass](#onetoplevelclass)|tweaks|checkstyle|Yes|No
* [OuterTypeNumber](#outertypenumber) - tweaks - checkstyle - disabled [OperatorWrap](#operatorwrap)|layout|checkstyle|Yes|
* [OverloadMethodsDeclarationOrder](#overloadmethodsdeclarationorder) - layout - checkstyle - enabled [OuterTypeFilename](#outertypefilename)|tweaks|checkstyle|Yes|No
* [OverridableMethodInConstructor](#overridablemethodinconstructor) - tweaks - sevntu - enabled [OuterTypeNumber](#outertypenumber)|tweaks|checkstyle||
* [PackageAnnotation](#packageannotation) - tweaks - checkstyle - enabled [OverloadMethodsDeclarationOrder](#overloadmethodsdeclarationorder)|layout|checkstyle|Yes|
* [PackageDeclaration](#packagedeclaration) - javadoc - checkstyle - enabled - insuppressible [OverridableMethodInConstructor](#overridablemethodinconstructor)|tweaks|sevntu|Yes|
* [PackageName](#packagename) - naming - checkstyle - enabled [PackageAnnotation](#packageannotation)|tweaks|checkstyle|Yes|
* [ParameterAssignment](#parameterassignment) - tweaks - checkstyle - disabled [PackageDeclaration](#packagedeclaration)|javadoc|checkstyle|Yes|No
* [ParameterName](#parametername) - naming - checkstyle - enabled [PackageName](#packagename)|naming|checkstyle|Yes|
* [ParameterNumber](#parameternumber) - complexity - checkstyle - enabled [ParameterAssignment](#parameterassignment)|tweaks|checkstyle||
* [ParenPad](#parenpad) - layout - checkstyle - enabled [ParameterName](#parametername)|naming|checkstyle|Yes|
* [PublicReferenceToPrivateType](#publicreferencetoprivatetype) - tweaks - sevntu - enabled [ParameterNumber](#parameternumber)|complexity|checkstyle|Yes|
* [RedundantImport](#redundantimport) - layout - checkstyle - disabled [ParenPad](#parenpad)|layout|checkstyle|Yes|
* [RedundantModifier](#redundantmodifier) - tweaks - checkstyle - enabled [PublicReferenceToPrivateType](#publicreferencetoprivatetype)|tweaks|sevntu|Yes|
* [RedundantReturn](#redundantreturn) - tweaks - sevntu - enabled [RedundantImport](#redundantimport)|layout|checkstyle||
* [Regexp](#regexp) - unspecified - checkstyle - disabled [RedundantModifier](#redundantmodifier)|tweaks|checkstyle|Yes|
* [RegexpHeader](#regexpheader) - unspecified - checkstyle - disabled [RedundantReturn](#redundantreturn)|tweaks|sevntu|Yes|
* [RegexpMultiline](#regexpmultiline) - unspecified - checkstyle - disabled [Regexp](#regexp)|unspecified|checkstyle||
* [RegexpOnFilename](#regexponfilename) - unspecified - checkstyle - disabled [RegexpHeader](#regexpheader)|unspecified|checkstyle||
* [RegexpSingleline](#regexpsingleline) - unspecified - checkstyle - disabled [RegexpMultiline](#regexpmultiline)|unspecified|checkstyle||
* [RegexpSinglelineJava](#regexpsinglelinejava) - unspecified - checkstyle - disabled [RegexpOnFilename](#regexponfilename)|unspecified|checkstyle||
* [RequiredParameterForAnnotation](#requiredparameterforannotation) - unspecified - sevntu - disabled [RegexpSingleline](#regexpsingleline)|unspecified|checkstyle||
* [RequireThis](#requirethis) - tweaks - checkstyle - enabled [RegexpSinglelineJava](#regexpsinglelinejava)|unspecified|checkstyle||
* [ReturnBooleanFromTernary](#returnbooleanfromternary) - tweaks - sevntu - enabled [RequiredParameterForAnnotation](#requiredparameterforannotation)|unspecified|sevntu||
* [ReturnCount](#returncount) - complexity - checkstyle - enabled [RequireThis](#requirethis)|tweaks|checkstyle|Yes|
* [ReturnNullInsteadOfBoolean](#returnnullinsteadofboolean) - tweaks - sevntu - enabled [ReturnBooleanFromTernary](#returnbooleanfromternary)|tweaks|sevntu|Yes|
* [RightCurly](#rightcurly) - layout - checkstyle - enabled [ReturnCount](#returncount)|complexity|checkstyle|Yes|
* [SeparatorWrap](#separatorwrap) - layout - checkstyle - enabled [ReturnNullInsteadOfBoolean](#returnnullinsteadofboolean)|tweaks|sevntu|Yes|
* [SimpleAccessorNameNotation](#simpleaccessornamenotation) - naming - sevntu - enabled [RightCurly](#rightcurly)|layout|checkstyle|Yes|
* [SimplifyBooleanExpression](#simplifybooleanexpression) - complexity - checkstyle - enabled [SeparatorWrap](#separatorwrap)|layout|checkstyle|Yes|
* [SimplifyBooleanReturn](#simplifybooleanreturn) - complexity - checkstyle - enabled [SimpleAccessorNameNotation](#simpleaccessornamenotation)|naming|sevntu|Yes|
* [SingleBreakOrContinue](#singlebreakorcontinue) - tweaks - sevntu - enabled [SimplifyBooleanExpression](#simplifybooleanexpression)|complexity|checkstyle|Yes|
* [SingleLineJavadoc](#singlelinejavadoc) - javadoc - checkstyle - disabled [SimplifyBooleanReturn](#simplifybooleanreturn)|complexity|checkstyle|Yes|
* [SingleSpaceSeparator](#singlespaceseparator) - layout - checkstyle - enabled [SingleBreakOrContinue](#singlebreakorcontinue)|tweaks|sevntu|Yes|
* [StaticMethodCandidate](#staticmethodcandidate) - unspecified - sevntu - disabled [SingleLineJavadoc](#singlelinejavadoc)|javadoc|checkstyle||
* [StaticVariableName](#staticvariablename) - naming - checkstyle - enabled [SingleSpaceSeparator](#singlespaceseparator)|layout|checkstyle|Yes|
* [StringLiteralEquality](#stringliteralequality) - tweaks - checkstyle - enabled [StaticMethodCandidate](#staticmethodcandidate)|unspecified|sevntu||
* [SummaryJavadoc](#summaryjavadoc) - javadoc - checkstyle - disabled [StaticVariableName](#staticvariablename)|naming|checkstyle|Yes|
* [SuperClone](#superclone) - tweaks - checkstyle - disabled [StringLiteralEquality](#stringliteralequality)|tweaks|checkstyle|Yes|
* [SuperFinalize](#superfinalize) - tweaks - checkstyle - disabled [SummaryJavadoc](#summaryjavadoc)|javadoc|checkstyle||
* [SuppressWarnings](#suppresswarnings) - naming - checkstyle - enabled [SuperClone](#superclone)|tweaks|checkstyle||
* [SuppressWarningsHolder](#suppresswarningsholder) - naming - checkstyle - enabled [SuperFinalize](#superfinalize)|tweaks|checkstyle||
* [TernaryPerExpressionCount](#ternaryperexpressioncount) - tweaks - sevntu - enabled [SuppressWarnings](#suppresswarnings)|naming|checkstyle|Yes|
* [ThrowsCount](#throwscount) - complexity - checkstyle - enabled [SuppressWarningsHolder](#suppresswarningsholder)|naming|checkstyle|Yes|
* [TodoComment](#todocomment) - javadoc - checkstyle - enabled [TernaryPerExpressionCount](#ternaryperexpressioncount)|tweaks|sevntu|Yes|
* [TrailingComment](#trailingcomment) - layout - checkstyle - enabled [ThrowsCount](#throwscount)|complexity|checkstyle|Yes|
* [Translation](#translation) - javadoc - checkstyle - enabled [TodoComment](#todocomment)|javadoc|checkstyle|Yes|
* [TypecastParenPad](#typecastparenpad) - layout - checkstyle - enabled [TrailingComment](#trailingcomment)|layout|checkstyle|Yes|
* [TypeName](#typename) - naming - checkstyle - enabled - insuppressible [Translation](#translation)|javadoc|checkstyle|Yes|
* [UncommentedMain](#uncommentedmain) - javadoc - checkstyle - enabled [TypecastParenPad](#typecastparenpad)|layout|checkstyle|Yes|
* [UniformEnumConstantName](#uniformenumconstantname) - naming - sevntu - enabled [TypeName](#typename)|naming|checkstyle|Yes|No
* [UniqueProperties](#uniqueproperties) - javadoc - checkstyle - enabled [UncommentedMain](#uncommentedmain)|javadoc|checkstyle|Yes|
* [UnnecessaryParentheses](#unnecessaryparentheses) - layout - checkstyle - enabled [UniformEnumConstantName](#uniformenumconstantname)|naming|sevntu|Yes|
* [UnusedImports](#unusedimports) - layout - checkstyle - enabled [UniqueProperties](#uniqueproperties)|javadoc|checkstyle|Yes|
* [UpperEll](#upperell) - layout - checkstyle - enabled [UnnecessaryParentheses](#unnecessaryparentheses)|layout|checkstyle|Yes|
* [UselessSingleCatch](#uselesssinglecatch) - tweaks - sevntu - enabled [UnusedImports](#unusedimports)|layout|checkstyle|Yes|
* [UselessSuperCtorCall](#uselesssuperctorcall) - tweaks - sevntu - enabled [UpperEll](#upperell)|layout|checkstyle|Yes|
* [VariableDeclarationUsageDistance](#variabledeclarationusagedistance) - tweaks - checkstyle - enabled [UselessSingleCatch](#uselesssinglecatch)|tweaks|sevntu|Yes|
* [VisibilityModifier](#visibilitymodifier) - tweaks - checkstyle - enabled - insuppressible [UselessSuperCtorCall](#uselesssuperctorcall)|tweaks|sevntu|Yes|
* [WhitespaceAfter](#whitespaceafter) - layout - checkstyle - enabled [VariableDeclarationUsageDistance](#variabledeclarationusagedistance)|tweaks|checkstyle|Yes|
* [WhitespaceAround](#whitespacearound) - layout - checkstyle - enabled [VisibilityModifier](#visibilitymodifier)|tweaks|checkstyle|Yes|No
* [WhitespaceBeforeArrayInitializer](#whitespacebeforearrayinitializer) - layout - sevntu - disabled [WhitespaceAfter](#whitespaceafter)|layout|checkstyle|Yes|
* [WriteTag](#writetag) - unspecified - checkstyle - disabled [WhitespaceAround](#whitespacearound)|layout|checkstyle|Yes|
[WhitespaceBeforeArrayInitializer](#whitespacebeforearrayinitializer)|layout|sevntu||
[WriteTag](#writetag)|unspecified|checkstyle||
## Enabled Checks ## Enabled Checks

View file

@ -61,12 +61,15 @@ class ReadmeWriter implements CommandLineRunner {
@Override @Override
public void run(final String... args) throws Exception { public void run(final String... args) throws Exception {
final String readmeTemplate = readFile(templateProperties.getReadmeTemplate()); final String readmeTemplate = readFile(templateProperties.getReadmeTemplate());
final String indexHeader =
"Rule|Level|Source|Enabled|Suppressable\n" + "----|-----|------|-------|------------\n";
final String index = ruleIndex(); final String index = ruleIndex();
final String enabledCheckstyle = readmeRules(this::isEnabledCheckstyleRule); final String enabledCheckstyle = readmeRules(this::isEnabledCheckstyleRule);
final String enabledSevntu = readmeRules(this::isEnabledSevntuRule); final String enabledSevntu = readmeRules(this::isEnabledSevntuRule);
final String disabledCheckstyle = readmeRules(this::isDisabledCheckstyleRule); final String disabledCheckstyle = readmeRules(this::isDisabledCheckstyleRule);
final String disabledSevntu = readmeRules(this::isDisabledSevntuRule); final String disabledSevntu = readmeRules(this::isDisabledSevntuRule);
final byte[] readme = String.format(readmeTemplate, index, enabledCheckstyle, enabledSevntu, disabledCheckstyle, final byte[] readme =
String.format(readmeTemplate, indexHeader + index, enabledCheckstyle, enabledSevntu, disabledCheckstyle,
disabledSevntu disabledSevntu
) )
.getBytes(StandardCharsets.UTF_8); .getBytes(StandardCharsets.UTF_8);
@ -92,10 +95,9 @@ class ReadmeWriter implements CommandLineRunner {
final String source = rule.getSource() final String source = rule.getSource()
.toString() .toString()
.toLowerCase(Locale.ENGLISH); .toLowerCase(Locale.ENGLISH);
final String enabled = rule.isEnabled() ? "enabled" : "disabled"; final String enabled = rule.isEnabled() ? "Yes" : "";
final String insuppressible = rule.isInsuppressible() ? " - insuppressible" : ""; final String insuppressible = rule.isInsuppressible() ? "No" : "";
return String.format( return String.format("[%s](#%s)|%s|%s|%s|%s", rule.getName(), ruleLink, level, source, enabled, insuppressible);
"* [%s](#%s) - %s - %s - %s%s", rule.getName(), ruleLink, level, source, enabled, insuppressible);
} }
private boolean isEnabledSevntuRule(final Rule rule) { private boolean isEnabledSevntuRule(final Rule rule) {