Download the PHP package huangdijia/php-coding-standard without Composer

PHP 代码规范

基于 PHP CS Fixer 的全面 PHP 代码规范配置，适用于个人和团队使用。

特性

• 🚀 基于行业标准规则集（PSR-2、Symfony、PhpCsFixer）
• 🎯 针对现代 PHP 8.1+ 开发进行优化
• 🔧 轻松使用附加规则进行自定义
• 📝 自动头部注释生成
• ⚡ 支持并行处理，执行更快
• 🎨 预配置的 VSCode 集成

系统要求

• PHP 8.1 或更高版本
• Composer

安装

通过 composer 安装为开发依赖：

快速开始

选项 1：使用提供的模板文件

将配置模板复制到项目根目录：

编辑复制的 .php-cs-fixer.php 文件以匹配您的项目详情：

选项 2：替换现有的 php-cs-fixer

如果您的项目中已经有 friendsofphp/php-cs-fixer：

使用方法

基本命令

修复代码风格问题：

试运行（预览更改而不应用）：

如果您配置了 composer 脚本：

高级配置

自定义规则

您可以使用流式 API 添加或覆盖规则：

可用方法

• setRule(string $rule, mixed $value)：设置单个规则
• addRules(array $rules)：添加多个规则（与现有规则合并）
• setHeaderComment(...)：配置自动头部注释
• enableCache(string $cacheFile = '.php-cs-fixer.cache')：启用缓存以提高大型项目的性能
• disableRiskyRules()：禁用风险规则以实现更安全的自动修复
• forLaravel()：应用 Laravel 特定的优化配置

头部注释配置

setHeaderComment 方法支持灵活的联系人格式：

Laravel 项目配置

针对 Laravel 项目使用 forLaravel() 方法：

此方法会自动调整一些规则以更好地适配 Laravel 的编码风格。

库/包项目配置

对于库和包开发，使用 disableRiskyRules() 方法以实现更安全的修复：

排除目录

自定义要扫描的目录：

配置示例

项目提供了多个配置示例文件，位于 examples/ 目录：

• examples/laravel.php - Laravel 项目的完整配置示例
• examples/library.php - 库/包项目的配置示例
• examples/pre-commit-hook - Git 预提交钩子脚本

您可以参考这些示例来配置您的项目：

集成

CI/CD

GitHub Actions 工作流示例：

预提交钩子

添加到 .git/hooks/pre-commit：

或使用项目提供的预提交钩子脚本：

包含的规则

此配置包含：

• PSR-2：基本编码标准
• Symfony：Symfony 编码标准
• PhpCsFixer：额外的现代 PHP 最佳实践
• DoctrineAnnotation：Doctrine 注释格式化
• 自定义优化：性能和可读性改进

主要自定义：

• 短数组语法（[] 而不是 array()）
• 字符串使用单引号
• 优化的导入排序
• 适当的 PHPDoc 格式化
• 严格类型声明
• 现代 PHP 8.1+ 特性

贡献

1. Fork 仓库
2. 创建您的功能分支
3. 提交您的更改
4. 推送到分支
5. 创建 Pull Request

请确保所有代码都遵循既定的编码标准，运行：

运行测试

本项目使用 PHPUnit 进行测试。在提交更改之前，请运行测试以确保没有破坏现有功能：

您也可以运行静态分析：

安全

如果您发现任何安全漏洞，请发送邮件到 [email protected]，而不要使用问题跟踪器。

更新日志

请参阅 CHANGELOG 了解最近的更改信息。

许可证

MIT 许可证。请参阅 License File 了解更多信息。