VS Code学習当初に「.code-workspace」という拡張子のファイルを見かけて、謎だったので調べた事をメモ書きして置こうと思います。
workspaceとは？
workspaceとは複数のフォルダを一つのwindowで同時に開く機能です。
通常、VSCodeでフォルダを開く際は、一つのルートフォルダを開く構成になっていますが、workspaceを使うと、複数のフォルダを同時に開くことができます。
workspaceを使う利点
①複数フォルダーの管理
「.code-workspace」を使うと、複数のフォルダーを一度に開き、それらを一つのワークスペースで管理できるようになります。プロジェクトA、B、Cなどを一度に開いて、タブで切り替えながら作業が可能です。
②統一的な設定管理
各フォルダーで別々に設定をしていると、管理が大変になるが「.code-workspace」を使えば、ワークスペース単体で統一的に設定を管理できます。
デバッグ構成や拡張機能の設定も一緒に記録しておけば、開いてすぐ同じ環境を構築できます。
③環境の分離
プロジェクトによって別の設定が必要な場合でも「.code-workspace」を使えば、ワークスペースごとに環境を分離して管理できます。
workspaceの使い方
①ワークスペースの作成
- VS Codeで「ファイル」メニューから「フォルダーをワークスペースに追加」を選択。
- 必要なフォルダーを追加。
- 「ワークスペースとして保存」を選択して、「….code-workspace」ファイルを作成。
②ワークスペースを開く
- 「ファイル」メニューから「ワークスペースを開く」を選択
- 「.code-workspace」ファイルを選択。
設定例 (シンプルな.code-workspaceファイル)
{
"folders": [
{ "path": "projectA" },
{ "path": "projectB" }
],
"settings": {
"editor.tabSize": 2,
"files.exclude": {
"**/.git": true
}
}
}”folders” とは？
「folders」は、ワークスペースに含めるフォルダーの一覧を定義するセクションです。この部分で複数のフォルダーを指定し、ワークスペース内で同時に管理できるようになります。「path」プロパティには、それぞれのフォルダーのパスを記述します。これにより、プロジェクトAやBなど、異なるフォルダーを一度に開いて作業ができます。
“settings” とは？
「settings」は、ワークスペース内で使用されるVS Codeの設定を定義するセクションです。この部分で、エディターの挙動やフォーマット方法、拡張機能の有効・無効化などを細かく指定できます。たとえば、「editor.tabSize」はタブのサイズを変更する設定で、「files.exclude」は特定のファイルやフォルダーをエクスプローラーで非表示にするための設定です。
いつworkspaceを使うべき？
- 複数プロジェクトを一緒に管理したい時。
- モノレポ構成のプロジェクトで作業する時。
- プロジェクトごとに異なるVS Code設定が必要な時。
この機能を活用することで、VS Codeでよりスムーズなプロジェクト管理が可能となります。
まとめ
- VS Codeの「.code-workspace」は、ワークスペースの設定を保存するJSON形式のファイル。
- ウィンドウで開いている複数のフォルダをまとめる機能で、複数のルートフォルダーを同時に開くことが可能となる。
