A ‘workspace’ in Visual Studio Code

visual-studio-code

For example, Visual Studio Code talks about applying settings at the user level vs the workspace level.

On the one hand,

  • it could refer to a project directory that you have opened; or
  • it could refer to everything you have opened in a particular window.

The page referenced above says

"Workspace: These settings are stored inside your workspace
in a .vscode folder and only apply when the workspace is opened."

Best Solution

What is a workspace?

A project that consists of one or more root folders, along with all of the Visual Studio Code configurations that belong to that project. These configurations include:

Why is a workspace so confusing?

Visual Studio Code does not use the term consistently across the UI (I've opened a GitHub issue to address this). Sometimes it refers to a workspace as described above, and other times it refers to a workspace as a project that is specifically associated with a .code-workspace file.

A good example being the recent files widget. Notice in the linked screenshot that all projects are grouped under the same "workspaces" heading, which would indicate that everything there is a workspace. But then projects with a .code-workspace file are given a "Workspace" suffix, contradicting the heading and indicating that only those files are actually workspaces.

What is a .code-workspace file?

It is a JSON file with comments that stores all of the configuration data mentioned above, in addition to the location of all root folders belonging to a workspace.

Do I need a .code-workspace file?

Only if you're creating a multi-root workspace, in which case you'll have a single .code-workspace file that automatically restores all of the workspace settings, in addition to all of the root folders that you want to be displayed in the Explorer.

What about single folder projects?

Everything is automated.

When you open a folder in Visual Studio Code and start making modifications to the editor that are specifically related to the project you're currently working on, Visual Studio Code automatically creates a .vscode folder and stores it in the root of the project folder that you're working on. This .vscode folder has files that store the changes you made.

For example, if you change Visual Studio Code settings that you want to apply only to your current project, Visual Studio Code creates a settings.json file with those updates, and that file is stored in the .vscode folder.

You can create a .code-workspace file that includes just a single root folder if you really want to. You'd then be able to either open the project folder directly, or open the workspace file. But I can't think of any reason why this would be beneficial.

How do I create a .code-workspace file?

Go to menu FileSave Workspace As...

How do I add root folders to a workspace?

Go to menu FileAdd Folder to Workspace....

How do I open a workspace that is defined by a .code-workspace file?

Go to menu FileOpen Workspace....

Alternatively, double click the .code-workspace file. Visual Studio Code won't open the actual file. Instead, it will read that file and open the folders that belong to that workspace.

How do I view the actual .code-workspace file?

Go to menu FileOpen... and select the target .code-workspace file.

Alternatively, open the workspace associated with that file. Then open the command palette, search for, and select the Workspaces: Open Workspace Configuration File command.