Reference to Visual Studio code variables (2023)

Visual Studio Code supports variable substitution indebuggingmiHomeworkconfiguration files, as well as some selected settings. Variable substitution within some key-value strings is supported inlaunch.jsonmitasks.jsonfiles using${variablename}syntax.

predefined variables

The following predefined variables are supported:

• ${homeuser}- the path of the user's home folder
• ${workbook}- the path of the open folder in VS Code
• ${workspaceFolderBasename}- the name of the open folder in VS Code without any slashes (/)
• ${file}- the current open file
• ${archive workspace folder}- the workspace folder of the current open file
• ${relative file}- the current file opened relative toworkspacePasta
• ${relativeFileDirname}- the directory name of the current open file relative toworkspacePasta
• ${basefileName}- the base name of the current open file
• ${baseFileNameWithoutExtension}- the base name of the current open file without file extension
• ${archivoExtname}- the extension of the current open file
• ${archivoDirname}- the folder path of the current open file
• ${fileDirNameBaseName}- the folder name of the current open file
• ${cwd}- the current working directory of the task runner at VS Code startup
• ${line number}- the number of the currently selected line in the active file
• ${selected text}- the currently selected text in the active file
• ${ejecRoute}- the path to the running VS Code executable
• ${defaultBuildTask}- the name of the default build task
• ${pathSeparator}- the character used by the operating system to separate components into file paths

Examples of predefined variables

Assuming you have the following requirements:

1. A file located at/home/tu-nombre-de-usuario/tu-proyecto/carpeta/archivo.extopen in your editor;
2. the directory/home/your-user/your-projectopen as your root workspace.

Then you will have the following values ​​for each variable:

• ${homeuser}-/home/your-user
• ${workbook}-/home/your-user/your-project
• ${workspaceFolderBasename}-your project
• ${file}-/home/tu-nombre-de-usuario/tu-proyecto/carpeta/archivo.ext
• ${archive workspace folder}-/home/your-user/your-project
• ${relative file}-folder/file.ext
• ${relativeFileDirname}-pasta
• ${basefileName}-file.ext
• ${baseFileNameWithoutExtension}-Archive
• ${archivoDirname}-/home/your-user/your-project/folder
• ${archivoExtname}-.ext
• ${line number}- cursor line number
• ${selected text}- selected text in your code editor
• ${ejecRoute}- location of code.exe
• ${pathSeparator}-/on macOS or Linux,\no windows

Advice: Use IntelliSense inside string values ​​totasks.jsonmilaunch.jsonfor a full list of predefined variables.

(Video) Navigating your code in VS Code — Symbols, definitions, references, navigation, and more!

Variables at workspace folder scope

By adding the root folder name to a variable (separated by a colon), you can access the sibling root folders of a workspace. Without the root folder name, the variable is limited to the same folder in which it is used.

For example, in a multiroot workspace with foldersservermiClient, and${work folder:client}refers to the wayClientfuente.

environmental variables

You can also reference environment variables via the${environment:Name}syntax (for example,${env:USERNAME}).

{ "writes":"that", "application":"launch", "Name":"Launch Program", "program":"${workspace folder}/app.js", "cwd":"${workbook}", "arg": ["${env:USERNAME}"]}

configuration variables

You can view VS Code's settings ("settings") via${config:Name}syntax (for example,${config:editor.fontSize}).

command variables

If the predefined variables above are not enough, you can use any VS Code command as a variable via the${command:commandID}syntax.

A command variable is replaced by the result (string) of the command evaluation. The implementation of a command can range from a simple computation with no UI to some sophisticated functionality based on the UI functions available through the VS Code extension API. If the command returns anything other than a string, the variable substitution will not complete. command variableshe mustreturn a string.

An example of this functionality is in the VS Code Node.js debugger extension, which provides an interactive commandextension.pickNodeProcessto select a single process from the list of all running Node.js processes. The command returns the ID of the selected process. This makes it possible to use theextension.pickNodeProcesscommand in oneAttach by process IDstart the configuration as follows:

{ "settings": [{ "writes":"that", "application":"to attach", "Name":"Attach by process ID", "process identification":"${command:extension.pickNodeProcess}"}]}

When a command variable is used in alaunch.jsonconfiguration, attachmentlaunch.jsonthe configuration is passed as an object to the command via an argument. This allows the commands to know the context and parameters of thelaunch.jsonconfiguration when they are called.

input variables

Command variables are already powerful, but they lack a mechanism to configure the command that is executed for a specific use case. For example, it is not possible to pass awarning messageof unostandard valueto a generic "user input prompt".

This limitation is solved withinput variablesI have the syntax:${input:variableID}. oID de variablerefers to entries inAppetizerSection fromlaunch.jsonmitasks.json, where additional configuration attributes are specified. Nesting of input variables is not supported.

The following example shows the general structure of atasks.jsonwhich makes use of input variables:

{ "version":"2.0.0", "Chores": [{ "label":"name of the homework", "domain":"${input:variableID}" // ...}], "Appetizer": [{ "I would go":"IDvariable", "writes":"input variable type" // enter specific configuration attributes}]}

VS Code currently supports three types of input variables:

• indicatorchain: Displays an input box to get a string from the user.
• chooseString– Displays a quick select dropdown menu to allow the user to select from multiple options.
• domain: Execute an arbitrary command.

Each type requires additional configuration attributes:

indicatorchain:

• Description: Displayed in quick input, provides context for the input.
• model: Default value to be used if nothing else is entered by the user.
• password: Set to true to enter with a password prompt that will not display the entered value.

chooseString:

• Description: Displayed in the quick select, provides context for the input.
• options: An array of options for the user to choose from.
• model: Default value to be used if nothing else is entered by the user. Must be one of the option values.

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

domain:

• domain: Command in execution in interpolation of variables.
• arguments: Optional bag of options passed to the command implementation.

Below is an example oftasks.jsonwhich illustrates the use ofAppetizerusing the angular CLI:

{ "version":"2.0.0", "Chores": [{ "label":"deg", "writes":"Concha", "domain":"of", "arg": ["gram","${input: component type}","${input: component name}"]}], "Appetizer": [{ "writes":"choose string", "I would go":"component type", "Description":"What type of component do you want to create?", "options": [ "component", "directive", "tube", "Service", "class", "Guardia", "Interface", "enumeration"], "Preset":"component"},{ "writes":"request string", "I would go":"Component name", "Description":"Name your component.", "Preset":"my-new-component"}]}

Running the example:

The following example shows how to use a user input variable of typedomainin a debug configuration that allows the user to choose a test case from a list of all test cases found in a specific folder. Some extension is supposed to provide aextension.mochaSupport.testPickercommand that places all test cases in a configurable location and displays a selection UI to choose one of them. The arguments for a command input are defined by the command itself.

{ "settings": [{ "writes":"that", "application":"launch", "Name":"Run specific test", "program":"${workspace folder}/${input: selection test}"}], "Appetizer": [{ "I would go":"choice test", "writes":"domain", "domain":"extension.mochaSupport.testPicker", "arg": { "test paste":"/output/tests"}}]}

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

{ "version":"2.0.0", "Chores": [{ "label":"Finish all tasks", "domain":"echo ${input: terminate}", "writes":"Concha", "troublesome correspondent": []}], "Appetizer": [{ "I would go":"end up", "writes":"domain", "domain":"workbench.action.tasks.finish", "arg":"finishAll"}]}

common questions

Variable substitution details in a configure or debug task

Replacing variables in configurations or debug tasks is a two-step process:

• In the first step, all variables are evaluated for string results. If a variable appears more than once, it will only be evaluated once.
• In the second pass, all the variables are replaced with the results of the first pass.

One consequence of this is that the evaluation of a variable (for example, a command-based variable implemented in an extension) hasno accessto other overridden variables in the setup or debug task. It only sees the original variables. This means that the variables cannot depend on each other (which guarantees isolation and makes substitution robust with respect to the order of evaluation).

Is variable substitution supported in user and workspace configurations?

Predefined variables are supported in a select number of configuration keys inconfiguration.jsonfiles as terminalcwd,environment,ConchamiShellArgsvalues. SomeDefinitionsCutwindow.titlehave their own variables:

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

View comments in the configuration editor (⌘,(Windows,LinuxCtrl+,)) for how to set specific variables.

Why is ${workspaceRoot} not documented?

The variable${workspace root}was rejected in favor of${workbook}to better align withmultiroot workspaceSupport support.

Why are variables in tasks.json not resolving?

Not all values ​​intasks.jsonsupport for variable substitution. specifically, onlydomain,arguments, mioptionssupport for variable substitution. input variables inAppetizerThe section will not resolve because nesting of input variables is not supported.

How can I know the real value of a variable?

An easy way to check the runtime value of a variable is to create VS Codehomeworkto send the value of the variable to the console. For example, to see the resolved value of${workbook}, you can compile and run (Terminal>run task) the following simple task 'echo' intasks.json:

{ "version":"2.0.0", "Chores": [{ "label":"eco", "writes":"Concha", "domain":"echo ${workbook}"}]}

12/07/2022