推荐使用:TLint - 提升 Laravel 和 PHP 代码质量的利器!
TLint 是一个为 Laravel 和 PHP 应用定制的强类型代码检查器,它包含了一套针对 Tighten 风格代码约定的自动格式化工具。通过这个开源项目,您可以确保团队遵循一致的编码规范,从而减少代码审查中的冲突和讨论。
安装与升级(PHP 8.1+)
要将 TLint 引入您的项目,只需运行以下命令:
composer require tightenco/tlint --dev
或者全局安装:
composer global require tightenco/tlint
在升级到新版本时,请参考文档进行操作。
使用 TLint 的好处
TLint 对于代码风格有着严格的检查,例如在 Laravel 中有多种向视图传递变量的方法,但 TLint 会提示您采用最推荐的方案。这提供了一个元级别的代码审查层,帮助团队避免高级别的分歧点。
如何使用
- 检查整个项目:
tlint
- 检查特定文件或目录:
tlint lint path/to/file.php
或tlint lint path/to/directory
- 只检查已修改的文件:
tlint lint --diff
- 输出 JSON 格式信息:
tlint lint file.php --json
- 输出 checkstyle XML 报告:
tlint lint file.php --checkstyle
- 仅运行指定的检查器:
tlint lint --only=LinterName
示例输出
当 TLint 发现不合规的代码时,它会显示详细的错误信息,如:
Linting TestLaravelApp/routes/web.php
============
Lints:
============
! Prefer `view(...)->with(...)` over `view(..., [...])`.
5 : ` return view('test', ['test' => 'test']);``
自定义配置
默认情况下,TLint 使用 "Tighten" 风格,但您可以通过创建名为 tlint.json
的配置文件来自定义规则。您可以选择 "laravel" 或 "tighten" 预设,并且可以禁用某些检查器,排除特定的目录,甚至添加自定义路径。
编辑器集成
目前支持 PHPStorm、Sublime Text 和 Visual Studio Code 插件,使得实时代码检查和格式化更加便捷。
扩展与插件
您可以创建自己的预设和检查器,实现更个性化的功能,只需提供一个实现了 PresetInterface
的类即可。
支持的检查器和格式化器
TLint 包含了一系列针对 Laravel 和 PHP 通用的检查器和格式化器。比如,用于检查路由中间件应用方式、数组参数传递、全限定门面等。每个检查器都有其独特的用途,帮助优化代码结构和风格。
在您开始使用 TLint 之后,相信会发现它对于提升团队效率和代码质量大有裨益。立即加入 TLint 社区,开始享受更加整洁、统一的编码体验吧!