README

此包包含一些额外的PHP Codesniffer规则，可添加到您的项目中。

用法

这些sniffs可以作为composer包添加；

$ composer require garrcomm/code-sniffs dev-master --dev

安装包后，将以下行添加到您的phpcs.xml文件中

<config name="installed_paths" value="vendor/garrcomm/code-sniffs"/>
<rule ref="Garrcomm"/>

或者使用以下参数运行PHP Codesniffer

$ ./vendor/bin/phpcs --standard=vendor/garrcomm/code-sniffs path/to/your/files

但为什么您不从一开始就编写干净的代码呢？

Sniffs有助于清理旧代码，它不仅仅是限制新代码。我发现了一些现有旧代码中的问题，并编写了sniffs来检测（并修复）一些常见问题。

代码质量

这些sniffs也是用PHP编写的。这些PHP文件通过PHPUnit和PHPStan进行扫描，以确保它们正常工作。此外，PHP CodeSniffer本身也扫描了代码，以确保它符合PSR-12标准，并且文档齐全。这些扫描在Bitbucket Pipelines中自动化。

可用的sniffs

• Garrcomm.Classes.ClassDeclarationInString.Found
  将类名作为字符串（$em->getReference('Foo\Bar', 1)）替换为::class常量（$em->getReference(\Foo\Bar::class, 1)）。
• Garrcomm.Commenting.DisallowCommentedCode.Found
  对注释掉的代码有错误（例如：// var_dump($foo);）
• Garrcomm.Commenting.DisallowHashComments.Found
  将哈希注释（# perl style comment）替换为普通注释（// regular comment）
• Garrcomm.Namespaces.UnusedUses.Found
  删除未使用的use语句（例如，当文件中未使用Bar时，use Foo\Bar;）

Windows开发者提示

在bin文件夹中，有几个批处理文件，以使开发更容易。

如果您安装了Docker Desktop for Windows，您可以使用bin\composer.bat、bin\phpstan.bat、bin\phpunit.bat、bin\phpcs.bat和bin\phpcbf.bat作为Composer、PHP静态分析器、PHP单元测试、CodeSniffer和Code Beautifier的快捷方式，无需在您的机器上安装PHP和其他依赖项。