distortedfusion/php-cs-fixer-config

我们在包中使用的共享 php-cs-fixer 配置。

维护者

详细信息

github.com/distortedfusion/php-cs-fixer-config

源代码

问题

安装数: 12,534

依赖者: 5

建议者: 0

安全性: 0

星标: 1

关注者: 2

分支: 0

公开问题: 0

2.1.2 2022-11-01 16:43 UTC

Requires

MIT 3e18a305eafe273105d39113a75147a38fb79566

configdistortedfusionphp-cs-fixer

This package is auto-updated.

Last update: 2024-08-29 05:37:08 UTC

README

Latest Version Software License Build Status

这是一个我们在包中使用的 FriendsOfPHP/PHP-CS-Fixer 配置。

安装

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

使用方法

在项目的根目录中创建一个 .php_cs.dist 配置文件。

<?php

$config = new DistortedFusion\PhpCsFixerConfig\Config();
$config->getFinder()
    ->in(__DIR__ . "/src")
    ->in(__DIR__ . "/tests");

return $config;

添加或覆盖规则

向 Config 对象构造函数中添加规则数组允许您添加或覆盖规则

<?php

$config = new DistortedFusion\PhpCsFixerConfig\Config([
    'psr0' => false,
    'psr4' => false,
]);
$config->getFinder()
    ->in(__DIR__ . "/src")
    ->in(__DIR__ . "/tests");

return $config;

Composer 脚本

添加 composer 脚本可以轻松添加测试和修复代码样式的别名。

请注意： 默认情况下，该配置包含有风险的规则，这需要使用 --allow-risky=yes。如果您不想运行有风险的规则，可以在 .php-cs.dist 配置中排除它们。

{
    ...
    "scripts": {
        "phpcs-fix" : "php-cs-fixer fix --using-cache=no --allow-risky=yes --ansi",
        "phpcs": "php-cs-fixer fix -v --diff --dry-run --allow-risky=yes --ansi",
        "test": [
            "@phpcs"
        ]
    },
    "scripts-descriptions": {
        "phpcs": "Runs coding style test suite",
        "test": "Runs all tests"
    }
}

测试

要运行测试，请从项目文件夹运行以下命令

$ composer test

安全性

如果您在此包中发现安全漏洞，请通过 kevin@distortedfusion.com 向 Kevin Dierkx 发送电子邮件。所有安全漏洞都将得到及时处理。

贡献

欢迎贡献，并将获得 全面认可。有关详细信息，请参阅 CONTRIBUTING。

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。