Interface ProcessTaskConfiguration

Configuration of a Task that may be run as a process or a command inside a shell.

interface ProcessTaskConfiguration {
    _scope: TaskConfigurationScope;
    args?: string[];
    command?: string;
    dependsOn?: string | TaskIdentifier | (string | TaskIdentifier)[];
    dependsOrder?: DependsOrder;
    detail?: string;
    group?: "build" | "test" | "rebuild" | "clean" | "none" | {
        isDefault: boolean;
        kind: "build" | "test" | "rebuild" | "clean";
    };
    isBackground?: boolean;
    label: string;
    linux?: CommandProperties;
    options?: CommandOptions;
    osx?: CommandProperties;
    presentation?: TaskOutputPresentation;
    problemMatcher?: string | ProblemMatcherContribution | (string | ProblemMatcherContribution)[];
    runOptions?: RunOptions;
    type: ProcessType;
    windows?: CommandProperties;
}

Hierarchy (view full)

Properties

_scope args? command? dependsOn? dependsOrder? detail? group? isBackground? label linux? options? osx? presentation? problemMatcher? runOptions? type windows?

Properties

Readonly _scope

_scope: TaskConfigurationScope

Optional Readonly args

args?: string[]

Optional Readonly command

command?: string

Optional dependsOn

dependsOn?: string | TaskIdentifier | (string | TaskIdentifier)[]

The other tasks the task depend on.

Optional dependsOrder

dependsOrder?: DependsOrder

The order the dependsOn tasks should be executed in.

Optional detail

detail?: string

Optional group

group?: "build" | "test" | "rebuild" | "clean" | "none" | {
    isDefault: boolean;
    kind: "build" | "test" | "rebuild" | "clean";
}

Type declaration

  • isDefault: boolean
  • kind: "build" | "test" | "rebuild" | "clean"

Optional isBackground

isBackground?: boolean

Whether the task is a background task or not.

Readonly label

label: string

A label that uniquely identifies a task configuration per source

Optional Readonly linux

linux?: CommandProperties

Linux specific task configuration

Optional Readonly options

options?: CommandOptions

Optional Readonly osx

osx?: CommandProperties

macOS specific task configuration

Optional presentation

presentation?: TaskOutputPresentation

Optional problemMatcher

problemMatcher?: string | ProblemMatcherContribution | (string | ProblemMatcherContribution)[]

Optional runOptions

runOptions?: RunOptions

Readonly type

type: ProcessType

Optional Readonly windows

windows?: CommandProperties

Windows specific task configuration

Settings

Member Visibility

Theme

On This Page

_scopeargscommanddependsOndependsOrderdetailgroupisBackgroundlabellinuxoptionsosxpresentationproblemMatcherrunOptionstypewindows