PHP CS Fixer：规范具名参数冒号后的空格

在 php 8 及更高版本中，具名参数（named arguments）的引入极大地提升了代码的可读性和灵活性。然而，在团队协作或大型项目中，具名参数冒号后的空格格式可能因个人习惯而异，导致代码风格不一致。例如，有些开发者可能倾向于 key:'value'，而另一些则偏爱 key: 'value'。为了维护统一的代码风格，我们可以借助 php cs fixer 来自动化这一规范。

规范具名参数冒号后空格

PHP CS Fixer 提供了 single_space_after_construct 规则，专门用于处理语言结构后单一空格的规范。该规则包含一个名为 named_argument 的选项，专门针对具名参数的冒号后空格进行处理。

规则名称： single_space_after_construct相关选项： named_argument (默认值为 true)

当此规则及其 named_argument 选项被启用时，PHP CS Fixer 会自动检测并修正具名参数中冒号后的空格，确保其后仅存在一个空格。

示例与配置

假设我们有以下不符合规范的代码：

立即学习“PHP免费学习笔记（深入）”；

<?php

function my_function(string $param1, array $param2): void
{
    // ...
}

my_function(
    param1:'hello',
    param2:$dataArray,
);

array_key_exists(
    key:'test',
    array:$array,
);

我们期望通过 PHP CS Fixer 将其格式化为：

<?php

function my_function(string $param1, array $param2): void
{
    // ...
}

my_function(
    param1: 'hello',
    param2: $dataArray,
);

array_key_exists(
    key: 'test',
    array: $array,
);

要实现这一目标，您需要在 PHP CS Fixer 的配置文件（通常是 .php-cs-fixer.dist.php 或 .php-cs-fixer.php）中启用 single_space_after_construct 规则。

NameGPT名称生成器

免费AI公司名称生成器，AI在线生成企业名称，注册公司名称起名大全。

0

查看详情

配置示例：

由于 named_argument 选项在 single_space_after_construct 规则中默认是启用的，因此最简单的配置方式是直接启用该规则：

<?php

declare(strict_types=1);

$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__);

return (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true, // 假设您使用了 PSR12 规则集
        'single_space_after_construct' => true, // 启用该规则
    ])
    ->setFinder($finder);

如果您希望明确指定 named_argument 选项，或者该规则的默认行为在未来版本中发生变化，您也可以这样配置：

<?php

declare(strict_types=1);

$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__);

return (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true,
        'single_space_after_construct' => [
            'constructs' => ['named_argument'], // 明确指定只处理具名参数
        ],
        // 或者更全面的配置，包含其他语言结构
        // 'single_space_after_construct' => [
        //     'constructs' => ['array_cast', 'yield_from', 'named_argument'],
        // ],
    ])
    ->setFinder($finder);

在上述配置中，'constructs' => ['named_argument'] 明确指示 PHP CS Fixer 只对具名参数的冒号后空格进行处理。如果省略 constructs 数组，并简单地将 single_space_after_construct 设置为 true，则会使用该规则的所有默认启用选项，其中就包括 named_argument。

注意事项

• PHP 版本要求： 具名参数是 PHP 8.0 及以上版本引入的特性。确保您的项目运行在兼容的 PHP 版本上。
• 规则默认行为： single_space_after_construct 规则的 named_argument 选项默认是启用的。这意味着，如果您只是简单地将 single_space_after_construct 设置为 true，它就会自动处理具名参数的空格问题。
• 其他语言结构： single_space_after_construct 规则还可以处理其他语言结构（如 array_cast、yield_from 等）后的空格。如果您只关心具名参数，可以使用 constructs 选项进行精确控制。
• 运行 PHP CS Fixer： 配置完成后，请在您的项目根目录运行 php-cs-fixer fix 命令来应用这些规则。

总结

通过配置 PHP CS Fixer 的 single_space_after_construct 规则，您可以轻松自动化具名参数冒号后空格的格式化，从而确保项目代码风格的统一性和可读性。这不仅有助于提高开发效率，减少代码审查中的格式问题，还能促进团队成员之间更顺畅的协作。定期运行代码风格检查工具是维护高质量代码库的关键实践之一。

以上就是PHP CS Fixer：规范具名参数冒号后的空格的详细内容，更多请关注php中文网其它相关文章！