PHP_CodeSniffer(phpcs) のチェックを一部無効にする

  • 4
    いいね
  • 0
    コメント
この記事は最終更新日から1年以上が経過しています。

どうしても、チェックを無視したい箇所がある場合は下記の方法でチェックを無効にできる。

Advanced Usage · squizlabs/PHP_CodeSniffer Wiki

このドキュメントの通りです。

ファイルの一部を無視する場合

無視したい範囲を @codingStandardsIgnoreStart@codingStandardsIgnoreEnd で囲う

// @codingStandardsIgnoreStart
$xmlPackage['error_code'] = get_default_error_code_value();
// @codingStandardsIgnoreEnd

ファイルまるごと無視する場合

ファイルの先頭に @codingStandardsIgnoreFile をコメントで入れる

<?php
// @codingStandardsIgnoreFile
$xmlPackage = new XMLPackage;
$xmlPackage['error_code'] = get_default_error_code_value();
$xmlPackage->send();

フォルダまるごと無視する場合

$ phpcs --ignore=*/tests/*,*/data/* /path/to/code