phpmd.pharでのルールの変更

FuelPHPマイグレーション機能Doctrine Database Migrations LibraryなどのPHPマイグレーションツールで、定義するメソッド名がup()の場合、PHPMDを使うと、

$ phpmd /var/www/app/migrations/versions/Version20150714161820.php text codesize,unusedcode,design,naming

/var/www/app/migrations/versions/Version20150714161820.php:16 Avoid using short method names like Version20150714161820::up(). The configured minimum method name length is 3.

$ echo $?
2

となり、up()のメソッド名の長さが2文字のため、Naming RulesのShortMethodNameで規定されている3文字に足らないと警告される。
これを3文字から2文字に変更したいが、このphpmdコマンドは、Phar版で、ルールファイルはこの中に含まれている。

そのため、ルールファイルを編集するには、PHPMDのGithubからルールファイルを入手し、それを書き換える方法を採った。

変更例

  1. ルールファイルをダウンロードする
    wget https://raw.githubusercontent.com/phpmd/phpmd/master/src/main/resources/rulesets/naming.xml
    
  2. ルールを編集する
    @@ -74,7 +74,7 @@
             </description>
             <priority>3</priority>
             <properties>
    -            <property name="minimum" description="Minimum length for a method or function name" value="3"/>
    +            <property name="minimum" description="Minimum length for a method or function name" value="2"/>
                 <property name="exceptions" description="Comma-separated list of exceptions" value=""/>
             </properties>
             <example>
    

    phpmd-naming.xmlで保存しておく。

  3. phpmdコマンドでルールファイルを指定して実行する

    $ phpmd /var/www/app/migrations/versions/Version20150714161820.php text codesize,unusedcode,design,phpmd-naming.xml
    
    $ echo $?
    0
    

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト / 変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト / 変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト / 変更 )

Google+ フォト

Google+ アカウントを使ってコメントしています。 ログアウト / 変更 )

%s と連携中