phpcsのエラー表示を相対パス指定にする

カテゴリ: Laravel, phpcs, PHPStorm

PHPにはphpcsというコードチェッカがあります。

実行することで問題があるコードをチェックでき、どのファイルに問題があるかが一目でわかります。

$ docker-compose exec app vendor/bin/phpcs
...

FILE: /var/www/html/app/Models/User.php
-------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------
 12 | ERROR | [x] Each imported trait must have its own "use" import statement
-------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------

便利なのですが出力されるパスが絶対パスになり、dockerやvagrantなどの環境で実行しているとパスを相対パスで表示して欲しい場合があります。

phpcsを相対パス指定にする方法

パスを相対パスで表示したい場合は、--basepath=.を指定すると良いです。

$ docker-compose exec app vendor/bin/phpcs  --basepath=.
...

FILE: app/Models/User.php
-------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------
 12 | ERROR | [x] Each imported trait must have its own "use" import statement
-------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------

phpcs.xmlファイルで設定を行なっている場合は、<arg name="basepath" value="." />の定義を追加しても同じです。

<?xml version="1.0"?>
<ruleset>
    <arg name="basepath" value="." />
    ...

PHPStormで指定している場合、相対パスで指定しておくと下記のステップで該当ファイルを素早く開けるので便利です。

  • ターミナルからエラーが出たファイル名をダブルクリックする
  • Cmd+Cでコピー
  • 右シフトを素早く2回押し、Search Everywhereのダイアログを表示
  • Cmd+Vでペースト
  • Enterをクリックすると該当ファイルが開く
Amazonでポイントを賢くGETする方法
Amazonギフト券チャージ で最大2.5%もお得!
こちらもおススメ

コメントを残す

メールアドレスが公開されることはありません。