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

README.md: include rule level in index

Browse source
This commit is contained in:
Paul Campbell 2017-01-05 23:51:59 +00:00
parent 0dd1ec4990
commit a2b64abe77
4 changed files with 208 additions and 198 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

388
README.md
View file

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

4
builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/CheckstyleWriter.java
View file

@ -58,6 +58,7 @@ class CheckstyleWriter implements CommandLineRunner {
@Override @Override
public void run(final String... args) throws Exception { public void run(final String... args) throws Exception {
Stream.of(RuleLevel.values()) Stream.of(RuleLevel.values())
.filter(level -> !level.equals(RuleLevel.UNSPECIFIED))
.forEach(this::writeCheckstyleFile); .forEach(this::writeCheckstyleFile);
} }
@ -103,7 +104,8 @@ class CheckstyleWriter implements CommandLineRunner {
return String.format("<module name=\"%s\"/>", rule.getName()); return String.format("<module name=\"%s\"/>", rule.getName());
} }
return String.format("<module name=\"%s\">%n %s%n</module>", rule.getName(), return String.format("<module name=\"%s\">%n %s%n</module>", rule.getName(),
formatProperties(rule.getProperties())); formatProperties(rule.getProperties())
);
} }
private String formatProperties(final Map<String, String> properties) { private String formatProperties(final Map<String, String> properties) {

11
builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/ReadmeWriter.java
View file

@ -35,6 +35,7 @@ import java.nio.file.Path;
import java.nio.file.StandardOpenOption; import java.nio.file.StandardOpenOption;
import java.util.Comparator; import java.util.Comparator;
import java.util.Locale; import java.util.Locale;
import java.util.Optional;
import java.util.function.Predicate; import java.util.function.Predicate;
import java.util.stream.Collectors; import java.util.stream.Collectors;
@ -75,7 +76,8 @@ class ReadmeWriter implements CommandLineRunner {
private String ruleIndex() { private String ruleIndex() {
return rulesProperties.getRules() return rulesProperties.getRules()
.stream() .stream()
.sorted(Comparator.comparing(rule -> rule.getName().toLowerCase(Locale.ENGLISH))) .sorted(Comparator.comparing(rule -> rule.getName()
.toLowerCase(Locale.ENGLISH)))
.map(this::formatRuleIndex) .map(this::formatRuleIndex)
.collect(Collectors.joining(NEWLINE)); .collect(Collectors.joining(NEWLINE));
} }
@ -83,12 +85,17 @@ class ReadmeWriter implements CommandLineRunner {
private String formatRuleIndex(final Rule rule) { private String formatRuleIndex(final Rule rule) {
final String ruleLink = rule.getName() final String ruleLink = rule.getName()
.toLowerCase(Locale.ENGLISH); .toLowerCase(Locale.ENGLISH);
final String level = Optional.ofNullable(rule.getLevel())
.orElse(RuleLevel.UNSPECIFIED)
.toString()
.toLowerCase(Locale.ENGLISH);
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() ? "enabled" : "disabled";
final String insuppressible = rule.isInsuppressible() ? " - insuppressible" : ""; final String insuppressible = rule.isInsuppressible() ? " - insuppressible" : "";
return String.format("* [%s](#%s) - %s - %s%s", rule.getName(), ruleLink, source, enabled, insuppressible); return String.format(
"* [%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) {

3
builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleLevel.java
View file

@ -11,5 +11,6 @@ public enum RuleLevel {
NAMING, NAMING,
JAVADOC, JAVADOC,
TWEAKS, TWEAKS,
COMPLEXITY; COMPLEXITY,
UNSPECIFIED,
} }