【PHP】コードのバージョン互換性チェック。PHPCompatibilityをインストールして使う。

PHP のバージョンを上げたときに、廃止、あるいは非推奨になるコードを洗い出すのに便利な PHP_CodeSniffer + PHPCompatibility をインストールしましょ。

【うちの環境】
  • Linux Mint 22.3
  • PHP 8.4.27

まずは Composer のインストール。Ubuntu / Linux Mint の apt でもインストール可能ですが、バージョンが古い場合があるので、今回は公式サイトから最新版をインストールします。

上記ページは、アクセスした OS によって若干異なる内容が表示されます。使用している OS が Linux であれば、ページで紹介されている以下のコマンドたちをターミナルで順に実行すれば、カレントディレクトリに Composer がインストールされます。

composer_install.png

説明にもあるとおり、グローバルで利用したい場合には、インストール完了後に

sudo mv composer.phar /usr/local/bin/composer

を実行します。

次に PHP_CodeSniffer と PHPCompatibility のインストール。特定のプロジェクト内ではなくてグローバルで利用したいので、composer global require コマンドを使います。

PHPCompatibility の安定版(ver9.3.5)をインストールしたい場合は:

composer global require phpcompatibility/php-compatibility

最新のαリリース版(執筆時点では 10.0.0-alpha2)をインストールする場合は:

composer global require phpcompatibility/php-compatibility:^10.0.0-alpha2

と、バージョン指定してインストール。

PHP_CodeSniffer が未インストールの場合は、上記コマンドで適切なバージョンの CodeSniffer も同時にインストールされる筈。既に CodeSniffer がインストールされている場合、

…という依存関係があります。バージョン不整合はインストール時に怒られます。

次に、インストールした CodeSniffer に path を通します。

global でインストールした場合、Linux Mint / Ubuntu であれば、通常 Composer パッケージは、ホームディレクトリの .config/composer/vendor/bin に配置されます。

composer global config bin-dir --absolute

で、インストールディレクトリのフルパスが確認できます。

ここにパスを通します。以下を実行して .bashrc に path 設定を追加。

echo 'export PATH="$HOME/.config/composer/vendor/bin:$PATH"' >> ~/.bashrc

続いて .bashrc の変更を反映させます。

source .bashrc

これで試しに

which phpcs

を実行してみると /home/ユーザ名/.config/composer/vendor/bin/phpcs と返ってくる筈。コマンドラインで phpcs コマンド(PHP_CodeSniffer)が使えるようになりました。

さて、CodeSinffer 3.x + PHPCompatibility 9.3.5 をインストールした場合、CodeSniffer に PHPCompatibility の場所を教えてあげる必要があるかもしれません。

the "PHPCompatibility" coding standard is not installed. The installed coding standards are ...
みたいなエラーが出た場合、この作業を行います。

グローバルインストールの場合、Linux Mint / Ubuntu では ホームディレクトリの .config/composer/vendor/phpcompatibility/php-compatibility あたりに置かれている筈なので確認してみてください。場所が確認できたら以下を実行。

phpcs --config-set installed_paths PHPCompatibilityへのpath。うちの場合は ~/.config/composer/vendor/phpcompatibility/php-compatibility

CodeSniffer 4.x + PHPCompatibility 10.x を同時にインストールした場合は、自動的に path が設定されると思います。

これで PHPCompatibility を使う準備が整った、ということで「むかし書いたスクリプトが、PHP8.4 でも動くかどうかチェック」したいときは以下のような感じ。

phpcs --standard=PHPCompatibility --runtime-set testVersion 8.4 チェックしたいファイル or ディレクトリへのパス

指定した PHP のバージョンで廃止されたり、非推奨となったコードがあれば、それを教えてくれます。必ずしも「指摘された部分さえ修正すれば意図どおりに動く」わけではないですが、修正作業の効率化は図れます。

ということで。

カテゴリ: