第5章 Visual Studio Code - Open Source ("Code - OSS") の設定
Visual Studio Code - Open Source ("Code - OSS") を設定する方法を学習します。
5.1. 単一ルートおよびマルチルートワークスペースの設定
マルチルートワークスペース機能を使用すると、同じワークスペース内で複数のプロジェクトフォルダーを操作できます。これは、製品ドキュメントや製品コードリポジトリーなど、複数の関連プロジェクトを同時に作業する場合に便利です。
ワークスペースファイルをよりよく理解して作成するには、What is a VS Code "workspace" を参照してください。
ワークスペースは、デフォルトでマルチルートモードで開くように設定されています。
ワークスペースが起動すると、/projects/.code-workspace
ワークスペースファイルが生成されます。ワークスペースファイルには、devfile に記述されているすべてのプロジェクトが含まれます。
{ "folders": [ { "name": "project-1", "path": "/projects/project-1" }, { "name": "project-2", "path": "/projects/project-2" } ] }
ワークスペースファイルがすでに存在する場合は更新され、不足しているプロジェクトはすべて devfile から取得されます。devfile からプロジェクトを削除すると、ワークスペースファイルに残ります。
デフォルトの動作を変更して独自のワークスペースファイルを提供したり、単一ルートワークスペースに切り替えたりできます。
手順
独自のワークスペースファイルを提供します。
.code-workspace
という名前のワークスペースファイルをリポジトリーのルートに配置します。ワークスペースの作成後、Visual Studio Code - Open Source ("Code - OSS") はワークスペースファイルをそのまま使用します。{ "folders": [ { "name": "project-name", "path": "." } ] }
重要ワークスペースファイルを作成するときは注意してください。エラーが発生した場合は、代わりに空の Visual Studio Code - Open Source ("Code - OSS") が開かれます。
重要複数のプロジェクトがある場合、ワークスペースファイルは最初のプロジェクトから取得されます。最初のプロジェクトにワークスペースファイルが存在しない場合は、新しいファイルが作成され、
/projects
ディレクトリーに配置されます。
代替ワークスペースファイルを指定します。
devfile で VSCODE_DEFAULT_WORKSPACE 環境変数を定義し、ワークスペースファイルの適切な場所を指定します。
env: - name: VSCODE_DEFAULT_WORKSPACE value: "/projects/project-name/workspace-file"
ワークスペースをシングルルートモードで開きます。
VSCODE_DEFAULT_WORKSPACE 環境変数を定義し、ルートに設定します。
env: - name: VSCODE_DEFAULT_WORKSPACE value: "/"