PHPInsights 旨在帮助开发者分析 PHP 项目的代码质量,它简化了代码分析的过程,可直接在终端运行。( 要求: PHP 7.2+ )
代码质量和编码风格分析
美观的展示,可查看代码的体系结构和复杂性
兼容 Laravel、Symfony 等 PHP 框架
内置检查,使代码可靠、简洁且松散耦合。
友好的控制台交互,基于 PHPCS, PHPLOC 和 EasyCodingStandard
要求: PHP 7.2+
首先使用 Composer 包管理器安装 PHP Insights:
composer require nunomaduro/phpinsights --dev
然后使用 phpinsights 执行文件:
phpinsights
./vendor/bin/phpinsights
在 Windows 下执行 bat 脚本:
.\vendor\bin\phpinsights.bat
可以通过发布 config-file:
php artisan vendor:publish --provider="NunoMaduro\PhpInsights\Application\Adapters\Laravel\InsightsServiceProvider"
然后使用 insights Artisan 命令:
insights
php artisan insights
创建配置文件:
cp vendor/nunomaduro/phpinsights/stubs/symfony.php phpinsights.php
Windows:
Insights
可以通过创建并编辑如下配置文件来定制 insights
cp vendor/nunomaduro/phpinsights/stubs/config.php phpinsights.php
你可以在 CI 中通过 --min-quality, --min-complexity, --min-architecture, --min- style来定义 PHP Insights
--min-quality
--min-complexity
--min-architecture
--min- style
如果最小层级不可达,控制台会返回错误信息:
./vendor/bin/phpinsights --no-interaction --min-quality=80 --min-complexity=90 --min-architecture=75 --min-style=95 # Within Laravel php artisan insights --no-interaction --min-quality=80 --min-complexity=90 --min-architecture=75 --min-style=95
注意 : --no-interaction 参数可以用来避免 CI 进入交互过程
--no-interaction
其他的参数都是可选的,如果你指向聚焦样式,可以通过添加 --min-style 参数即可
--min-style