phpstan friendly formatter

？ phpstanフレンドリーなフォーマッタ

コードを実現するフォーマッタでPHPSTANエクスペリエンスを強化してください！

？特徴

• ディスプレイコードフレーム：エラーが発生した場所で問題のあるコードを参照してください
• エラー識別子の概要：エラータイプとその周波数の概要を簡単に入手してください
• 美しい出力：視覚的に魅力的で読みやすいエラーレポートをお楽しみください

モチベーション

ファイルパスとライン番号の海で迷子になったと感じたことはありますか？私たちはそこにいました！だから私たちはこのフォーマッタを作成しました：

• コードの何が問題なのかを即座に特定します
• エラーメッセージを解釈するときは、精神的なオーバーヘッドを減らします
• デバッグプロセスを加速します

はじめる

1. Composerを使用して、このパッケージを開発依存関係としてインストールできます。

composer require --dev yamadashy/phpstan-friendly-formatter

2. エラーのフォーマッタをphpstan.neonまたはphpstan.neon.distに登録：

 includes :
    - ./vendor/yamadashy/phpstan-friendly-formatter/extension.neon

3. 最後に、 errorFormatパラメーターを設定します。

 parameters :
    errorFormat : friendly

オプション：ワークフローを簡素化します

よりシンプルにしたい場合は、次のようにcomposer.jsonのscriptsを設定します。

{
    "scripts" : {
        "analyze" : " phpstan analyze --error-format friendly "
    }
}

このような短いコマンドを実行できます。

composer analyze

構成オプション

phpstan.neonでカスタマイズできます：

 parameters :
    friendly :
        # default is 3
        lineBefore : 3
        lineAfter : 3
        # default is null
        editorUrl : ' phpstorm://open?file=%%file%%&line=%%line%% '

• lineBefore ...エラーラインの前に表示する行の数
• lineAfter ...エラーライン後に表示する行の数
• editorUrl ... [テーブルフォーマッタ構成]のようなプレースホルダーを備えたURL（テーブルフォーマッタのような編集者用のURL）

？§例

GitHubアクションで実際に導入すると、次のように表示されます。

https://github.com/yamadashy/laravel-blade-minify-directive/actions/runs/4714024802/jobs/8360104870

ライセンス

MITライセンスの下で配布されます。