README

更多 PHP-CS-Fixer

此存储库包含为 PHP-CS-Fixer 项目的一些附加修复器

• 在文档注释前添加空行
• 在 else 和 elseif 代码块前添加空行
• 在 catch 和 finally 代码块前添加空行

设置

1. 使用 composer 安装包

composer require addiks/more-php-cs-fixers

2. 在 PHP-CS-Fixer 配置中注册修复器（文件 .php_cs）。

<?php

+use Addiks\MorePhpCsFixers\Whitespace\BlankLineBeforeCatchBlockFixer;
+use Addiks\MorePhpCsFixers\Whitespace\BlankLineBeforeElseBlockFixer;
+use Addiks\MorePhpCsFixers\Whitespace\BlankLineBeforeDocCommentFixer;

$config = PhpCsFixer\Config::create();
+$config->registerCustomFixers([
+    new BlankLineBeforeCatchBlockFixer(),
+    new BlankLineBeforeElseBlockFixer(),
+    new BlankLineBeforeDocCommentFixer(),
+]);
+$config->setRules([
+    'Addiks/blank_line_before_catch_block': true,
+    'Addiks/blank_line_before_else_block': true,
+    'Addiks/blank_line_before_doccomment': true,
+]);
return $config;

修复器

Addiks/blank_line_before_catch_block

<?php

try {
    foo();
+
} catch (\Exception $b) {
    bar();
+
} finally {
    baz();
}

Addiks/blank_line_before_else_block

<?php
if ($a) {
    foo();
+
} elseif ($b) {
    bar();
+
} else {
    baz();
}

Addiks/blank_line_before_doccomment

<?php
/** @var string $foo */
$foo = "Lorem ipsum";
+
/** @var string $bar */
$bar = "dolor sit amet";

Addiks/correct_order_in_var_doccomment

<?php
-/** @var $foo string */
+/** @var string $foo */

Addiks/nullable_in_doccomment

<?php
-/** @var ?string $foo */
+/** @var string|null $foo */

Addiks/array_in_doccomment

<?php
-/** @var string[] $foo */
+/** @var array<string> $foo */