Drupal開発で便利なVS Code拡張

Drupal Smart Snippets

フック関数の自動補完を行なってくれる。

phpcsとphpcbf

別記事で解説。

Twig Language 2

Twigファイルのシンタックスハイライトやスニペットを提供する。

PHP DocBlocker

PHPドックブロックの自動補完を提供する。

使用する際には、intやboolなどの省略形を許可する設定を行っておく。

{
  // PHP DocBlocker. see https://www.drupal.org/docs/develop/development-tools/configuring-visual-studio-code#s-php-docblocks
  "php-docblocker.useShortNames": true
}

Composer

composerをVS Codeで操作するためのインターフェースとcomposer.jsonのスキーマ検証を提供する。
システムにComposerがインストールされていることが前提（拡張機能の設定でComposerの実行パスを設定する必要がある）。

{
  // Composer. see https://www.drupal.org/docs/develop/development-tools/configuring-visual-studio-code#s-composer-drupal-8
  "composer.executablePath": "/usr/local/bin/composer"
}

Drupal Syntax Highlighting

*.themeや*.moduleなどDrupal固有のファイルのシンタックスハイライトを提供する。
この拡張機能を入れれば、VS Codeで次のような設定を省略できる。※が、後述のPHP Intelephense拡張を使用する場合は、結局次の設定を行わなければならないので、PHP Intelephense使用者はこの拡張は不必要かも。

{
  "files.associations": {
    "*.inc": "php",
    "*.module": "php",
    "*.install": "php",
    "*.theme": "php",
    "*.profile": "php",
    "*.tpl.php": "php",
    "*.test": "php",
    "*.php": "php",
    "*.info": "ini"
  }
}

PHP Intelephense

PHPのインテリセンス機能を提供する。
この拡張機能を使用する際には、VS Codeでデフォルトで用意されているPHP Language Features拡張( @builtin php で検索すると出てくる)をオフにする。
*.themeや*.moduleなどDrupal固有のファイルでもインテリセンス機能を使用するためにはfiles.associations設定項目を用いてPHPファイルと認識してあげる必要がある。

{
  "files.associations": {
    "*.inc": "php",
    "*.module": "php",
    "*.install": "php",
    "*.theme": "php",
    "*.profile": "php",
    "*.tpl.php": "php",
    "*.test": "php",
    "*.php": "php",
    "*.info": "ini"
  }
}

参考

• https://www.drupal.org/docs/develop/development-tools/configuring-visual-studio-code