smmccabe / phpdebt
使用一些代码健康工具来估算技术债务得分的应用程序。
1.1.0
2023-01-25 17:22 UTC
Requires
- drupal/coder: 8.3.13
- phploc/phploc: ^7.0
- phpmd/phpmd: ^2.13
- squizlabs/php_codesniffer: dev-api-friendly as 3.x-dev
- symfony/finder: ^6.2
Requires (Dev)
- clue/phar-composer: ^1.1
README
PHP 技术债务计算器
它通过扫描您的代码并基于现有代码分析工具的多个标准查找任何错误,统计找到的错误数量,并将其与功能性代码的总行数(排除注释和空白)进行比较,给出一个质量得分。
目前主要针对 Drupal
安装
wget https://github.com/smmccabe/phpdebt/releases/download/1.0.2/phpdebt.phar
chmod +x phpdebt.phar
sudo mv phpdebt.phar /usr/local/bin/phpdebt
用法和示例
针对整个项目
phpdebt .
针对特定文件夹
phpdebt src/
针对特定文件
phpdebt src/MyClass.php
针对通配符
phpdebt src/*.inc
示例输出
phpdebt .
phpmd cleancode: 145
phpmd codesize: 19
phpmd design: 2
phpmd naming: 35
phpmd unusedcode: 43
phpcs Drupal: 39
phpcs DrupalPractice: 69
Total Faults: 352
Total Lines: 10568
Quality Score: 3 faults per 100 lines
得分指南
每100行错误
- < 2 - 优秀的代码
- < 6 - 良好的代码
- < 10 - 可以接受的代码
- < 25 - 需要工作,应优先考虑清理工作,而不是大多数功能工作
- >= 25 需要大量工作,应优先考虑清理工作,而不是功能工作或错误修复。
修复找到的错误
phpdebt 目前没有提供详细模式,要识别和修复特定错误,建议直接运行 phpmd 和 phpcs 等工具,如果您想复制 phpdebt 的运行内容,请参阅 phpdebt 脚本。将来将添加详细模式。
错误或问题
请将任何错误、问题或支持请求发布到 github 问题板