Class TaskConfigurations

Watches a tasks.json configuration file and provides a parsed version of the contained task configurations

Implements

Disposable

Constructors

constructor

new TaskConfigurations(): TaskConfigurations
Returns TaskConfigurations
- Defined in packages/task/src/browser/task-configurations.ts:86

Properties

`Protected`client

client: undefined | TaskConfigurationClient = undefined

`Protected` `Readonly`providedTaskConfigurations

providedTaskConfigurations: ProvidedTaskConfigurations

`Protected` `Readonly`taskConfigurationManager

taskConfigurationManager: TaskConfigurationManager

`Protected`taskCustomizationMap

taskCustomizationMap: Map<string, TaskCustomization[]> = ...

Map of source (path of root folder that the task configs come from) and task customizations map.

`Protected` `Readonly`taskDefinitionRegistry

taskDefinitionRegistry: TaskDefinitionRegistry

`Protected` `Readonly`taskSchemaUpdater

taskSchemaUpdater: TaskSchemaUpdater

`Protected`tasksMap

tasksMap: Map<string, Map<string, TaskConfiguration>> = ...

Map of source (path of root folder that the task configs come from) and task config map. For the inner map (i.e., task config map), the key is task label and value TaskConfiguration

`Protected` `Readonly`taskSourceResolver

taskSourceResolver: TaskSourceResolver

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Methods

configure

configure(token: number, task: TaskConfiguration): Promise<void>
Adds given task to a config file and opens the file to provide ability to edit task configuration.
Parameters
- token: number
- task: TaskConfiguration
Returns Promise<void>
- Defined in packages/task/src/browser/task-configurations.ts:303

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/task/src/browser/task-configurations.ts:117

getCustomizationForTask

getCustomizationForTask(
taskConfig: TaskConfiguration,
): undefined | TaskCustomization
Returns the customization object in tasks.json for the given task. Please note, this function returns undefined if the given task is not a detected task, because configured tasks don't need customization objects - users can modify its config directly in tasks.json.
Parameters
- taskConfig: TaskConfiguration
  The task config, which could either be a configured task or a detected task.
Returns undefined | TaskCustomization
- Defined in packages/task/src/browser/task-configurations.ts:243

getCustomizedTask

getCustomizedTask(
    token: number,
    scope: TaskConfigurationScope,
    taskLabel: string,
): Promise<undefined | TaskConfiguration>
returns the customized task for a given label or undefined if none
Parameters
- token: number
- scope: TaskConfigurationScope
- taskLabel: string
Returns Promise<undefined | TaskConfiguration>
- Defined in packages/task/src/browser/task-configurations.ts:190

getInvalidTaskConfigurations

getInvalidTaskConfigurations(): (TaskConfiguration | TaskCustomization)[]
returns a collection of invalid task configs as per the task schema defined in Theia.

Returns (TaskConfiguration | TaskCustomization)[]
- Defined in packages/task/src/browser/task-configurations.ts:168

getRawTaskConfigurations

getRawTaskConfigurations(
scope?: TaskConfigurationScope,
): (TaskConfiguration | TaskCustomization)[]
Parameters
- Optionalscope: TaskConfigurationScope
Returns (TaskConfiguration | TaskCustomization)[]
- Defined in packages/task/src/browser/task-configurations.ts:149

getTask

getTask(
scope: TaskConfigurationScope,
taskLabel: string,
): undefined | TaskConfiguration
returns the task configuration for a given label or undefined if none
Parameters
- scope: TaskConfigurationScope
- taskLabel: string
Returns undefined | TaskConfiguration
- Defined in packages/task/src/browser/task-configurations.ts:182

getTaskLabels

getTaskLabels(): string[]
returns the list of known task labels

Returns string[]
- Defined in packages/task/src/browser/task-configurations.ts:122

getTasks

getTasks(token: number): Promise<TaskConfiguration[]>
returns a collection of known tasks, which includes:
- all the configured tasks in tasks.json, and
- the customized detected tasks.
The invalid task configs are not returned.
Parameters
- token: number
Returns Promise<TaskConfiguration[]>
- Defined in packages/task/src/browser/task-configurations.ts:133

`Protected`init

init(): void
Returns void
- Defined in packages/task/src/browser/task-configurations.ts:96

`Protected`onDidTaskFileChange

onDidTaskFileChange(fileChanges: TasksChange[]): Promise<void>
Called when a change, to a config file we watch, is detected.
Parameters
- fileChanges: TasksChange[]
Returns Promise<void>
- Defined in packages/task/src/browser/task-configurations.ts:264

openUserTasks

openUserTasks(): Promise<void>
Returns Promise<void>
- Defined in packages/task/src/browser/task-configurations.ts:298

`Protected`readTasks

readTasks(
scope: TaskConfigurationScope,
): Promise<undefined | (TaskConfiguration | TaskCustomization)[]>
parses a config file and extracts the tasks launch configurations
Parameters
- scope: TaskConfigurationScope
Returns Promise<undefined | (TaskConfiguration | TaskCustomization)[]>
- Defined in packages/task/src/browser/task-configurations.ts:288

`Protected`refreshTasks

refreshTasks(scope: TaskConfigurationScope): Promise<void>
Read the task configs from the task configuration manager, and updates the list of available tasks.
Parameters
- scope: TaskConfigurationScope
Returns Promise<void>
- Defined in packages/task/src/browser/task-configurations.ts:278

`Protected`reorganizeTasks

reorganizeTasks(): void
This function is called after a change in TaskDefinitionRegistry happens. It checks all tasks that have been loaded, and re-organized them in tasksMap and taskCustomizationMap.

Returns void
- Defined in packages/task/src/browser/task-configurations.ts:375

saveTask

saveTask(
scope: TaskConfigurationScope,
task: TaskConfiguration,
): Promise<boolean>
Writes the task to a config file. Creates a config file if this one does not exist
Parameters
- scope: TaskConfigurationScope
- task: TaskConfiguration
Returns Promise<boolean>
- Defined in packages/task/src/browser/task-configurations.ts:365

setClient

setClient(client: TaskConfigurationClient): void
Parameters
- client: TaskConfigurationClient
Returns void
- Defined in packages/task/src/browser/task-configurations.ts:113

updateTaskConfig

updateTaskConfig(
    token: number,
    task: TaskConfiguration,
    update: { [name: string]: any },
): Promise<void>
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- token: number
- task: TaskConfiguration
- update: { [name: string]: any }
Returns Promise<void>
- Defined in packages/task/src/browser/task-configurations.ts:453

Class TaskConfigurations

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TaskConfigurations

Properties

Protectedclient

Protected ReadonlyprovidedTaskConfigurations

Protected ReadonlytaskConfigurationManager

ProtectedtaskCustomizationMap

Protected ReadonlytaskDefinitionRegistry

Protected ReadonlytaskSchemaUpdater

ProtectedtasksMap

Protected ReadonlytaskSourceResolver

Protected ReadonlytoDispose

Protected ReadonlyworkspaceService

Methods

configure

Parameters

Returns Promise<void>

dispose

Returns void

getCustomizationForTask

Parameters

Returns undefined | TaskCustomization

getCustomizedTask

Parameters

Returns Promise<undefined | TaskConfiguration>

getInvalidTaskConfigurations

Returns (TaskConfiguration | TaskCustomization)[]

getRawTaskConfigurations

Parameters

Returns (TaskConfiguration | TaskCustomization)[]

getTask

Parameters

Returns undefined | TaskConfiguration

getTaskLabels

Returns string[]

getTasks

Parameters

Returns Promise<TaskConfiguration[]>

Protectedinit

Returns void

ProtectedonDidTaskFileChange

Parameters

Returns Promise<void>

openUserTasks

Returns Promise<void>

ProtectedreadTasks

Parameters

Returns Promise<undefined | (TaskConfiguration | TaskCustomization)[]>

ProtectedrefreshTasks

Parameters

Returns Promise<void>

ProtectedreorganizeTasks

Returns void

saveTask

Parameters

Returns Promise<boolean>

setClient

Parameters

Returns void

updateTaskConfig

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`client

`Protected` `Readonly`providedTaskConfigurations

`Protected` `Readonly`taskConfigurationManager

`Protected`taskCustomizationMap

`Protected` `Readonly`taskDefinitionRegistry

`Protected` `Readonly`taskSchemaUpdater

`Protected`tasksMap

`Protected` `Readonly`taskSourceResolver

`Protected` `Readonly`toDispose

`Protected` `Readonly`workspaceService

`Protected`init

`Protected`onDidTaskFileChange

`Protected`readTasks

`Protected`refreshTasks

`Protected`reorganizeTasks