pmd-rules.xml

<?xml version="1.0"?>
<!--
  ~ Grakn - A Distributed Semantic Database
  ~ Copyright (C) 2016-2018 Grakn Labs Limited
  ~
  ~ Grakn is free software: you can redistribute it and/or modify
  ~ it under the terms of the GNU Affero General Public License as published by
  ~ the Free Software Foundation, either version 3 of the License, or
  ~ (at your option) any later version.
  ~
  ~ Grakn is distributed in the hope that it will be useful,
  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  ~ GNU General Public License for more details.
  ~
  ~ You should have received a copy of the GNU General Public License
  ~ along with Grakn. If not, see <http://www.gnu.org/licenses/gpl.txt>.
  -->

<ruleset name="grakn"
         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 http://pmd.sourceforge.net/ruleset_2_0_0.xsd
http://pmd.sourceforge.net/ruleset/2.0.0 ">
    <description>Grakn PMD ruleset</description>

    <!-- Avoid general bad practices, e.g. empty `while` statements -->
    <rule ref="rulesets/java/basic.xml"/>

    <!-- Avoid redundant imports -->
    <rule ref="rulesets/java/imports.xml">

        <!-- Ignore too many static imports rule
        we avoid wildcard imports, so you can always tell where an import
        comes from. This means its not an issue to have lots of static imports.
        -->
        <exclude name="TooManyStaticImports"/>

    </rule>

    <!-- Avoid entirely redundant things, such as unnecesary use of `this` -->
    <rule ref="rulesets/java/unnecessary.xml">

        <!-- Ignore unnecessary parentheses rule
        Often redundant parentheses can make code easier to understand.
        -->
        <exclude name="UselessParentheses"/>

    </rule>

    <!-- Avoid unused code, e.g. methods, classes -->
    <rule ref="rulesets/java/unusedcode.xml"/>

    <!-- Avoid unused parameters in most cases-->
    <rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter"/>

</ruleset>