README

一套基于 Symphony (PRS12, PSR2) PHP 编码标准的共享 PHP 风格，用于 PHP-CS-Fixer。

安装

通过 Composer

composer require binary-cats/laravel-php-styles --dev

它将把包添加到你的 composer.json 文件的 require-dev 块中。

你也可以手动添加，如下，以获取最新版本

    "require-dev": {
        "binary-cats/laravel-php-styles": "^2.0"
    },

Laravel

你可以使用以下命令发布占位符文件

php artisan vendor:publish --provider=BinaryCats\\PhpStyles\\PhpStyleServiceProvider

你还应该将 .php-cs-fixer.cache 添加到你的 .gitignore 文件中。

配置

该包提供了当前的 规则 集合。

return [
    '@Symfony' => true,
    'AdamWojs/phpdoc_force_fqcn_fixer' => true,
    'concat_space' => ['spacing' => 'one'],
    'new_with_braces' => true,
    'no_superfluous_phpdoc_tags' => false,
    'not_operator_with_successor_space' => true,
    'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
    'phpdoc_separation' => false,
];

集成

PHP-CS-Fixer 预期你的 默认 配置将位于 /.php-cs-fixer.dist.php 文件中。

<?php

$finder = PhpCsFixer\Finder::create()->in([
    __DIR__.'/app',
    __DIR__.'/config',
    __DIR__.'/database',
    __DIR__.'/routes',
    __DIR__.'/tests',
]);

return BinaryCats\PhpStyles\styles($finder);

使用方法

现在你可以这样运行修复命令

./vendor/bin/php-cs-fixer fix

如果你想边执行边查看进度

./vendor/bin/php-cs-fixer fix --verbose --show-progress=dots

如果你想将它添加到 composer 别名，你可以在你的 composer.json 中添加以下内容

    ...
    "scripts": {
        "style": "./vendor/bin/php-cs-fixer fix"
    }

高级使用

如果你想更改规则、禁用或添加自己的规则，只需简单地更新项目根目录下的 .php-cs-fixer.dist.php

...
return BinaryCats\PhpStyles\styles($finder, [
    // Do not wrap concat . with spaces
    'concat_space' => ['spacing' => 'none'],
]);

如果你想添加更多自定义修复器，有一个第三个参数

...
return BinaryCats\PhpStyles\styles($finder, [
    // turn the force FQCN fixer off
    'AdamWojs/phpdoc_force_fqcn_fixer' => false,
], [
    new \AdamWojs\PhpCsFixerPhpdocForceFQCN\Fixer\Phpdoc\ForceFQCNFixer,
]);

变更日志

请参阅 CHANGELOG 以获取最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 和 CODE_OF_CONDUCT 以获取详细信息。

安全

如果你发现任何与安全相关的问题，请通过电子邮件 info@binarycats.io 而不是使用问题跟踪器来报告。

鸣谢

• Cyrill N Kalita
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 以获取更多信息。