phlak/coding-standards

PHP CS Fixer 的预定义编码标准集合。

资助包维护!
PHLAK
Paypal

2.2.0 2023-06-02 20:36 UTC

README

Join our Community Become a Sponsor One-time Donation
Latest Stable Version Total Downloads License GitHub branch checks state

PHP CS Fixer 的预定义编码标准集合
Chris Kankiewicz (@PHLAK) 创建

要求

  • PHP >= 7.2

安装

composer require --dev phlak/coding-standards

使用

安装后,您可以使用提供的 cs 可执行文件初始化编码标准配置。

composer exec cs init

或者您可以在根目录手动创建一个 .php-cs-fixer.dist.php 文件,内容如下。

<?php

require __DIR__ . '/vendor/autoload.php';

$finder = PhpCsFixer\Finder::create()->in([
    // List of paths you wish to include
]);

return PHLAK\CodingStandards\ConfigFactory::make($finder);

将您希望包含的路径添加到数组中。

现在您可以像平常一样运行 php-cs-fixer

添加/覆盖规则

您可以通过将它们作为 ConfigFactory::make() 方法的第二个参数传递来添加额外的规则或覆盖预定义的规则。这些规则将与预定义的规则合并。

return PHLAK\CodingStandards\ConfigFactory::make($finder, [
    // Your additional rules here...
]);

额外配置

可以通过将方法链接到 ConfigFactory::make() 方法来实现额外的配置。

return PHLAK\CodingStandards\ConfigFactory::make($finder)
    ->setIndent("\t")
    ->setLineEnding("\r\n")
    ->setRiskyAllowed();

变更日志

更改列表可以在 GitHub Releases 页面上找到。

故障排除

对于一般帮助和支持,请加入我们的 GitHub Discussions 或在 Twitter 上联系我们。

请向 GitHub Issue Tracker 报告错误。

版权

此项目受 MIT 许可证 许可。