Variables reference

Visual Studio Code supports variable substitution inDebugging andTask configuration files, and for some select settings. Variable substitution is supported inside some key and value strings inlaunch.json andtasks.json files by using the${variableName} syntax.

Predefined variables

The following predefined variables are supported:

Predefined variables example

Suppose that you have the following conditions:

1. A file located at/home/your-username/your-project/folder/file.ext opened in your editor;
2. The directory/home/your-username/your-project opened as your root workspace.

This leads to the following values for each of the variables:

• ${userHome}:/home/your-username
• ${workspaceFolder}:/home/your-username/your-project
• ${workspaceFolderBasename}:your-project
• ${file}:/home/your-username/your-project/folder/file.ext
• ${fileWorkspaceFolder}:/home/your-username/your-project
• ${relativeFile}:folder/file.ext
• ${relativeFileDirname}:folder
• ${fileBasename}:file.ext
• ${fileBasenameNoExtension}:file
• ${fileExtname}:.ext
• ${fileDirname}:/home/your-username/your-project/folder
• ${fileDirnameBasename}:folder
• ${lineNumber}: line number of the cursor
• ${columnNumber}: column number of the cursor
• ${selectedText}: text selected in your code editor
• ${execPath}: location of Code.exe
• ${pathSeparator}:/ on macOS or linux,\ on Windows

Variables scoped per workspace folder

By appending the root folder's name to a variable (separated by a colon), it is possible to reach into sibling root folders of a workspace. Without the root folder name, the variable is scoped to the same folder where it is used.

For example, in a multi root workspace with foldersServer andClient, a${workspaceFolder:Client} refers to the path of theClient root.

Environment variables

You can reference environment variables with the${env:Name} syntax. For example,${env:USERNAME} references theUSERNAME environment variable.

{  "type":"node",  "request":"launch",  "name":"Launch Program",  "program":"${workspaceFolder}/app.js",  "cwd":"${workspaceFolder}",  "args": ["${env:USERNAME}"]}

Configuration variables

To reference VS Code settings (configurations), use the${config:Name} syntax. For example,${config:editor.fontSize} references theeditor.fontSize setting.

Command variables

You can use any VS Code command as a variable with the${command:commandID} syntax.

A command variable is replaced with the (string) result from the command evaluation. The implementation of a command can range from a simple calculation with no UI, to some sophisticated functionality based on the UI features available via VS Code's extension API. If the command returns anything other than a string, then the variable replacement will not complete. Command variablesmust return a string.

An example of this functionality is in VS Code's Node.js debugger extension, which provides an interactive commandextension.pickNodeProcess for selecting a single process from the list of all running Node.js processes. The command returns the process ID of the selected process. This makes it possible to use theextension.pickNodeProcess command in anAttach by Process ID launch configuration in the following way:

{  "configurations": [    {      "type":"node",      "request":"attach",      "name":"Attach by Process ID",      "processId":"${command:extension.pickNodeProcess}"    }  ]}

When using a command variable in alaunch.json configuration, the enclosinglaunch.json configuration is passed as an object to the command via an argument. This enables commands to know the context and parameters of the specificlaunch.json configuration when they are called.

Input variables

Command variables are already powerful but they lack a mechanism to configure the command being run for a specific use case. For example, it is not possible to pass aprompt message or adefault value to a generic "user input prompt".

This limitation is solved withinput variables, which have the syntax${input:variableID}. ThevariableID refers to entries in theinputs section oflaunch.json andtasks.json, where additional configuration attributes are specified. Nesting of input variables is not supported.

The following example shows the overall structure of atasks.json that makes use of input variables:

{  "version":"2.0.0",  "tasks": [    {      "label":"task name",      "command":"${input:variableID}"      // ...    }  ],  "inputs": [    {      "id":"variableID",      "type":"type of input variable"      // type specific configuration attributes    }  ]}

Currently VS Code supports three types of input variables:

• promptString: shows an input box to get a string from the user.
• pickString: shows a Quick Pick dropdown to let the user select from several options.
• command: runs an arbitrary command.

Each type requires additional configuration attributes:

promptString:

• description: shown in the quick input, provides context for the input.
• default: default value that will be used if the user doesn't enter something else.
• password: set to true to input with a password prompt that will not show the typed value.

pickString:

• description: shown in the quick pick, provides context for the input.
• options: an array of options for the user to pick from.
• default: default value that will be used if the user doesn't enter something else. It must be one of the option values.

An option can be a string value or an object with both a label and value. The dropdown will displaylabel: value.

command:

• command: runs a command on variable interpolation.
• args: optional option bag passed to the command's implementation.

Below is an example of atasks.json that illustrates the use ofinputs using Angular CLI:

{  "version":"2.0.0",  "tasks": [    {      "label":"ng g",      "type":"shell",      "command":"ng",      "args": ["g","${input:componentType}","${input:componentName}"]    }  ],  "inputs": [    {      "type":"pickString",      "id":"componentType",      "description":"What type of component do you want to create?",      "options": [        "component",        "directive",        "pipe",        "service",        "class",        "guard",        "interface",        "enum"      ],      "default":"component"    },    {      "type":"promptString",      "id":"componentName",      "description":"Name your component.",      "default":"my-new-component"    }  ]}

Running the example:

The following example shows how to use a user input variable of typecommand in a debug configuration that lets the user pick a test case from a list of all test cases found in a specific folder. It is assumed that some extension provides anextension.mochaSupport.testPicker command that locates all test cases in a configurable location and shows a picker UI to pick one of them. The arguments for a command input are defined by the command itself.

{  "configurations": [    {      "type":"node",      "request":"launch",      "name":"Run specific test",      "program":"${workspaceFolder}/${input:pickTest}"    }  ],  "inputs": [    {      "id":"pickTest",      "type":"command",      "command":"extension.mochaSupport.testPicker",      "args": {        "testFolder":"/out/tests"      }    }  ]}

Command inputs can also be used with tasks. In this example, the built-in Terminate Task command is used. It can accept an argument to terminate all tasks.

{  "version":"2.0.0",  "tasks": [    {      "label":"Terminate All Tasks",      "command":"echo ${input:terminate}",      "type":"shell",      "problemMatcher": []    }  ],  "inputs": [    {      "id":"terminate",      "type":"command",      "command":"workbench.action.tasks.terminate",      "args":"terminateAll"    }  ]}

Common questions

Details of variable substitution in a debug configuration or task

Variable substitution in debug configurations or tasks is a two pass process:

• In the first pass, all variables are evaluated to string results. If a variable occurs more than once, it is only evaluated once.
• In the second pass, all variables are substituted with the results from the first pass.

A consequence of this is that the evaluation of a variable (for example, a command-based variable implemented in an extension) hasno access to other substituted variables in the debug configuration or task. It only sees the original variables. This means that variables cannot depend on each other (which ensures isolation and makes substitution robust against evaluation order).

Is variable substitution supported in User and Workspace settings?

The predefined variables are supported in a select number of setting keys insettings.json files such as the terminalcwd,env,shell andshellArgs values. Some settings likewindow.title have their own variables:

  "window.title":"${dirty}${activeEditorShort}${separator}${rootName}${separator}${appName}"

Refer to the comments in the Settings editor (⌘, (Windows, LinuxCtrl+,)) to learn about setting-specific variables.

Why isn't ${workspaceRoot} documented?

The variable${workspaceRoot} was deprecated in favor of${workspaceFolder} to better align withMulti-root Workspace support.

Why aren't variables in tasks.json being resolved?

Not all values intasks.json support variable substitution. Specifically, onlycommand,args, andoptions support variable substitution. Input variables in theinputs section will not be resolved as nesting of input variables is not supported.

How can I know a variable's actual value?

One easy way to check a variable's runtime value is to create a VS Codetask to output the variable value to the console. For example, to see the resolved value for${workspaceFolder}, you can create and run (Terminal >Run Task) the following simple 'echo' task intasks.json:

{  "version":"2.0.0",  "tasks": [    {      "label":"echo",      "type":"shell",      "command":"echo ${workspaceFolder}"    }  ]}

Related resources

• Debugging
• Tasks