All Articles

VSCodeでPHPを書くためのセットアップ

この記事では以下のプラグインが動作するようにセットアップを行う。

動作環境

  • MacBook Pro (13-inch, 2018, Four Thunderbolt 3 Ports)
  • macOS Mojave (10.14.6)
  • Visual Studio Code Version 1.38.1

settings.jsonの開き方

以降の記述では直接設定ファイル(以下settings.json)に編集を行う。 以下の手順でsettings.jsonが開く。

  1. cmd + ,でSettingsを表示
  2. 画像赤枠のアイコンをクリック(エディタ右上)

PHP Intelephense

コード補完のプラグイン。PHP IntelliSenseというプラグインもありますが、こちらのほうがサクサク動くのでおすすめ。

PHPはデフォルトでも補完が有効なので、settings.jsonに以下を追加して補完が重複表示されないようにしておく。

{
  ...
  "php.suggest.basic": false
}

phpcs

コーディングルールをチェックするプラグイン。 phpcsの実行パスとコーディングルールの設定をsettings.jsonに追加する。

{
  ...
  "phpcs.executablePath": "your/phpcs/path",
  "phpcs.standard": "your_phpcs_ruleset.xml"
}

phpcs.standardには以下の項目を設定することも可能。詳細はこちら

  • PEAR
  • PHPCS
  • PSR1
  • PSR2
  • Squiz
  • Zend

PHP Debug

デバッグのプラグイン。Xdebugのインストール方法は本記事では省略。

ローカルで使用するならlaunch.jsonを作成すれば動作するが、dockerやvagrantなどリモートデバッグする場合はpathMappingsの設定が必要。

launch.jsonのセットアップ

  1. cmd + shfit + Dからサイドバーにデバッグウィンドウを表示
  2. 上部の歯車アイコンをクリック
  3. ウィンドウが表示されるので、PHPを選択してファイル作成
  4. このとき.vscodeのディレクトリ直下にファイルが作成されているか確認
  5. 以下のようにlaunch.jsonを編集
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9000,
            "pathMappings": {
                "your/docker_or_vagrant/path":"${workspaceFolder}"
            }
        }
    ]
}

pathMappingsは、キーにリモートのディレクトリ、値を作業ディレクトリを設定する。${workspaceFolder}はVS Codeで定義されている変数で、VS Codeで開いているディレクトリのパスを表す。

${workspaceRoot}という変数も定義されているが、Multi-root Workspacesがサポートされたことにより非推奨となっている。

デバッグ実行の確認

  1. F9で任意の行にブレークポイントを設定
  2. F5でデバッグ開始
  3. 1.で設定したブレークポイントで処理が停止されれば、セットアップ完了!!

あとがき

プラグインを導入することで開発の体験が向上するので、気になったり他の人がオススメしているプラグインはどんどん試してみるのが良いと思う:)

ただしインストールしすぎると重たくはなるので取捨選択は必要。

良いPHP開発を!