task.json

VSCode Task file

Type object
File match task.json tasks.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/task-json/latest.json
Source https://www.schemastore.org/task.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

args string[]

The arguments passed to the command. Can be omitted.

command string

The command to be executed. Can be an external program or a shell command.

isBackground boolean

Specifies whether a global command is a background task.

linux object
8 nested properties
args string[]

The arguments passed to the command. Can be omitted.

command string

The command to be executed. Can be an external program or a shell command.

isBackground boolean

Specifies whether a global command is a background task.

options object

Options to be passed to the external program or shell

3 nested properties
cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher to be used if a global command is executed (e.g. no tasks are defined). A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

tasks TaskDescription[]

The configuration of the available tasks. A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"
options object

Options to be passed to the external program or shell

3 nested properties
cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

osx object
8 nested properties
args string[]

The arguments passed to the command. Can be omitted.

command string

The command to be executed. Can be an external program or a shell command.

isBackground boolean

Specifies whether a global command is a background task.

options object

Options to be passed to the external program or shell

3 nested properties
cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher to be used if a global command is executed (e.g. no tasks are defined). A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

tasks TaskDescription[]

The configuration of the available tasks. A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"
presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher to be used if a global command is executed (e.g. no tasks are defined). A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

tasks TaskDescription[]

The configuration of the available tasks. A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"
version string

The configuration's version number

Values: "2.0.0"
windows object
8 nested properties
args string[]

The arguments passed to the command. Can be omitted.

command string

The command to be executed. Can be an external program or a shell command.

isBackground boolean

Specifies whether a global command is a background task.

options object

Options to be passed to the external program or shell

3 nested properties
cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher to be used if a global command is executed (e.g. no tasks are defined). A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

tasks TaskDescription[]

The configuration of the available tasks. A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"

Definitions

BackgroundMatcher object

A description to track the start and end of a background task.

activeOnStart boolean

If set to true the watcher is in active mode when the task starts. This is equals of issuing a line that matches the beginPattern.

beginsPattern string

If matched in the output the start of a background task is signaled.

endsPattern string

If matched in the output the end of a background task is signaled.

BaseTaskConfiguration object
args string[]

The arguments passed to the command. Can be omitted.

command string

The command to be executed. Can be an external program or a shell command.

isBackground boolean

Specifies whether a global command is a background task.

options object

Options to be passed to the external program or shell

3 nested properties
cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher to be used if a global command is executed (e.g. no tasks are defined). A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

tasks TaskDescription[]

The configuration of the available tasks. A tasks.json file can either contain a global problemMatcher property or a tasks property but not both.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"
CommandOptions object

Options to be passed to the external program or shell

cwd string

The current working directory of the executed program or shell. If omitted the current workspace's root is used.

env Record<string, string>

The environment of the executed program or shell. If omitted the parent process' environment is used.

shell object

Configuration of the shell when task type is shell

2 nested properties
args string[]

The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

executable string

The shell to use.

PresentationOptions object
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

ProblemMatcher object

A description of a problem matcher that detects problems in build output.

background object

A description to track the start and end of a background task.

3 nested properties
activeOnStart boolean

If set to true the watcher is in active mode when the task starts. This is equals of issuing a line that matches the beginPattern.

beginsPattern string

If matched in the output the start of a background task is signaled.

endsPattern string

If matched in the output the end of a background task is signaled.

base string

The name of a base problem matcher to use. If specified the base problem matcher will be used as a template and properties specified here will replace properties of the base problem matcher

fileLocation string[] | string

Defines how filename reported in a problem pattern should be read. Valid values are:

  • "absolute": the filename is always treated absolute.
  • "relative": the filename is always treated relative to the current working directory. This is the default.
  • ["relative", "path value"]: the filename is always treated relative to the given path value.
  • "autodetect": the filename is treated relative to the current workspace directory, and if the file does not exist, it is treated as absolute.
  • ["autodetect", "path value"]: the filename is treated relative to the given path value, and if it does not exist, it is treated as absolute.
owner string

The owner of the produced VS Code problem. This is typically the identifier of a VS Code language service if the problems are to be merged with the one produced by the language service or 'external'. Defaults to 'external' if omitted.

pattern ProblemPattern | ProblemPattern[] | string

The name of a predefined problem pattern, the inline definition of a problem pattern or an array of problem patterns to match problems spread over multiple lines.

severity string

The severity of the VS Code problem produced by this problem matcher.

Valid values are: "error": to produce errors. "warning": to produce warnings. "info": to produce infos.

The value is used if a pattern doesn't specify a severity match group. Defaults to "error" if omitted.

ProblemPattern object
code number

The match group index of the problem's code.

Defaults to undefined. No code is captured.

column number

The match group index of the problem's column in the source file.

endColumn number

The match group index of the problem's end column in the source file.

Defaults to undefined. No end column is captured.

endLine number

The match group index of the problem's end line in the source file.

Defaults to undefined. No end line is captured.

file number

The match group index of the filename.

kind string

Whether the pattern matches a problem for the whole file or for a location inside a file.

Defaults to "location".

Values: "file" "location"
line number

The match group index of the problem's line in the source file. Can only be omitted if location is specified.

location number

The match group index of the problem's location. Valid location patterns are: (line), (line,column) and (startLine,startColumn,endLine,endColumn). If omitted the line and column properties are used.

loop boolean

Specifies if the last pattern in a multi line problem matcher should loop as long as it does match a line consequently. Only valid on the last problem pattern in a multi line problem matcher.

message number

The match group index of the message. Defaults to 0.

regexp string

The regular expression to find a problem in the console output of an executed task.

severity number

The match group index of the problem's severity.

Defaults to undefined. In this case the problem matcher's severity is used.

RunOptions object

A description to when and how run a task.

reevaluateOnRerun boolean

Controls how variables are evaluated when a task is executed through the Rerun Last Task command. The default is true, meaning that variables will be re-evaluated when a task is rerun. When set to false, the resolved variable values from the previous run of the task will be used.

runOn string

Specifies when a task is run.

Valid values are: "default": The task will only be run when executed through the Run Task command. "folderOpen": The task will be run when the containing folder is opened.

TaskDescription object

The description of a task.

args string[]

Additional arguments passed to the command. Should be used if type is "process".

command string

The command to execute. If the type is "shell" it should be the full command line including any additional arguments passed to the command.

group object | string

Defines the group to which this task belongs. Also supports to mark a task as the default task in a group.

isBackground boolean

Whether the executed command is kept alive and runs in the background.

label string

The task's name

presentation object
7 nested properties
clear boolean

Controls whether the terminal is cleared before this task is run. Defaults to false.

echo boolean

Controls whether the command associated with the task is echoed in the user interface. Defaults to true.

focus boolean

Controls whether the panel showing the task output is taking focus. Defaults to false.

group string

Controls whether the task is executed in a specific terminal group using split panes. Tasks in the same group (specified by a string value) will use split terminals to present instead of a new terminal panel.

panel string

Controls if the task panel is used for this task only (dedicated), shared between tasks (shared) or if a new panel is created on every task execution (new). Defaults to shared.

Values: "dedicated" "new" "shared"
reveal string

Controls whether the task output is reveal in the user interface. Defaults to always.

Values: "always" "never" "silent"
showReuseMessage boolean

Controls whether to show the Terminal will be reused by tasks, press any key to close it message.

problemMatcher ProblemMatcher | ProblemMatcher | string[] | string

The problem matcher(s) to use to capture problems in the tasks output.

runOptions object

A description to when and how run a task.

2 nested properties
reevaluateOnRerun boolean

Controls how variables are evaluated when a task is executed through the Rerun Last Task command. The default is true, meaning that variables will be re-evaluated when a task is rerun. When set to false, the resolved variable values from the previous run of the task will be used.

runOn string

Specifies when a task is run.

Valid values are: "default": The task will only be run when executed through the Run Task command. "folderOpen": The task will be run when the containing folder is opened.

type string

The type of a custom task. Tasks of type "shell" are executed inside a shell (e.g. bash, cmd, powershell, ...)

Values: "process" "shell" "npm"