README

本仓库提供了一个基础配置，用于friendsofphp/php-cs-fixer，我们用它来验证和强制执行Cartalyst编写PHP代码的单一代码标准。

安装

运行以下命令

composer require --dev cartalyst/php-cs-fixer-config

使用方法

现在包已安装，请在项目的根目录创建一个名为.php_cs或.php_cs.php的配置文件，内容如下

<?php

// Create a new CS Fixer Finder instance
$finder = PhpCsFixer\Finder::create()->in(__DIR__);

return Cartalyst\PhpCsFixer\Config::create()
    ->setFinder($finder)
;

忽略文件和/或目录

在某些情况下，您可能希望忽略某些文件或目录，以便不进行代码审查。

幸运的是，这很简单，您只需对CS Fixer Finder实例进行一些调用即可：）

以下是一个简单的示例，其中我们忽略了文件和目录

<?php

// Directories to not scan
$excludeDirs = [
    'vendor/',
];

// Files to not scan
$excludeFiles = [
    'config/app.php',
];

// Create a new CS Fixer Finder instance
$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__)
    ->exclude($excludeDirs)
    ->ignoreDotFiles(true)
    ->ignoreVCS(true)
    ->filter(function (\SplFileInfo $file) use ($excludeFiles) {
        return ! in_array($file->getRelativePathName(), $excludeFiles);
    })
;

return Cartalyst\PhpCsFixer\Config::create()->setFinder($finder);

强制执行PHPUnit测试的编码标准

如果您想同时启用测试的编码标准，您可以在Config类上调用withPHPUnitRules()方法，如下所示

<?php

// Create a new CS Fixer Finder instance
$finder = PhpCsFixer\Finder::create()->in(__DIR__);

return Cartalyst\PHPCsFixer\Config::create()
    ->setFinder($finder)
    ->withPHPUnitRules()
;

贡献

感谢您对PHP CS Fixer Config的兴趣。以下是一些贡献方式。

• 查看我们的贡献指南
• 查看我们的行为准则

安全性

如果您发现任何与安全相关的问题，请通过[email protected]发送电子邮件，而不是使用问题跟踪器。

许可证

PHP CS Fixer Config遵循BSD 3-Clause许可证。请参阅许可证文件以获取更多信息。