README

Flaconi PHP_CodeSniffer 编码标准提供以下类别的 sniffs

• 测试 - 提高PHPUnit测试用例的代码风格

目录

1. 本标准包含的 sniffs
   • 测试 - 提高PHPUnit测试用例的代码风格
2. 安装
3. 如何运行 sniffs
   • 选择要运行的 sniffs
   • 使用标准中所有 sniffs
4. 自动修复错误
5. 局部抑制 sniffs
6. 贡献

本标准包含的 sniffs

🔧 = 自动错误修复

测试 - 提高PHPUnit测试用例的代码风格

FlaconiCodingStandard.Test.UseMethodPrefixInTestcase 🔧

• 检查 @test 并强制使用 test 前缀

FlaconiCodingStandard.Test.UseStaticCallsForAssertInTestcase 🔧

报告非静态断言方法类的使用

安装

推荐安装 Flaconi 编码标准的方式是通过Composer。

composer require --dev flaconi/coding-standard

如何运行 sniffs

您可以选择两种方式之一，在您的代码库上仅运行标准中的选定 sniffs

选择要运行的 sniffs

在项目的 ruleset.xml 中提及 Flaconi 编码标准

<?xml version="1.0"?>
<ruleset name="AcmeProject">
	<rule ref="vendor/flaconi/coding-standard/src/ruleset.xml"><!-- relative path to your ruleset.xml -->
		<!-- sniffs to exclude -->
	</rule>
</ruleset>

在命令行上运行 phpcs 时，使用 --sniffs 选项以逗号分隔列出您希望使用的所有 sniffs

vendor/bin/phpcs --standard=ruleset.xml \
--sniffs=FlaconiCodingStandard.Test.UseStaticCallsForAssertInTestcase,FlaconiCodingStandard.Test.UseMethodPrefixInTestcase \
--extensions=php --encoding=utf-8 --tab-width=4 -sp src tests

或者编写自己的 ruleset.xml，通过引用选定的 sniffs。这是一个示例 ruleset.xml

<?xml version="1.0"?>
<ruleset name="AcmeProject">
	<config name="installed_paths" value="../../flaconi/coding-standard"/><!-- relative path from PHPCS source location -->
	<rule ref="FlaconiCodingStandard.Test.UseMethodPrefixInTestcase"/>
	<!-- other sniffs to include -->
</ruleset>

然后像往常一样运行 phpcs 可执行文件

vendor/bin/phpcs --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

自动修复错误

本标准中带有 🔧 符号的 sniffs 支持通过自动修复编码标准违规。要自动修复代码，请运行 phpcbf 而不是 phpcs

vendor/bin/phpcbf --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

请始终记住在执行自动修复之前备份您的代码，并亲自检查结果，因为自动修复器有时会产生不希望的结果。

贡献

为了使此存储库在您的机器上运行，请克隆它，并在存储库的根目录中运行以下两个命令

composer install
composer code-style
composer tests

编写一些代码并编辑或添加单元测试后，再次运行 phing 以检查一切正常

composer code-style
composer tests

我们始终期待您的错误报告、功能请求和拉取请求。谢谢。