configs/pmd-rules.xml - master - githubmirror/sqlancer

configs/pmd-rules.xml
97 строк4 KB
Manuel Rigger
Address various new PMD issues
09 дек 2020, 01:28
09 дек 2020, 01:28c8e8b9e
<?xml version="1.0"?>

<ruleset name="Custom Rules"
	xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">

	<description>SQLancer's PMD configuration</description>

	<!-- best practices https://pmd.github.io/latest/pmd_rules_java_bestpractices.html -->
	<!-- TODO: use a logger <rule ref="category/java/bestpractices.xml/SystemPrintln" 
		/> -->

	<rule ref="category/java/bestpractices.xml">
		<exclude name="AvoidPrintStackTrace" /> <!-- TODO: add a logger -->
		<exclude name="SystemPrintln" /> <!-- TODO: add a logger -->
		<exclude name="AvoidStringBufferField" />
		<exclude name="PreserveStackTrace" /> <!-- TODO -->
		<exclude name="WhileLoopWithLiteralBoolean" />
		<exclude name="LiteralsFirstInComparisons" />
		<exclude name="ForLoopCanBeForeach" />
		<exclude name="CheckResultSet" />
		<exclude name="UseTryWithResources" />
		<exclude name="AvoidReassigningLoopVariables" />
		<exclude name="AbstractClassWithoutAbstractMethod" />
		<exclude name="UnusedAssignment" />
		<priority>2</priority>
	</rule>

	<rule ref="category/java/codestyle.xml">
		<priority>1</priority>
		<exclude name="MethodArgumentCouldBeFinal" />
		<exclude name="LocalVariableCouldBeFinal" />
		<exclude name="ShortVariable" />
		<exclude name="OnlyOneReturn" />
		<exclude name="LongVariable" />
		<exclude name="ClassNamingConventions" />
		<exclude name="DefaultPackage" />
		<exclude name="CallSuperInConstructor" />
		<exclude name="AtLeastOneConstructor" />
		<exclude name="CommentDefaultAccessModifier" />
		<exclude name="UseUnderscoresInNumericLiterals" />
		<exclude name="FieldNamingConventions" />
		<exclude name="EmptyMethodInAbstractClassShouldBeAbstract" />

		<!-- TODO -->
		<exclude name="ShortClassName" />
		<exclude name="LinguisticNaming" />
		<exclude name="ConfusingTernary" />
		<exclude name="PrematureDeclaration" />
		<exclude name="BooleanGetMethodName" />
	</rule>
	<rule ref="category/java/design.xml">
		<priority>2</priority>
		<exclude name="LoosePackageCoupling" />
		<exclude name="LawOfDemeter" />
		<exclude name="TooManyMethods" />
		<exclude name="CyclomaticComplexity" />
		<exclude name="NPathComplexity" />
		<exclude name="NcssCount" />
		<exclude name="AvoidCatchingGenericException" />
		<exclude name="AvoidDeeplyNestedIfStmts" />
		<exclude name="GodClass" />
		<exclude name="DataClass" />
		<exclude name="ExcessiveImports" />
		<exclude name="ExcessivePublicCount" />


		<exclude name="SingularField" />
		<exclude name="ExcessiveClassLength" />
		<exclude name="SwitchDensity" />
		<exclude name="SingularField" />
		<exclude name="ExcessiveMethodLength" />
		<exclude name="TooManyFields" />
		<exclude name="SignatureDeclareThrowsException" />
	</rule>
	<rule ref="category/java/performance.xml">
		<priority>2</priority>
		<exclude name="AppendCharacterWithChar" />
		<exclude name="ConsecutiveLiteralAppends" />
		<exclude name="AvoidInstantiatingObjectsInLoops" />
		<exclude name="InsufficientStringBufferDeclaration" />
		<exclude name="ConsecutiveAppendsShouldReuse" />
		<exclude name="UseStringBufferForStringAppends" />
		<exclude name="SimplifyStartsWith" />
		<exclude name="TooFewBranchesForASwitchStatement" />
		<exclude name="OptimizableToArrayCall" />
		<exclude name="AvoidFileStream" />
	</rule>
    <rule ref="category/java/documentation.xml">
		<priority>2</priority>
		<exclude name="CommentRequired" />
		<exclude name="CommentSize" />
		<exclude name="UncommentedEmptyMethodBody" />
		<exclude name="UncommentedEmptyConstructor" />
	</rule>
</ruleset>