.CODE-WORKSPACE File Format

VS Code workspace

Introduction

A .code-workspace file describes a multi-root workspace in Visual Studio Code: several folders opened together, and the settings that apply to them as a group. Opening the file opens the workspace. A single-folder project keeps its settings in a .vscode folder instead.

A .code-workspace file dropped on this site opens in the explorer, which lists its folders and settings.

Structure

The file is JSON, and it may hold comments and trailing commas. The top level is an object with these members:

MemberValue
foldersAn array of folder objects: path (relative to the file, or absolute) or uri, and an optional display name.
settingsAn object of settings, as in settings.json.
launchDebug configurations, as in launch.json.
tasksTasks, as in tasks.json.
extensionsRecommended extensions, as in extensions.json.
 
{
  "folders": [
    { "path": "frontend" },
    { "name": "Server", "path": "backend" }
  ],
  "settings": { "editor.tabSize": 2 }
}
A workspace of two folders.

Links

Software

  • Visual Studio Code – Microsoft’s code editor, which makes these files (Windows, macOS, Linux)

Reference