README

特性

包含来自《代码整洁之道》和我的经验最佳实践的额外phpmd规则。

• 代码整洁
  • 条件表达式 - 提高可读性
  • 构造函数新操作符 - 解耦类，遵循开闭原则
  • 数据结构常量 - 提高可维护性
  • 数据结构方法 - 提高可扩展性，遵循单一职责原则
  • 成员主前缀 - 支持低耦合，提高可测试性，遵循迪米特法则
  • 公共字段声明 - 提高可维护性，遵循封装/信息隐藏原则
  • 返回语句 - 提高阅读速度，提高可扩展性
  • switch语句 - 提高可扩展性，遵循开闭原则
  • Trait公共方法 - 提高可维护性，遵循封装/信息隐藏原则
  • try语句 - 提高可读性
  • 私有字段声明 - 支持高内聚，遵循DRY和单一职责原则
• 命名
  • 类名后缀 - 提高可扩展性，遵循单一职责原则
  • 注释描述 - 减少未使用声明，提高可理解性
  • 方法名 - 提高可读性，提高可理解性
• 测试
  • 模拟数量 - 提高可测试性，支持低耦合，遵循单一职责原则
  • 断言数量 - 提高可维护性，加快调试速度，遵循单一职责原则
  • 方法名 - 提高可读性，提高可理解性

安装

下载 phpmd-extension.phar

$ curl -OsL https://github.com/mi-schi/phpmd-extension/releases/download/stable/phpmd-extension.phar

或者可以使用 tooly-composer-script 进行安装。

也可以使用composer（不推荐，见 #5）

composer require mi-schi/phpmd-extension --dev

用法

1. 创建一个 phpmd.xml 文件并导入phpmd的基本规则。下面的例子包含了一些有用的更改。之后，你可以使用此仓库中的规则扩展配置。
2. 然后执行消息检测，使用phpmd-extension.phar [path/to/src] xml [path/to/phpmd.xml]。phpmd-extension.phar将所有参数传递给基本的phpmd命令。您无需安装phpmd。phpmd-extension.phar包含了phpmd。

基本规则

<ruleset name="basic-rules"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
                      http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>mess detection</description>

    <rule ref="rulesets/cleancode.xml" />
    <rule ref="rulesets/codesize.xml">
        <exclude name="ExcessiveParameterList" />
        <exclude name="ExcessiveMethodLength" />
        <exclude name="ExcessiveClassLength" />
        <exclude name="CyclomaticComplexity" />
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
        <properties>
            <property name="minimum" value="4" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
        <properties>
            <property name="minimum" value="31" />
            <property name="ignore-whitespace" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveClassLength">
        <properties>
            <property name="minimum" value="301" />
            <property name="ignore-whitespace" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
        <properties>
            <property name="reportLevel" value="6" />
            <property name="showClassesComplexity" value="true" />
            <property name="showMethodsComplexity" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/controversial.xml" />
    <rule ref="rulesets/design.xml" />
    <rule ref="rulesets/naming.xml">
        <exclude name="ShortVariable" />
        <exclude name="LongVariable" />
    </rule>
    <rule ref="rulesets/naming.xml/ShortVariable">
        <properties>
            <property name="minimum" value="2" />
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/LongVariable">
        <properties>
            <property name="maximum" value="30" />
        </properties>
    </rule>
    <rule ref="rulesets/unusedcode.xml" />
</ruleset>

添加额外规则

    <rule ref="../../../../../../rulesets/cleancode.xml" />
    <rule ref="../../../../../../rulesets/naming.xml" />
    <rule ref="../../../../../../rulesets/test.xml" />

您也可以使用自己的属性自定义规则或只使用特定规则。只需查看xml文件。它遵循基本规则集的逻辑。

排除或自定义额外规则

如果您不希望排除Law-of-Demeter规则MemberPrimaryPrefix，请排除它。

    <rule ref="../../../../../../rulesets/cleancode.xml">
        <exclude name="MemberPrimaryPrefix" />
    </rule>

如果您想自定义它，请使用以下代码

    <rule ref="../../../../../../rulesets/cleancode.xml/MemberPrimaryPrefix">
    	<properties>
	    <property name="maxChainCount" value="3" description="max count of method chains" />
            <property name="allowedPrefixes" value="add,set" description="allowed prefixes for the method train" />
            <property name="delimiter" value="," description="delimiter for explode" />
        </properties>
    </rule>