Skip to content

インストール

Psalmの最新バージョンには、PHP >= 7.4とComposerが必要です。

composer require --dev vimeo/psalm

設定ファイルを生成します:

./vendor/bin/psalm --init

Psalmはプロジェクトをスキャンし、コードベースに適切なエラーレベルを決定します。

そして、Psalmを実行します:

./vendor/bin/psalm

Psalmはおそらくいくつかの問題を見つけるでしょう - それらの対処方法についてはコードの問題への対処を参照してください。

プラグインのインストール

Psalmは様々なライブラリで使用される型をそのソースコードとdocblockに基づいて把握できますが、Psalmプラグインによって提供されるカスタムメイドの型を使用するとさらに効果的に動作します。

Packagistにある既存のプラグインのリストをチェックしてください。composer require --dev <plugin/package> && vendor/bin/psalm-plugin enable <plugin/package>でインストールできます。

プラグインについての詳細はプラグインの使用の章を参照してください。

Pharの使用

プロジェクトがPsalmの依存関係の1つ以上と競合する場合があります。その場合、Phar(自己完結型のPHP実行可能ファイル)が役立つかもしれません。

PharはGithubからダウンロードできます:

wget https://github.com/vimeo/psalm/releases/latest/download/psalm.phar
chmod +x psalm.phar
./psalm.phar --version

あるいは、Composerを使用してPharをインストールすることもできます:

composer require --dev psalm/phar

ユーザーノート