README

这是一个使用 Drupal 的 Coder 项目的规则集的 PHP Coder Sniffer，旨在缓解在源代码注释等地方使用日语时出现的警告。

使用方法

以下解释了使用 Composer 进行常规全局安装的方法。

使用 Composer 安装此包。PHP Code Sniffer 和 Drupal Coder 模块也是依赖项，因此会自动安装。

$ composer global require studioumi/phpcs-japanese-drupal

如果是第一次使用 Composer 进行全局安装，请确保将 ~/.composer/vendor/bin 目录添加到路径中。

设置 PHP Code Sniffer 以安装 Coder 和此项目的规则集的安装路径。

$ phpcs --config-set installed_paths $HOME/.composer/vendor/drupal/coder/coder_sniffer,$HOME/.composer/vendor/studioumi/phpcs-japanese-drupal

确认已安装的标准的列表。如果存在 Drupal 和 JapaneseDrupal 的名称，则表示一切正常。

$ phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend, Drupal, DrupalPractice and JapaneseDrupal

以上步骤完成后，JapaneseDrupal 的标准即可使用。以下是一些基本使用示例。

$ phpcs --standard=JapaneseDrupal /PATH

将默认规则集设置为 JapaneseDrupal 后，可以省略 --standard=JapaneseDrupal 选项。请根据您的喜好进行设置。

$ phpcs --config-set default_standard JapaneseDrupal