More than 1 year has passed since last update.

CodeSnifferを利用してコーディング規約を自動チェック

Last updated at 2022-02-17Posted at 2022-02-16

初めに

開発を行っていく中、コーディング規約(PSR12)が守られているかをチェックを行うことは必須です。
しかし、自分で目視してもどこかで見落としがあったりリファクタリングに時間がかかったりしないでしょうか？

そんな時に、自動でコーディング規約を守られているかをチェックするツールが CodeSniffer です。

※今回のチェック対象は Laravel8 のWebアプリケーションです。

PSR12とは

PSR-12 は、コーディングスタイルガイドである PSR-2 の拡張および置き換えと、基本的なコーディング標準である PSR-1 への準拠が必要になります。
PSR-2 と同様に、PSR-12 の目的は、異なる作成者のコードを理解する（読む）際の認識の摩擦を減らすことです。

詳しい詳細は以下URLを参照。
【PHP】PSR-12 Extended Coding Style（拡張コーディングスタイル）

なお、LaravelはPSR2が非推奨となりPSR12を使用することを推奨されています。

CodeSnifferを実際に使う

composerを利用する場合

1. composer.jsonに記載する

composer.json

"require-dev": {
        "squizlabs/php_codesniffer": "3.*"
    }

2. composer updateを実行

$ composer update

3. phpcs.xmlを作成し、ルールや設定を定義

phpcs.xml

<?xml version="1.0"?>
<ruleset name="PSR12 Custom">
    <description>A custom PSR12</description>

    <arg name="extensions" value="php" />

    <!-- 適用コーディング規約の指定 -->
    <rule ref="PSR12" />

    <!-- 出力に色を適用 -->
    <arg name="colors" />

    <!-- オプション p:進捗表示  s:エラー表示時にルールを表示 -->
    <arg value="ps" />

    <!-- 除外ディレクトリ -->
    <exclude-pattern>/bootstrap/</exclude-pattern>
    <exclude-pattern>/config/</exclude-pattern>
    <exclude-pattern>/database/</exclude-pattern>
    <exclude-pattern>/node_modules/</exclude-pattern>
    <exclude-pattern>/public/</exclude-pattern>
    <exclude-pattern>/resources/</exclude-pattern>
    <exclude-pattern>/routes/</exclude-pattern>
    <exclude-pattern>/storage/</exclude-pattern>
    <exclude-pattern>/vendor/</exclude-pattern>
    <exclude-pattern>/server.php</exclude-pattern>
    <exclude-pattern>/app/Console/Kernel.php</exclude-pattern>
    <exclude-pattern>/tests/CreatesApplication.php</exclude-pattern>
</ruleset>

・コーディング規約として PSR12 を指定。
・エラーレポート出力時に色付けする。
・オプションとして、エラー表示時にルールを表示する事、進捗を表示する事を指定。
・除外するディレクトリやファイルを指定。今回はLaravelのコアソースをなるべく除外し、appとtestsディレクトリ内をチェックするようにする。

4.結果コマンドを実行する

コマンドが長いため、composer.jsonのscripts内に記載してcomposer updateを実行

composer.json

"scripts": {
    "phpcs": [
            "./vendor/bin/phpcs --standard=phpcs.xml ./"
        ]
    }

Before

$ ./vendor/bin/phpcs --standard=phpcs.xml ./

after

$ composer phpcs

コーディング規約でエラーがあれば出力されるが、なければ以下のように表示される

> ./vendor/bin/phpcs --standard=phpcs.xml ./

Deprecated: PHP Startup: Use of mbstring.internal_encoding is deprecated in Unknown on line 0
........................... 27 / 27 (100%)