README

PHP代码规范规则

这是“OPAY解决方案”开发者使用的PHP代码规范工具和规则集，以确保我们交付可维护和最高质量的代码。

本工具集的主要目的是确保开发者编写符合PSR规范的代码。我们添加了许多附加规则，以提高代码质量和可读性。如果发现至少一个代码风格错误或警告，我们的代码就不会进入生产环境。

包内容

• friendsofphp/php-cs-fixer - 强大的PHP代码规范工具
• squizlabs/php_codesniffer - 另一个强大且可定制的PHP代码规范工具
• slevomat/coding-standard - PHP CodeSniffer的附加代码规范规则集
• moxio/php-codesniffer-sniffs - PHP CodeSniffer的附加代码规范规则集
• PHP CodeSniffer的Opay自定义代码规范规则

PHP-CS-Fixer和PHP_CodeSniffer都是PHP代码规范工具，它们相互补充，允许开发者编写最高质量的代码。

安装与使用

使用composer将其作为开发依赖项安装

$ composer require --dev opay-dev/php-linting-tools

运行工具验证您的文件

vendor/bin/php-cs-fixer fix path/to/files --dry-run --verbose
vendor/bin/phpcs -p --standard=OpaySniffs path/to/files

运行工具自动修复您的文件（并非所有文件都可以修复，某些文件可能需要手动修复）

vendor/bin/php-cs-fixer fix path/to/files --verbose
vendor/bin/phpcbf -p --standard=OpaySniffs path/to/files

设置自定义配置并运行工具验证您的文件

vendor/bin/php-cs-fixer fix --config="ConfigExamples/custom_phpcsfixer_config.php" --dry-run --verbose
vendor/bin/phpcs -p --standard="ConfigExamples/custom_phpcs_config.xml"

设置自定义配置并运行工具自动修复您的文件

vendor/bin/php-cs-fixer fix --config="ConfigExamples/custom_phpcsfixer_config.php" --verbose
vendor/bin/phpcbf -p --standard="ConfigExamples/custom_phpcs_config.xml"

配置bash脚本或将脚本添加到composer.json中，然后使用单个命令composer lint运行它

{
    "lint": [
        "vendor/bin/php-cs-fixer fix path/to/files --dry-run --verbose",
        "vendor/bin/phpcs -p --standard=OpaySniffs path/to/files"
    ]
}

许可证

这是一套由不同开发团队创建的工具集，由Opay开发者收集并添加了额外的规则。只要不违反其他开发者的许可证，本软件包可在MIT许可证下使用。