設定オプション

設定オプション – 設定オプションの一覧

PHP_CodeSniffer の設定オプション

デフォルトのコーディング規約の設定

デフォルトでは、PHP_CodeSniffer は標準のコーディング規約として PEAR コーディング規約を使用します。 コマンドラインで何も指定されなかった場合にこれを使用します。 デフォルトの規約を変更するには、オプション default_standard を設定します。

デフォルトの規約の Zend コーディング規約への変更

     

$ phpcs --config-set default_standard Zend

デフォルトの出力書式の設定

デフォルトでは、コマンドラインで出力書式を指定しなかった場合は PHP_CodeSniffer は 完全版 のレポートを出力します。 デフォルトの出力書式を変更するには、設定オプション report_format を指定します。

デフォルトの出力書式を要約版に設定

     

$ phpcs --config-set report_format summary

警告をデフォルトで隠す

デフォルトでは、PHP_CodeSniffer はコードのエラーと警告の両方を表示します。 特定のスクリプトで警告を表示しないようにするにはコマンドライン引数 -n を実行しますが、 もしお望みならこれをデフォルトの設定にすることもできます。 デフォルトで警告を隠すようにするには、設定オプション show_warnings0 に設定します。

警告をデフォルトで隠す

     

$ phpcs --config-set show_warnings 0
デフォルトで警告を隠す設定にしたときに、特定のスクリプトで警告を表示させるには コマンドライン引数 -w を使用します。

デフォルトのタブ幅の設定

デフォルトでは、PHP_CodeSniffer はチェックするファイルのタブをスペースに変換しません。 タブ幅を指定すると、PHP_CodeSniffer がタブをスペースに置き換えるようになります。 デフォルトでタブからスペースへの置き換えを行うよう PHP_CodeSniffer に指定するには、 設定オプション tab_width を指定します。

デフォルトのタブ幅を 4 に設定する

     

$ phpcs --config-set tab_width 4
タブ幅をデフォルトで設定している際に特定の実行時だけタブからスペースへの置き換えを無効にするには、 タブ幅をゼロに指定します。

タブからスペースへの変換を無効にする

      

$ phpcs --tab-width=0 /path/to/code

Squiz コーディング規約の設定オプション

JavaScript Lint へのパスの設定

Squiz コーディング規約の中には、JavaScript ファイルを JavaScript Lint でチェックする sniff が含まれています。 このツールは、スクリプトを実際に実行したりウェブページを開いたりすることなしに JavaScript ソースコードでよくある間違いを見つけ出すことができるものです。 jsl_path オプションを使用して、 JavaScript Lint sniff にこのツールの場所を教えます。

JavaScript Lint へのパスの設定

     

$ phpcs --config-set jsl_path /path/to/jsl

Zend コーディング規約の設定オプション

Zend Code Analyzer へのパスの設定

Zend コーディング規約の中には、各ファイルを Zend Code Analyzer でチェックする sniff が含まれています。これは Zend Studio に付属するツールです。 zend_ca_path オプションを使用して、 Zend Code Analyzer sniff にこのツールの場所を教えます。

Zend Code Analyzer へのパスの設定

     

$ phpcs --config-set zend_ca_path /path/to/ZendCodeAnalyzer
Report types and options (Previous) 独自の規約を作成するための手引き (Next)
Last updated: Thu, 17 Apr 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.