Laravel
PHP7
PHP7.2
PHPInsights

Laravel PHP Insightsを使ってコード品質を分析する

スクリーンショット 2019-05-17 13.03.57.png


PHP Insights

公式 - phpinsights

GitHub - nunomaduro/phpinsights


  • コード品質とコーディングスタイルを分析するPHPの品質チェックツール

  • コードの信頼性、疎結合、シンプルさ、セキュリティを高めます

  • PHPCS, PHPLOC, EasyCodingStandard をラッパーしたコンソールインターフェース

  • Laravel, Symfonyフレームワークにお手軽に導入可


    • 素のPHPでも使用可能




インストール要件


  • PHP 7.2 以降


インストール

$ composer require nunomaduro/phpinsights --dev


設定ファイルのコピー

$ php artisan vendor:publish --provider="NunoMaduro\PhpInsights\Application\Adapters\Laravel\InsightsServiceProvider"

./vendor/nunomaduro/phpinsights/stubs/laravel.php のファイルが ./config/insights.php にコピーされます。


使い方

$ php artisan insights


コマンドオプション - 詳細表示

$ php artisan insights -v

デフォルトだと、最初の3つの問題のみ表示されますが -v オプションを付けるとすべて表示されます。


評価の項目


  • Code コード評価

  • Complexity 複雑さ評価

  • Architecture アーキテクチャ評価

  • Style コーディングスタイルやセキュリティ等の評価

上記の4項目から評価されます。


評価のスコア

評価のスコアは 1 〜 100 点です。


  • 赤: 1-49

  • 黄: 50-79

  • 緑: 80-100

がんばって緑を目指しましょう😎


まとめ

コーディングスタイルのチェックはもちろんのこと、

未使用の変数や無駄な括弧、Todoコメントなど様々細かく指摘してもらえます。

使用しているライブラリにセキュリティ問題があった場合も検知します。

導入は簡単なのでもしよかったらお試しください😊


参考