Command Variable

Visual Studio Code provides variable substitution to be used in launch.json and tasks.json.

One of the variables allows the result of a command to be used with the following syntax: ${command:commandID}

This extension provides a number of commands that give a result based on the current file or the workspace path

extension.commandvariable.file.relativeDirDots : The directory of the current file relative to the workspace root directory with dots as separator. Can be used to specify a Python module.
extension.commandvariable.file.filePosix : The same result as ${file} but in Posix form. Directory separator '/', and drive designation as '/z/project/'
extension.commandvariable.file.fileDirnamePosix : The same result as ${fileDirname} but in Posix form.
extension.commandvariable.file.fileDirname1Up : The directory path 1 Up of ${fileDirname}
extension.commandvariable.file.fileDirname2Up : The directory path 2 Up of ${fileDirname}
extension.commandvariable.file.fileDirname3Up : The directory path 3 Up of ${fileDirname}
extension.commandvariable.file.fileDirname4Up : The directory path 4 Up of ${fileDirname}
extension.commandvariable.file.fileDirname5Up : The directory path 5 Up of ${fileDirname}
extension.commandvariable.file.fileDirname1UpPosix : The same result as ${extension.commandvariable.file.fileDirname1Up} but in Posix form.
extension.commandvariable.file.fileDirname2UpPosix : The same result as ${extension.commandvariable.file.fileDirname2Up} but in Posix form.
extension.commandvariable.file.fileDirname3UpPosix : The same result as ${extension.commandvariable.file.fileDirname3Up} but in Posix form.
extension.commandvariable.file.fileDirname4UpPosix : The same result as ${extension.commandvariable.file.fileDirname4Up} but in Posix form.
extension.commandvariable.file.fileDirname5UpPosix : The same result as ${extension.commandvariable.file.fileDirname5Up} but in Posix form.
extension.commandvariable.file.relativeFileDirname1Up : The directory path 1 Up of ${relativeFileDirname}
extension.commandvariable.file.relativeFileDirname2Up : The directory path 2 Up of ${relativeFileDirname}
extension.commandvariable.file.relativeFileDirname3Up : The directory path 3 Up of ${relativeFileDirname}
extension.commandvariable.file.relativeFileDirname4Up : The directory path 4 Up of ${relativeFileDirname}
extension.commandvariable.file.relativeFileDirname5Up : The directory path 5 Up of ${relativeFileDirname}
extension.commandvariable.file.relativeFileDirnamePosix : The same result as ${relativeFileDirname} but in Posix form.
extension.commandvariable.file.relativeFileDirname1UpPosix : The same result as ${extension.commandvariable.file.relativeFileDirname1Up} but in Posix form.
extension.commandvariable.file.relativeFileDirname2UpPosix : The same result as ${extension.commandvariable.file.relativeFileDirname2Up} but in Posix form.
extension.commandvariable.file.relativeFileDirname3UpPosix : The same result as ${extension.commandvariable.file.relativeFileDirname3Up} but in Posix form.
extension.commandvariable.file.relativeFileDirname4UpPosix : The same result as ${extension.commandvariable.file.relativeFileDirname4Up} but in Posix form.
extension.commandvariable.file.relativeFileDirname5UpPosix : The same result as ${extension.commandvariable.file.relativeFileDirname5Up} but in Posix form.
extension.commandvariable.file.relativeFilePosix : The same result as ${relativeFile} but in Posix form.
extension.commandvariable.file.fileAsKey : Use part of the file path as a key in a map lookup. Can be used in lauch.json to select arguments based on filename, see example.
extension.commandvariable.file.fileDirBasename : The basename of the ${fileDirname}
extension.commandvariable.file.fileDirBasename1Up : The directory name 1 Up of ${fileDirname}
extension.commandvariable.file.fileDirBasename2Up : The directory name 2 Up of ${fileDirname}
extension.commandvariable.file.fileDirBasename3Up : The directory name 3 Up of ${fileDirname}
extension.commandvariable.file.fileDirBasename4Up : The directory name 4 Up of ${fileDirname}
extension.commandvariable.file.fileDirBasename5Up : The directory name 5 Up of ${fileDirname}
extension.commandvariable.file.content : The content of the given file name. Use "inputs", see example. Or the value of a Key-Value pair, see example. Or the value of a JSON file property, see example.
extension.commandvariable.file.contentInEditor : The same as extension.commandvariable.file.content to be used for keybindings. Result will be inserted in the current editor.
extension.commandvariable.file.pickFile : Show a Quick Pick selection box with file paths that match an include and an exclude glob pattern. Use "inputs", see example.
extension.commandvariable.workspace.workspaceFolderPosix : The same result as ${workspaceFolder} but in Posix form. You can target a particular workspace by supplying a name in the arguments.
extension.commandvariable.workspace.folderBasename1Up : The directory name 1 Up of the workspace root directory. The parent of the workspace folder that is opened with File > Open Folder.... You can get info for a particular workspace by supplying a name in the arguments.
extension.commandvariable.workspace.folderBasename2Up : The directory name 2 Up of the workspace root directory.
extension.commandvariable.workspace.folderBasename3Up : The directory name 3 Up of the workspace root directory.
extension.commandvariable.workspace.folderBasename4Up : The directory name 4 Up of the workspace root directory.
extension.commandvariable.workspace.folderBasename5Up : The directory name 5 Up of the workspace root directory.
extension.commandvariable.selectedText : The selected text in the active editor, empty string if nothing selected. Supports multicursor.
extension.commandvariable.selectionStartLineNumber : Line number of the selection start
extension.commandvariable.selectionStartColumnNumber : Column number of the selection start
extension.commandvariable.selectionEndLineNumber : Line number of the selection end
extension.commandvariable.selectionEndColumnNumber : Column number of the selection end
extension.commandvariable.currentLineText : The text of the line in the active editor where the selection starts or where the cursor is. Supports multicursor.
extension.commandvariable.dirSep : Directory separator for this platform. '\' on Windows, '/' on other platforms
extension.commandvariable.envListSep : Environment variable list separator for this platform. ';' on Windows, ':' on other platforms
extension.commandvariable.pickStringRemember : the same as Input variable pickString but it remembers the picked item by a key
extension.commandvariable.rememberPick : retreive a remembered pick by key
extension.commandvariable.dateTime : language-sensitive format of current date and time (using a Locale), see example
extension.commandvariable.dateTimeInEditor : language-sensitive format of current date and time (using a Locale) to be used for keybindings
extension.commandvariable.transform : make a custom variable by echoing static text or transform the content of a variable with a Regular Expression Find-Replace, see example.
extension.commandvariable.UUID : generate a UUID v4 (from random numbers) with different output formats, see example
extension.commandvariable.UUIDInEditor : generate a UUID v4 (from random numbers) to be used for keybindings

We can give an extension command arguments with input variables, but for single numeric arguments putting the argument in the command name is simpler.

Usage

An example launch.json :

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: Module",
      "type": "python",
      "request": "launch",
      "console": "integratedTerminal",
      "module": "${command:extension.commandvariable.file.relativeDirDots}.${fileBasenameNoExtension}",
    }
  ]
}

You can use a Tasks to see the value of a variable substitution.

FileAsKey

The command extension.commandvariable.file.fileAsKey makes it possible to select a string based on the current active file.

The keys of the args object are searched for in the path of the active file (directory separator is /).

If you have files with the same name use part of the full path to select the correct one like "/dir1/main.py" and "/dir2/main.py".

{
  "version": "2.0.0",
  "tasks": [
    {
      "name": "Python: Current File",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "args" : ["${input:chooseArgs}"]
    }
  ],
  "inputs": [
    {
      "id": "chooseArgs",
      "type": "command",
      "command": "extension.commandvariable.file.fileAsKey",
      "args": {
        "calculation.py": "-n 4224",
        "client.py": "-i calc-out.yaml"
      }
    }
  ]
}

The value strings may contain variables. If you use the variable ${selectedText} you have to embed the properties separator and filterSelection in the variable, example ${selectedText##separator=@@##filterSelection=index%3===1##}.

File Content

Sometimes you want to use the result of a shell script (batch file). Setting environment variables will not work because they modify only the child shell.

If you store the content in a file you can retrieve this with the extension.commandvariable.file.content command.

The content of the file is assumed to be encoded with UTF-8.

The fileName argument supports variables, like ${workspaceFolder} and ${workspaceFolder:name}.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo FileContent",
      "type": "shell",
      "command": "echo",
      "args": [
        "${input:fileContent}"
      ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "fileContent",
      "type": "command",
      "command": "extension.commandvariable.file.content",
      "args": {
        "fileName": "c:\\temp\\result.txt"
      }
    }
  ]
}

File Content Key Value pairs

If you have a file that contains key-value pairs and you want the value for a given key you can use the command extension.commandvariable.file.content. The argument "key" specifies for which key you want the value. If the key is not found and you have a "default" argument that string is returned else "Unknown" is returned.

Key-Value files

A key-value file consists of lines that contain key-value pairs.

The file can contain comments and empty lines. A comment line starts with # or //. You can have whitespace before the comment characters.

A key-value pair is a line in the file that specifies the key and the value separated by a character. The supported separators are : and =. The line is split with the following regular expression: ^\s*([^:=]+)(?:[:=])(.*)

The non-capturing group (?:) is only needed in this Markdown file to prevent detection of a Markdown link.

Everything, after the starting whitespace, before the first separator is the key, everything after the separator is the value. You can have a separator character in the value. Only the first separator is important.

Example

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo FileContentKey",
      "type": "shell",
      "command": "echo",
      "args": [
        "${input:fileContentKey}"
      ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "fileContentKey",
      "type": "command",
      "command": "extension.commandvariable.file.content",
      "args": {
        "fileName": "${workspaceFolder}/key-values.txt",
        "key": "PLUGIN",
        "default": "special-plugin"
      }
    }
  ]
}

key-values.txt

// a few key values
PLUGIN=cool-pugin
THEME=new-school

File Content JSON Property

If you have a JSON file and you want the value for a given property you can use the command extension.commandvariable.file.content. The argument "json" specifies a JavaScript expression that gets the property you want from the variable content. The variable content is the parsed JSON file. If the JavaScript expression fails and you have a "default" argument that string is returned else "Unknown" is returned.

The JSON file can be an array and you can address the elements with: content[3]

Example

You have a JSON configuration file in your workspace:

config.json

{
  "log": "foobar.log",
  "server1": {
    "port": 5011
  },
  "server2": {
    "port": 5023
  }
}

In your tasks.json you want to use the server1 port value.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo Server1Port",
      "type": "shell",
      "command": "echo",
      "args": [
        "${input:configServer1Port}"
      ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "configServer1Port",
      "type": "command",
      "command": "extension.commandvariable.file.content",
      "args": {
        "fileName": "${workspaceFolder}/config.json",
        "json": "content.server1.port",
        "default": "4321"
      }
    }
  ]
}

File Content in Editor

If you want the (partial) result of an external program inserted in the editor you can use the command extension.commandvariable.file.contentInEditor. This command uses the same arguments as extension.commandvariable.file.content.

Most likely you want to call the program first to write the output to a file that you read and extract the parts you want. For this you can use the extension multi-command.

Define a task that runs the external command
Define a multi-command that calls the task and then extension.commandvariable.file.contentInEditor
Define a key binding that calls the multi-command

Add to .vscode/tasks.json

    {
      "label": "get Timestamp",
      "type": "shell",
      "command": "echo timestamp=2021-04-01 12:34 >${workspaceFolder}/timequery.txt",
      "problemMatcher": []
    }

Add to .vscode/settings.json

  "multiCommand.commands": [
    {
      "command": "multiCommand.insertTimestamp",
      "interval": 500,
      "sequence": [
        { "command": "workbench.action.tasks.runTask",
          "args": "get Timestamp"
        },
        { "command": "extension.commandvariable.file.contentInEditor",
          "args": {
            "fileName": "${workspaceFolder}/timequery.txt",
            "key": "timestamp",
            "default": "Query failed"
          }
        }
      ]
    }
  ]

Add to keybindings.json

{
    "key": "F1", // or any other key combo
    "command": "extension.multiCommand.execute",
    "args": { "command": "multiCommand.insertTimestamp" },
    "when": "editorTextFocus"
}

Pick File

If you want to pick a file and use it in your launch.json or tasks.json you can use the extension.commandvariable.file.pickFile command.

This command uses vscode.workspace.findFiles to get a list of files to show in a Quick Pick selection box.

You can set the following arguments to this command:

include : a Glob Pattern that defines the files to search for (default: "**/*")
exclude : a Glob Pattern that defines files and folders to exclude. (default: "undefined")

Two special strings are possible to pass special values:
- "undefined" to set the exclude argument to undefined to use default excludes
- "null" to set the exclude argument to null to use no excludes
Known problem: exclude is not working as expected under Windows. Excluded files are put at the end of the list.
maxResults : Limit the number of files to choose from. Must be a number (no " characters). (default: no limits)
addEmpty : [ true | false ] If true: add an entry to the list (*** Empty ***) that will return an empty string when selected. (default: false)
addAsk : [ true | false ] If true: add an entry to the list (*** Ask ***) that will open an Input Box where you enter the path to be returned. (default: false)
display : How do you want to see the files displayed (default: "fullPath")
- "fullpath" : show the file full path, if path is big it can be clipped by the selection box
- "fileName" : show the file name followed by the directory path of the file, the Fuzzy Search is now only on the file name and file extension.
fromWorkspace : [ "name" | true | false ] - limit the include pattern relative to a workspace (default: false)
- if "name": find the workspace with that name
- If true: show a Pick List of Workspaces to choose from
fromFolder : (Optional) Object with the properties:
- predefined : (Optional) An array with file system paths of directories to limit the include pattern relative to that directory. Do not enter folder paths that are root folders in this workspace.
Show a Pick list of folders specified in the property predefined and 2 additional entries
- *** Ask *** : open an Input Box where you enter the path of the folder
- *** Workspace *** : show a Pick List of Workspaces
```
"fromFolder": {
  "predefined": [
    "C:\\temp\\log",
    "D:\\Data\\GPR\\2021"
  ]
}
```

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo FilePick",
      "type": "shell",
      "command": "echo",
      "args": [
        "${input:filePick}"
      ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "filePick",
      "type": "command",
      "command": "extension.commandvariable.file.pickFile",
      "args": {
        "include": "**/*.{htm,html,xhtml}",
        "exclude": "**/{scratch,backup}/**"
      }
    }
  ]
}

pickStringRemember and rememberPick

pickStringRemember has the same configuration attributes as the Input variable pickString. And both commands have configuration attribute key. The key is used to store and retrieve a particular pick.

The configuration attributes need to be passed to the command in the args attribute. The key attribute is optional if you only have one pick to remember or every pick can use the same key name.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Task 1",
      "type": "shell",
      "command": "dostuff1",
      "args": ["-p", "${input:pickPath}"]
    },
    {
      "label": "Task 2",
      "type": "shell",
      "command": "dostuff2",
      "args": ["-p", "${input:rememberPath}"]
    },
    {
      "label": "Do Task 1 and 2",
      "dependsOrder": "sequence",
      "dependsOn": ["Task 1", "Task 2"],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "pickPath",
      "type": "command",
      "command": "extension.commandvariable.pickStringRemember",
      "args": {
        "key": "path",
        "options": [ "path/to/directory/A", "path/to/Z" ],
        "description": "Choose a path"
      }
    },
    {
      "id": "rememberPath",
      "type": "command",
      "command": "extension.commandvariable.rememberPick",
      "args": { "key": "path" }
    }
  ]
}

Multicursor and text

The commands extension.commandvariable.selectedText and extension.commandvariable.currentLineText combine the content in case of multi cursors. The default separator used is "\n".

The selections are sorted in the order they appear in the file.

You can change the separator by specifying an argument object for the command with a property "separator":

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo (selected:currentLine) Text",
      "type": "shell",
      "command": "echo",
      "args": [ "${input:multiCursorText}" ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "multiCursorText",
      "type": "command",
      "command": "extension.commandvariable.selectedText",
      "args": { "separator": "@--@" }
    }
  ]
}

Transform

Sometimes you want to modify a variable before you use it. Change the filename of the file in the editor to construct a different filename.

The transform you can apply to fields in snippets is not supported in the variables in the task and launch json files.

With the command extension.commandvariable.transform you can find-replace with Regular Expression a selection of variables combined with static text.

The command can be used with the ${input:} variable and has the following arguments:

text : the string where you want to apply a find-replace. It can contain a selection of variables and literal text.
find : (Optional) the Regular Expression to search in text. Can contain capture groups. If no find argument there is no find-replace operation.
replace : (Optional) the replace string of what is matched by find, can contain group references ($1), default ("")
flags : (Optional) the flags to be used in the Regular Expression, like gims, default ("")
separator : (Optional) the string used to join the (multi cursor) selections for ${selectedText}, default ("\n")
filterSelection : (Optional) a JavaScript expression that allows which (multi cursor) selections to use for ${selectedText}, default ("true") all are selected.
The expression can use the following variables:
- index : the 0-base sequence number of the selection
- value : the text of the selection
- numSel : number of selections (or cursors)
The index is 0-based to make (modulo) calculations easier. The first index is 0.

Custom variables

We can use this command to construct custom variables by setting the text argument and not defining a find argument. The id of the inputs record is the name of the variable.

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Node",
      "runtimeArgs": ["user", "${input:TEST_USER}"],
    },
    {
      "type": "chrome",
      "request": "launch",
      "name": "Chrome",
      "url": "http://localhost:3000?${input:TEST_USER}",
    }
  ],
  "inputs": [
    {
      "id": "TEST_USER",
      "type": "command",
      "command": "extension.commandvariable.transform",
      "args": { "text": "BobSmith" }
    }
  ]
}

Variables

Many strings of commands support variables. The variables that can be used are:

VSC does not perform variable substitution in the strings of the inputs fields, so currently only a selection of variables is replicated here.

${selectedText} : a joined string constructed from the (multi cursor) selections.
You can overide the used properties by embedding them in the variable
${workspaceFolder} : the path of the workspace folder opened in VS Code containing the current file.
${workspaceFolder:name} : the path of the workspace folder with the specified name opened in VS Code
${file} : the current opened file (the file system path)
${relativeFile} : the current opened file relative to workspaceFolder
${fileBasename} : the current opened file's basename
${fileBasenameNoExtension} : the current opened file's basename with no file extension
${fileExtname} : the current opened file's extension

The variables are processed in the order mentioned. This means that if the selected text contains variable descriptions they are handled as if typed in the text.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo first part fileBaseNameNoExtension",
      "type": "shell",
      "command": "echo",
      "args": [ "${input:firstPart}" ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "firstPart",
      "type": "command",
      "command": "extension.commandvariable.transform",
      "args": {
        "text": "${fileBasenameNoExtension}",
        "find": "(.*?)-.*",
        "replace": "$1",
      }
    }
  ]
}

workspaceFolder Variable

The variable ${workspaceFolder} is only valid in certain cases:

File Open	Workspace	`${workspaceFolder}`
No	No	`"Unknown"` and Error: `"No Folder"`
No	Folder	Path of the open folder
No	Multi Root	`"Unknown"` and Error: `"Use workspace name"`
Yes	No	`"Unknown"` and Error: `"No Folder"`
Yes	Folder	Path of the workspace containing current file
Yes	Multi Root	Path of the workspace containing current file

An example:

${workspaceFolder:server}

The variable ${workspaceFolder:name} is only invalid when there is no folder open.

In most cases the name is the basename of the workspace folder path (last directory name).

If you have 2 workspaces with the same (folder base)name you can't target the second one by name only. You have to use more parts of the directory path to make the name unique. Use the / as path separator on all platforms. The name is tested to be at the end of the workspace folder path (using / as separator).

An example:

${workspaceFolder:/websiteA/server}

selectedText Variable

If you only have 1 selection you don't need the properties separator and filterSelection.

For the transform command you can define the properties separator and filterSelection in the args property of the command.

      "args": {
        "text": "${selectedText}",
        "separator": "@-@",
        "filterSelection": "index%2===1",
      }

And you can define/overrule the properties by embedding them in the variable:

${selectedText separator properties separator}

All separator's used in a variable need to be the same.

The separator is a string of 1 or more characters that are not part of the a to z alfabet or {}, in regular expression [^a-zA-Z{}]+. Choose a character string that is not used in the values of the properties part. If you need to use more than 1 character do not use all the same character, it can lead to non conformant properties description that is still parsed. The reason is that JavaScript does not have non-backtrack greedy quantifiers. Currently the variable is matched with 1 regular expression. This makes everything easy to implement.

The properties are the properties you want separated with the separator string. Each property is defined as:

propertyName=value

Everyting between = and the next separator is the value

The above example can be written as

      "args": {
        "text": "${selectedText#separator=@-@#filterSelection=index%2===1#}"
      }

A few examples of filterSelection expressions

every other odd selection : "filterSelection": "index%2===1"
every selection containing foo or bar : "filterSelection": "value.match(/foo|bar/)"
the before last selection : "filterSelection": "index===numSel-2"

You can use multiple ${selectedText} variables that have different properties:

      "args": {
        "text": "${selectedText#filterSelection=index===3#} ${selectedText#filterSelection=index===1#}"
      }

Workspace name in `argument`

The commands extension.commandvariable.workspace.folderBasenameNUp allow to get the information from a different workspace by specifying the name or last parts of the file path of the workspace directory. This can also be done when there is no editor active.

You supply the name in the arguments of the command. You have to use an ${input} variable.

{
  "version": "0.2.0",
  "tasks": [
    {
      "label": "echo server name",
      "type": "shell",
      "command": "echo",
      "args": [ "${input:server1Up}" ]
    }
  ],
  "inputs": [
    {
      "id": "server1Up",
      "type": "command",
      "command": "extension.commandvariable.workspace.folderBasename1Up",
      "args": { "name": "server" }
    }
  ]
}

If you have 2 workspaces with the same (folder base)name you can't target the second one by name only. You have to use more parts of the directory path to make the name unique. Use the / as path separator on all platforms. The name argument is tested to be at the end of the workspace folder path (using / as separator). An example of an args property is:

"args": { "name": "/websiteA/server" }

UUID

The commands extension.commandvariable.UUID and extension.commandvariable.UUIDInEditor generate a v4 UUID.

It has the following arguments:

output : can change the output format (default: hexString):
- hexString : a0e0f130-8c21-11df-92d9-95795a3bcd40
- hexNoDelim : a0e0f1308c2111df92d995795a3bcd40
- bitString : 101000001110000 ... 1100110101000000
- urn : urn:uuid:a0e0f130-8c21-11df-92d9-95795a3bcd40
use : which UUID to use (default: new):
- new : generate a new UUID
- previous, prev : use the previous generated UUID

In this example the 3 printed UUIDs are all different

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo UUIDs",
      "type": "shell",
      "command": "echo",
      "args": [
        "${command:extension.commandvariable.UUID}",
        "${input:uuid-hexnodelim}",
        "${input:uuid-urn}"
      ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "uuid",
      "type": "command",
      "command": "extension.commandvariable.UUID"
    },
    {
      "id": "uuid-hexnodelim",
      "type": "command",
      "command": "extension.commandvariable.UUID",
      "args": { "output": "hexNoDelim" }
    },
    {
      "id": "uuid-urn",
      "type": "command",
      "command": "extension.commandvariable.UUID",
      "args": { "output": "urn" }
    },
    {
      "id": "uuid-bits",
      "type": "command",
      "command": "extension.commandvariable.UUID",
      "args": { "output": "bitString" }
    }
  ]
}

dateTime

For keybindings.json use extension.commandvariable.dateTimeInEditor.

For launch.json and tasks.json use extension.commandvariable.dateTime.

This command uses Intl.DateTimeFormat to create a language-sensitive format of current date and time.

The locale and options command arguments are the arguments for the Intl.DateTimeFormat constructor and are optional.

The locale command argument can be a single string or an array of strings of language tags. If not specified the browser default locale is used.

The template command argument is an optional template string that uses the same placeholder syntax as the Javascript template strings. You can add as many literal text as needed.

The only expressions valid are the type values returned by the Intl.DateTimeFormat.prototype.formatToParts() method. See first example.

If there is no template command argument the value parts of the Intl.DateTimeFormat.prototype.formatToParts() are joined. See second example.

Example 1

  {
    "key": "ctrl+shift+alt+f4",
    "when": "editorTextFocus",
    "command": "extension.commandvariable.dateTimeInEditor",
    "args": {
      "locale": "en-US",
      "options": {
        "year": "numeric",
        "month": "2-digit",
        "day": "2-digit",
        "hour12": false,
        "hour": "2-digit",
        "minute": "2-digit",
        "second": "2-digit"
      },
      "template": "${year}/${month}/${day}-${hour}:${minute}:${second}"
    }
  }

The result is

2020/03/19-18:01:18

Example 2

You can use a different locale and number system and use the long format:

  {
    "key": "ctrl+shift+alt+f5",
    "when": "editorTextFocus",
    "command": "extension.commandvariable.dateTimeInEditor",
    "args": {
      "locale": "fr-FR-u-nu-deva",
      "options": {
        "dateStyle": "full",
        "timeStyle": "full"
      }
    }
  }

The result is

jeudi १९ mars २०२० à १७:५९:५७ heure normale d’Europe centrale

Example 3

For launch.json and tasks.json use the inputs attribute:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo date",
      "type": "shell",
      "command": "echo",
      "args": [ "${input:shortDate}" ],
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "shortDate",
      "type": "command",
      "command": "extension.commandvariable.dateTime",
      "args": {
        "locale": "es-ES",
        "options": {
          "weekday": "long",
          "year": "numeric",
          "month": "2-digit",
          "day": "2-digit",
          "hour12": false,
          "hour": "2-digit",
          "minute": "2-digit",
          "second": "2-digit"
        },
        "template": "${weekday}__${year}${month}${day}T${hour}${minute}${second}"
      }
    }
  ]
}

The result is:

jueves__20200319T184634

Release Notes

v1.16.2

update uuid.js to v4.2.8 and allow different output formats

v1.16.1

VSCode Server (Remote SSH) does not support ?? and ?.

v1.16.0

pickFile : can be limited to a Workspace folder or any other folder
pickFile : change how the file paths are displayed
pickFile : can ask for a path via additional entry

v1.15.0

pickFile : can return an emty string via additional entry

v1.14.0

In Multi Root Workspace you need to name the workspace in certain cases. In the variable or arguments.
${workspaceFolder} and ${workspaceFolder:name} now also work if no file currently open.
everywhere a variable is allowed now all variables are allowed. (not all are usefull everywhere)
process ${selectedText} first so selected text could contain variable descriptions (maybe useful to somebody).

Credits

uses UUID node module by LiosK

GitMensch/command-variable

Command Variable

Usage

FileAsKey

File Content

File Content Key Value pairs

Key-Value files

Example

File Content JSON Property

Example

File Content in Editor

Pick File

pickStringRemember and rememberPick

Multicursor and text

Transform

Custom variables

Variables

workspaceFolder Variable

selectedText Variable

Workspace name in argument

UUID

dateTime

Example 1

Example 2

Example 3

Release Notes

v1.16.2

v1.16.1

v1.16.0

v1.15.0

v1.14.0

Credits

Workspace name in `argument`