PHPStorm によるコード フォーマットの自動実行の詳細な図による説明

日々の開発において、コードスタイルの統一にはPHP CS Fixerが欠かせませんが、PHP CS FixerはESLintと違い、保存時にPHPStorm上で自動実行することができます。

PHPStorm には PHP CS Fixer を実行するオプションが用意されておらず、「コードの再フォーマット」ではほとんどの場合ニーズを満たすことができません。

---

このためには、PHPStorm に「ファイル ウォッチャー」を追加して、コードのフォーマットを自動的に実行する必要があります。

1. まず、PHP CS Fixer をグローバルにインストールします

composer global require friendsofphp/php-cs-fixer

2.

php-cs-fixer

を実行します。プロンプト コマンドが表示されれば、インストールが成功したことを意味します。が見つからない場合は、グローバル Composer ベンダー ディレクトリをグローバル変数に追加する必要があります。私は zsh を使用しているので、ここで独自のディレクトリに変更します。

echo 'export PATH="$HOME/.composer/vendor/bin:$PATH"' >> ~/.zshrc

3. PHPStorm を開き、カスタム ファイル

プログラム ファイル アドレスを追加し、コマンド ラインを入力して、

which php-cs-fixer

を入力します。

パラメータ列:

fix $FileDir$/$FileName$

以上です。これで、保存するたびに php-cs-fixer が自動的に実行されます。ここで、別の問題が発生します。すべてのプロジェクトに問題がある可能性があります。異なる .php-cs.dist 形式の設定ファイルです。上記の設定では、グローバル php-cs-fixer 設定ファイルが使用されています。別の設定ファイルを使用したい場合は、次のように設定を変更する必要があります。

fix --config=$ProjectFileDir$/.php-cs.dist $FileDir$/$FileName$

.php-cs.dist は通常、プロジェクトのルート ディレクトリに配置されます。

最後に添付された .php-cs.dist 設定ファイル

<?php $header = <<<&#39;EOF&#39;EOF;$finder =  PhpCsFixer\Finder::create()
            ->exclude('tests/Fixtures')   //排除文件
            ->in(__DIR__);return PhpCsFixer\Config::create()
    ->setRiskyAllowed(true)
    ->setRules([
        '@PSR2'                                 => true,
        '@Symfony:risky'                        => true,
        'array_syntax'                          => ['syntax' => 'short'],
        'combine_consecutive_unsets'            => true,   //多个unset，合并成一个
        // one should use PHPUnit methods to set up expected exception instead of annotations
        'general_phpdoc_annotation_remove'      => ['expectedException', 'expectedExceptionMessage', 'expectedExceptionMessageRegExp'], //phpdocs中应该省略已经配置的注释
        //'header_comment'                        => array('header' => $header), //添加，替换或者删除 header 注释。
        'heredoc_to_nowdoc'                     => true,     //删除配置中多余的空行和/或者空行。
        'no_extra_consecutive_blank_lines'      => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
        'no_unreachable_default_argument_value' => false, //在函数参数中，不能有默认值在非缺省值之前的参数。有风险
        'no_useless_else'                       => true,  //删除无用的eles
        'no_useless_return'                     => true,  //删除函数末尾无用的return
        'no_empty_phpdoc'                       => true,  // 删除空注释
        'no_empty_statement'                    => true,  //删除多余的分号
        'no_leading_namespace_whitespace'       => true,  //删除namespace声明行包含前导空格
        'no_spaces_inside_parenthesis'          => true,  //删除括号后内两端的空格
        'no_trailing_whitespace'                => true,  //删除非空白行末尾的空白
        'no_unused_imports'                     => true,  //删除未使用的use语句
        'no_whitespace_before_comma_in_array'   => true,  //删除数组声明中，每个逗号前的空格
        'no_whitespace_in_blank_line'           => true,  //删除空白行末尾的空白
        'ordered_class_elements'                => false, //class elements排序
        'ordered_imports'                       => false, // use 排序
        'phpdoc_add_missing_param_annotation'   => true,   //添加缺少的 Phpdoc @param参数
        'phpdoc_trim'                           => true,
        //   'phpdoc_trim_consecutive_blank_line_separation' => true, //删除在摘要之后和PHPDoc中的描述之后，多余的空行。
        'phpdoc_order'                          => true,
        'psr4'                                  => true,
        // 'strict_comparison'                     => true,   //严格比较,会修改代码有风险
        //'strict_param'                          => true,
        'ternary_operator_spaces'               => true,  //标准化三元运算的格式
        'ternary_to_null_coalescing'            => true,  //尽可能使用null合并运算符??。需要PHP> = 7.0。
        'whitespace_after_comma_in_array'       => true, // 在数组声明中，每个逗号后必须有一个空格
        'trim_array_spaces'                     => true,  //删除数组首或尾随单行空格
        'align_multiline_comment'               => [                   //每行多行 DocComments 必须有一个星号（PSR-5），并且必须与第一行对齐。
            'comment_type' => 'phpdocs_only'
        ],
        'array_indentation'                 => true,  //数组的每个元素必须缩进一次
    ])
    ->setFinder($finder);

推奨学習: 「PHPstorm の使い方チュートリアル 」

以上がPHPStorm によるコード フォーマットの自動実行の詳細な図による説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。