PHP でのコード スタイル チェックに PHP-CS-Fixer を使用する方法

開発プロセス中、適切なコーディング スタイルは、コードの品質と読みやすさを向上させる重要な要素です。現在市場で最も広く使用されているプログラミング言語の 1 つである PHP のコード スタイル検査も特に重要です。ここでは、PHP コードスタイルチェックツール PHP-CS-Fixer を紹介し、コードスタイルチェックを実行する方法を詳しく説明します。

まず第一に、PHP-CS-Fixer とは何かを理解する必要があります。 PHP-CS-Fixer は、Symfony フレームワークによって作成された PHP コード スタイル チェック ツールです。このツールを使用すると、PHP プロジェクトの一貫性と高品質なコーディング スタイルを簡単に維持できるため、コードの可読性と保守性が向上します。

それでは、コード スタイル チェックに PHP-CS-Fixer を使用するにはどうすればよいでしょうか?詳細な手順は次のとおりです。

ステップ 1: PHP-CS-Fixer をインストールする

まず、Composer を使用して PHP-CS-Fixer をインストールする必要があります。 Composer は PHP で最も人気のある依存関係マネージャーであり、PHP 依存関係のインストールと管理に使用できます。

コマンド ラインで次のコマンドを実行して PHP-CS-Fixer をインストールします:

composer require --dev friendsofphp/php-cs-fixer

ステップ 2: PHP-CS-Fixer 構成ファイルを作成します

次に、 PHP-CS-Fixer 構成ファイルを作成する必要があります。この設定ファイルでは、イディオム、インデント、スペース、改行などの詳細と、従う必要があるルールなどを指定します。ルールは、個人またはチームのニーズに基づいて変更または追加できます。

プロジェクトのルート ディレクトリにファイル「.php_cs」を作成し、次のコードをそこに貼り付けます:

<?php

$finder = SymfonyComponentFinderFinder::create()
    ->exclude('vendor')
    ->exclude('node_modules')
    ->exclude('storage')
    ->exclude('public')
    ->in(__DIR__)
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return SymfonyCSConfigConfig::create()
    ->level(SymfonyCSFixerInterface::PSR2_LEVEL)
    ->fixers([
        'array_syntax' => ['syntax' => 'short'],
        'blank_line_after_opening_tag',
        'braces',
        'cast_spaces',
        'class_definition',
        'concat_without_spaces',
        'declare_equal_normalize',
        'function_call_space',
        'function_declaration',
        'indentation',
        'line_after_namespace',
        'linefeed',
        'lowercase_constants',
        'lowercase_keywords',
        'method_argument_space',
        'native_function_casing',
        'new_with_braces',
        'no_blank_lines_after_class_opening',
        'no_empty_phpdoc',
        'no_empty_statement',
        'no_extra_blank_lines',
        'no_leading_import_slash',
        'no_leading_namespace_whitespace',
        'no_mixed_echo_print',
        'no_multiline_whitespace_before_semicolons',
        'no_short_bool_cast',
        'no_spaces_after_function_name',
        'no_spaces_inside_parenthesis',
        'no_trailing_comma_in_list_call',
        'no_trailing_comma_in_singleline_array',
        'no_trailing_whitespace',
        'no_trailing_whitespace_in_comment',
        'no_unneeded_control_parentheses',
        'no_unused_imports',
        'no_whitespace_before_comma_in_array',
        'no_whitespace_in_blank_line',
        'normalize_index_brace',
        'object_operator', 
        'operators_spaces',
        'php_closing_tag',
        'phpdoc_align',
        'phpdoc_no_access',
        'phpdoc_no_empty_return',
        'phpdoc_no_package',
        'phpdoc_scalar',
        'phpdoc_single_line_var_spacing',
        'phpdoc_summary',
        'phpdoc_to_comment',
        'phpdoc_trim',
        'phpdoc_type_to_var',
        'phpdoc_var_without_name',
        'remove_leading_slash_use',
        'remove_lines_between_uses',
        'return',
        'self_accessor',
        'short_array_syntax',
        'single_array_no_trailing_comma',
        'single_blank_line_before_namespace',
        'single_quote',
        'spaces_before_semicolon',
        'spaces_cast',
        'standardize_not_equals',
        'ternary_spaces',
        'trim_array_spaces',
        'unalign_double_arrow',
        'unalign_equals',
        'unary_operators_spaces',
        'unused_use',
    ])
    ->finder($finder);

上記の設定には、次のような一連のルールが含まれています:

• PSR-2 コード スタイル仕様を使用する;
• 無駄なスペースの使用を禁止する;
• 単一ファイル内での複数の名前空間の出現を禁止する;
• 配列の初期化の使用 余分なカンマなど

これらのルールは個人の好みに応じて変更できます。この例では、Symfony フレームワークによって推奨されているいくつかのルールを使用します。

ステップ 3: PHP-CS-Fixer を実行する

最後に、PHP-CS-Fixer を使用して PHP コードをチェックできます。コマンドラインに次のコマンドを入力するだけです:

vendor/bin/php-cs-fixer fix

このコマンドは、プロジェクト全体のすべての PHP ファイルを検索し、その中で使用されている不適切なコード形式を変更します。もちろん、このコマンドは、指定されたルールに従ってコード スタイルをチェックするためにいくつかのパラメーターを受け取ることもできます。例:

vendor/bin/php-cs-fixer fix src/ --rules=@PSR2

上記のコマンドは、「src」フォルダー内のコードの PSR-2 スタイルをチェックします。 。

概要:

PHP-CS-Fixer は、プログラマーがプロジェクト コードの一貫性と読みやすさを維持するのに役立つ、非常に実用的な PHP コード スタイル チェック ツールです。上記で紹介した手順を使用すると、PHP-CS-Fixer を使用してコード スタイル チェックを簡単に実行できるため、コードの品質が向上します。

以上がPHP でのコード スタイル チェックに PHP-CS-Fixer を使用する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。