Theia API Documentation v1.70.0
    Preparing search index...

    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;
        enableCommandHistory?: boolean;
        executionType?: "shell" | "process" | "customExecution";
        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;
        [name: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [name: string]: any

      eslint-disable-next-line @typescript-eslint/no-explicit-any

    Index

    Properties

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

    Properties

    Readonly_scope

    _scope: TaskConfigurationScope
    args?: string[]
    command?: string
    dependsOn?: string | TaskIdentifier | (string | TaskIdentifier)[]

    The other tasks the task depend on.

    dependsOrder?: DependsOrder

    The order the dependsOn tasks should be executed in.

    detail?: string
    enableCommandHistory?: boolean

    Whether to enable command history tracking for this task's terminal. When enabled, OSC sequences are injected to mark command boundaries. Defaults to false if not specified.

    executionType?: "shell" | "process" | "customExecution"
    group?:
        | "build"
        | "test"
        | "rebuild"
        | "clean"
        | "none"
        | { isDefault: boolean; kind: "build"
        | "test"
        | "rebuild"
        | "clean" }
    isBackground?: boolean

    Whether the task is a background task or not.

    label: string

    A label that uniquely identifies a task configuration per source

    linux?: CommandProperties

    Linux specific task configuration

    options?: CommandOptions
    osx?: CommandProperties

    macOS specific task configuration

    presentation?: TaskOutputPresentation
    problemMatcher?:
        | string
        | ProblemMatcherContribution
        | (string | ProblemMatcherContribution)[]
    runOptions?: RunOptions
    type: ProcessType
    windows?: CommandProperties

    Windows specific task configuration

    Settings

    Member Visibility

    On This Page

    Properties