codeclimate phpcodesniffer

コード気候PHP_CODESNIFFERエンジン

codeclimate-phpcodesnifferは、PHP_CODE Sniffer静的分析ツールをラップするコード気候エンジンです。 Code Climate CLIを使用して、またはホストされている分析プラットフォームを使用して、コマンドラインで実行できます。

PHP_CODESNIFFERは、定義されたコーディング標準の違反を検出するのに役立ちます。

インストール

1. まだ行っていない場合は、Code Climate CLIをインストールしてください。
2. codeclimate engines:enable phpcodesniffer 。このコマンドは、エンジンをインストールし、 .codeclimate.ymlファイルでエンジンをインストールします。
3. 分析する準備ができました！プロジェクトのフォルダーを参照して、 codeclimate analyzeを実行します。

構成オプション

php_codesnifferドキュメントに従って、これらの構成オプションの値をフォーマットします。

• file_extensions-これは、php_codesnifferを分析するファイルのファイル拡張子を構成できる場所です。
• 標準 - これは、ファイルの分析中にPHP_CodesNifferを使用したい標準のコンマ区分リストです。オプションで、カスタムPHPCSルールセットファイルへの相対パスを含めることができます。
• Ingrore_Warnings-警告を非表示にすることができ、このオプションでのみエラーを報告できます。
• エンコーディング - デフォルトでは、PHPCSはISO-8859-1を使用します。これを使用して、UTF-8などのエンコードに変更します。

サンプル構成

 exclude_paths:
 - "/examples/**/*"
engines:
  phpcodesniffer:
    enabled: true
    config:
      file_extensions: "php,inc,lib"
      standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
      ignore_warnings: true
      encoding: utf-8
ratings:
  paths:
  - "**.php"

サポートされているコーディング基準

PHP_CODESNIFFERでデフォルトで提供される標準に加えて、Drupal、WordPress、Yii2、およびMagento Extensionコーディング標準がサポートされています。これが完全なリストです：

• Drupal
• Drupalpractice
• meqp1
• meqp2
• マイソース
• 梨
• phpcs
• PSR1
• PSR2
• スクイズ
• WordPress
• WordPress-Core
• WordPress-Docs
• WordPress-Extra
• WordPress-VIP
• yii2
• zend

助けが必要ですか？

php_codesnifferのヘルプについては、ドキュメントをご覧ください。

コードの気候問題に遭遇した場合は、最初にこのプロジェクトのGitHubの問題を見てください。質問はすでにカバーされている可能性があります。そうでない場合は、先に進んでサポートチケットを開いてください。