VS Code設定と、プラグイン、コンテナ設定のメモ

はじめに

VS Code、プラグインやコンテナの制御など、もはや開発には必須のツールになってきました。

筆者は長年のEmacsユーザーなのですが、VS Codeの利用頻度が日々増えてきています。

そこで、設定関連の整理として文書にまとめたいと思い、記載しました。

この文書でわかること

設定ファイル、プラグインのインストールフォルダが分かるようになります。

開発チームで共通的利用したいプラグインはどこに記載すればよいかわかります。

設定の保存場所

• ユーザ設定 (User Settings)

  自分の PC 全体に適用されます。

  Windowsだと

  %APPDATA%\Code\User\settings.json

  Linux/macOS だと

  ~/.config/Code/User/settings.json

• ワークスペース設定 (Workspace Settings)

  プロジェクトごとに適用されます。

  プロジェクトの .vscode/settings.json に保存されます。

拡張機能(プラグイン)の保存場所

各々、以下の場所に保存されます。開発チームで作業する場合は拡張プラグインの種類やバージョンを一致させるには、コンテナの中にインストールするのがベストだと思います。

ローカル環境の場合

• Windows:

  %USERPROFILE%\.vscode\extensions

• Linux/macOS:

  ~/.vscode/extensions

Remote - Containers (Dev Containers) / Remote - SSH の場合

• コンテナやリモート環境に「別途」インストールされます。

  コンテナ内には、必要な拡張機能が再インストールされて /root/.vscode-server/extensions に保存されます。

• コンテナをVS Codeから使う場合 Dev Containerを使います。

  この場合、ローカルには「Remote Development」拡張機能が入ります。

具体的な設定ファイル

上記を踏まえて、複数人で共同作業する場合の設定すべきファイルを以下に記載します。

• 設定ファイル settings.json

  プロジェクトの .vscode/settings.json に設定します。

• ローカルに入れるべきプラグイン (例Dev Containers)

  プロジェクトの .vscode/extensions.json 内の recommendations に記載します。

  記述例

  {
      "recommendations": [
          "ms-vscode-remote.remote-containers"
      ]    
  }

  extensions.json内のrecommendationsではプラグインのお勧め指定なので、VS Codeを開いたときに右下へお勧め表示がなされる形になります。

  インストールの強制はできませんので、共同作業の際にはお勧めをインストールするよう周知しておく必要があると思います。

• コンテナに入れるべきプラグイン

  プロジェクトの.devcontainer/devcontainer.json に設定します。

  {
    "name": "my-app",
    "dockerComposeFile": "docker-compose.yml",
    "service": "app",             // ← compose のサービス名
    "workspaceFolder": "/workspace", // ← コンテナ内で開くパス（必要に応じて）
    "overrideCommand": false,        // compose の command を尊重したいとき
    "customizations": {
      "vscode": {
        "extensions": [
          "DEVSENSE.phptools-vscode"
        ],
      }
    }
  }

おわりに

いかがだったでしょうか。VS Codeは自由度が高く把握は大変ですが、得られる生産効率は凄まじいものがあります。

一緒に使いこなしていきましょう。