PHP CodeSniffer を使用するには、PHP のパッケージ管理ソフトウェアである「Composer」をあらかじめインストールしておく必要があります。その他の PHP のパッケージ管理にも使用できます。
https://getcomposer.org/download/
インストールは上記のリンクから行います。
下記を実行
sudo mv composer.phar /usr/local/bin/composer
実行結果が下記の場合でも気にせず次の工程を進めていく
mv: composer.phar: No such file or directory
うまくインストールできたか確認する
composer --version
Composer のバージョン番号が表示されたら成功しているはずです。
コマンド
composer global require "squizlabs/php_codesniffer=*"
以下のコマンドを実行してバージョン情報が出れば正常にインストールされています
.composer/vendor/bin/phpcs --version
PHP CodeSnifferのパスを通す
echo 'export PATH=$HOME/.composer/vendor/bin:$PATH' >> ~/.zshrc
source ~/.zshrc
もしくは、
open ~/.zshrc
コマンドで直接編集
export PATH="$HOME/.composer/vendor/bin:$PATH"
と入力し保存
alias wpcs="phpcs -p -s -v --standard=WordPress"
↑必要か不明
source ~/.zshrc
which phpcs
コマンドでパスを確認
/Users/{ユーザー名}/.composer/vendor/bin/phpcs
以下のコマンドを実行してバージョン情報が表示されたら登録完了です
phpcs --version
インストールコマンド
composer global require wp-coding-standards/wpcs
Warning from https://repo.packagist.org: You are using an outdated version of Composer. Composer 2 is now available and you should upgrade. See https://getcomposer.org/2
composerをアップデートする。
composer dump-autoload --version
もしくは
composer dump-autoload -V
でComposerのバージョンを確認できます。
self-updateを使えば自動で最新のリリースまで上がります
composer self-update
composer dump-autoload -V
でバージョンが上がっていれば成功
コーディング規約がインストールできたら、PHP CodeSnifferで使えるように以下のコマンドで設定をします
phpcs --config-set installed_paths ~/.composer/vendor/wp-coding-standards/wpcs
以下のコマンドを実行し、「WordPress, WordPress-Extra, WordPress-Docs and WordPress-Core」が含まれていれば設定完了です。
phpcs -i
以下の3つは必須。特にlinter-ui-defaultがないとエラー箇所がわからないので注意
macOS Catalina以降は zsh です。
echo $SHELL
// デフォルトシェルを表示する
/usr/local/bin/zsh
// zshの場合
ターミナルの設定ファイルが存在しない場合はシェルに応じた設定ファイルを作成してください。
– bashの場合 .bash_profile
– zshの場合 .zshrc
cd ~
// ホームディレクトリに移動する
ls -a
// カレントディレクトリの情報を表示する
.zshrc または .bash_profile が存在しなければここで表示されません。
それぞれのシェルに応じた設定ファイルを作成しましょう。
open ~/.zshrc
または
open ~/.bash_profile
テキストエディタを選択する場合: open
インストールしたものによってパスは異なります。
export PATH=(パス):$PATH
例)
export PATH=$HOME/.composer/vendor/bin:$PATH
source ~/.bash_profile
または
source ~/.zshrc