From 12017ab6ff9968ea9f093eefe94c5a0a847d6fab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=A4der?= Date: Tue, 29 Nov 2022 08:38:31 +0100 Subject: [PATCH 1/2] Add support for TaskGroup.id and isDefault. Fixes #11519 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds support for id and isDefault and includes a small drive-by fix in the Task implementation where the taskRunOptions object was not properly initialized. Contributed on behalf of ST Microelectronics Signed-off-by: Thomas Mäder --- .../plugin-ext/src/common/plugin-api-rpc.ts | 6 ++++- .../plugin-ext/src/main/browser/tasks-main.ts | 22 +++++++++++-------- .../src/plugin/type-converters.spec.ts | 6 +++-- .../plugin-ext/src/plugin/type-converters.ts | 22 +++++++++---------- packages/plugin-ext/src/plugin/types-impl.ts | 18 +++++---------- packages/plugin/src/theia.d.ts | 11 ++++++++++ packages/task/src/common/task-protocol.ts | 14 +++++++----- 7 files changed, 58 insertions(+), 41 deletions(-) diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts index 74448ef3edd6a..2969fb3bc35b6 100644 --- a/packages/plugin-ext/src/common/plugin-api-rpc.ts +++ b/packages/plugin-ext/src/common/plugin-api-rpc.ts @@ -1444,6 +1444,7 @@ export interface CommandProperties { }; } +export type TaskGroupKind = 'build' | 'test' | 'rebuild' | 'clean' export interface TaskDto { type: string; taskType?: 'shell' | 'process' | 'customExecution'; // the task execution type @@ -1454,7 +1455,10 @@ export interface TaskDto { // Provide a more specific type when necessary (see ProblemMatcherContribution) // eslint-disable-next-line @typescript-eslint/no-explicit-any problemMatcher?: any; - group?: string; + group?: { + kind: TaskGroupKind; + isDefault: boolean; + } detail?: string; presentation?: TaskPresentationOptionsDTO; runOptions?: RunOptionsDTO; diff --git a/packages/plugin-ext/src/main/browser/tasks-main.ts b/packages/plugin-ext/src/main/browser/tasks-main.ts index 95310e5bd8c0c..6ae5fbc722995 100644 --- a/packages/plugin-ext/src/main/browser/tasks-main.ts +++ b/packages/plugin-ext/src/main/browser/tasks-main.ts @@ -26,7 +26,7 @@ import { RPCProtocol } from '../../common/rpc-protocol'; import { Disposable, DisposableCollection } from '@theia/core/lib/common'; import { TaskProviderRegistry, TaskResolverRegistry, TaskProvider, TaskResolver } from '@theia/task/lib/browser/task-contribution'; import { interfaces } from '@theia/core/shared/inversify'; -import { TaskInfo, TaskExitedEvent, TaskConfiguration, TaskCustomization, TaskOutputPresentation, RevealKind, PanelKind } from '@theia/task/lib/common/task-protocol'; +import { TaskInfo, TaskExitedEvent, TaskConfiguration, TaskOutputPresentation, RevealKind, PanelKind } from '@theia/task/lib/common/task-protocol'; import { TaskWatcher } from '@theia/task/lib/common/task-watcher'; import { TaskService } from '@theia/task/lib/browser/task-service'; import { TaskDefinitionRegistry } from '@theia/task/lib/browser'; @@ -207,8 +207,11 @@ export class TasksMainImpl implements TasksMain, Disposable { if (presentation) { partialConfig.presentation = this.convertTaskPresentation(presentation); } - if (group === 'build' || group === 'test') { - partialConfig.group = group; + if (group) { + partialConfig.group = { + kind: group.kind, + isDefault: group.isDefault + }; } return { ...common, @@ -225,12 +228,13 @@ export class TasksMainImpl implements TasksMain, Disposable { if (presentation) { partialDto.presentation = this.convertTaskPresentation(presentation); } - if (group) { - if (TaskCustomization.isBuildTask(task)) { - partialDto.group = 'build'; - } else if (TaskCustomization.isTestTask(task)) { - partialDto.group = 'test'; - } + if (group === 'build' || group === 'test') { + partialDto.group = { + kind: group, + isDefault: false + }; + } else if (typeof group === 'object') { + partialDto.group = group; } return { ...common, diff --git a/packages/plugin-ext/src/plugin/type-converters.spec.ts b/packages/plugin-ext/src/plugin/type-converters.spec.ts index 215872b8ea479..f7ad3e364301f 100644 --- a/packages/plugin-ext/src/plugin/type-converters.spec.ts +++ b/packages/plugin-ext/src/plugin/type-converters.spec.ts @@ -185,7 +185,6 @@ describe('Type converters:', () => { const args = ['run', 'build']; const cwd = '/projects/theia'; const additionalProperty = 'some property'; - const groupDto = 'build'; const group = TaskGroup.Build; const shellTaskDto: TaskDto = { @@ -202,7 +201,10 @@ describe('Type converters:', () => { reveal: 3, focus: true }, - group: groupDto, + group: { + kind: 'build', + isDefault: false + }, runOptions: { reevaluateOnRerun: false } diff --git a/packages/plugin-ext/src/plugin/type-converters.ts b/packages/plugin-ext/src/plugin/type-converters.ts index 1a7894d6346e0..f87c25527ebcd 100644 --- a/packages/plugin-ext/src/plugin/type-converters.ts +++ b/packages/plugin-ext/src/plugin/type-converters.ts @@ -31,8 +31,6 @@ import { MarkdownString as MarkdownStringDTO } from '@theia/core/lib/common/mark const SIDE_GROUP = -2; const ACTIVE_GROUP = -1; -const BUILD_GROUP = 'build'; -const TEST_GROUP = 'test'; export function toViewColumn(ep?: EditorPosition): theia.ViewColumn | undefined { if (typeof ep !== 'number') { @@ -846,11 +844,11 @@ export function fromTask(task: theia.Task): TaskDto | undefined { taskDto.presentation = task.presentationOptions; } - const group = task.group; - if (group === types.TaskGroup.Build) { - taskDto.group = BUILD_GROUP; - } else if (group === types.TaskGroup.Test) { - taskDto.group = TEST_GROUP; + if (task.group) { + taskDto.group = { + kind: task.group.id, + isDefault: !!task.group.isDefault + }; } const taskDefinition = task.definition; @@ -936,11 +934,11 @@ export function toTask(taskDto: TaskDto): theia.Task { } if (group) { - if (group === BUILD_GROUP) { - result.group = types.TaskGroup.Build; - } else if (group === TEST_GROUP) { - result.group = types.TaskGroup.Test; - } + result.group = new types.TaskGroup( + group.kind, + group.kind, + group.isDefault + ); } if (presentation) { diff --git a/packages/plugin-ext/src/plugin/types-impl.ts b/packages/plugin-ext/src/plugin/types-impl.ts index 1ff5649ca8b57..4cfbe31eb1dcd 100644 --- a/packages/plugin-ext/src/plugin/types-impl.ts +++ b/packages/plugin-ext/src/plugin/types-impl.ts @@ -2008,7 +2008,6 @@ export class CustomExecution { @es5ClassCompat export class TaskGroup { - private groupId: string; public static Clean: TaskGroup = new TaskGroup('clean', 'Clean'); public static Build: TaskGroup = new TaskGroup('build', 'Build'); @@ -2030,19 +2029,13 @@ export class TaskGroup { } } - constructor(id: string, label: string) { - if (typeof id !== 'string') { - throw illegalArgument('id'); - } - if (typeof label !== 'string') { - throw illegalArgument('name'); - } - this.groupId = id; + constructor(id: 'clean' | 'build' | 'rebuild' | 'test', label: string); + constructor(id: 'clean' | 'build' | 'rebuild' | 'test', label: string, isDefault?: boolean | undefined); + constructor(readonly id: 'clean' | 'build' | 'rebuild' | 'test', label: string, isDefault?: boolean | undefined) { + this.isDefault = !!isDefault; } - get id(): string { - return this.groupId; - } + readonly isDefault: boolean; } export enum TaskScope { @@ -2127,6 +2120,7 @@ export class Task { } this.isTaskBackground = false; this.presentationOptions = Object.create(null); + this.taskRunOptions = Object.create(null); } get definition(): theia.TaskDefinition { diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts index 885b163ef018b..869976cc8b36e 100644 --- a/packages/plugin/src/theia.d.ts +++ b/packages/plugin/src/theia.d.ts @@ -11513,6 +11513,17 @@ export module '@theia/plugin' { /** The test all task group */ static Test: TaskGroup; + /** + * Whether the task that is part of this group is the default for the group. + * This property cannot be set through API, and is controlled by a user's task configurations. + */ + readonly isDefault: boolean | undefined; + + /** + * The ID of the task group. Is one of TaskGroup.Clean.id, TaskGroup.Build.id, TaskGroup.Rebuild.id, or TaskGroup.Test.id. + */ + readonly id: string; + private constructor(id: string, label: string); } diff --git a/packages/task/src/common/task-protocol.ts b/packages/task/src/common/task-protocol.ts index 8984e3d0f1b07..439a79a848d08 100644 --- a/packages/task/src/common/task-protocol.ts +++ b/packages/task/src/common/task-protocol.ts @@ -115,7 +115,7 @@ export namespace TaskOutputPresentation { export interface TaskCustomization { type: string; - group?: 'build' | 'test' | 'none' | { kind: 'build' | 'test', isDefault: true }; + group?: 'build' | 'test' | 'rebuild' | 'clean' | 'none' | { kind: 'build' | 'test' | 'rebuild' | 'clean', isDefault: boolean }; problemMatcher?: string | ProblemMatcherContribution | (string | ProblemMatcherContribution)[]; presentation?: TaskOutputPresentation; detail?: string; @@ -136,19 +136,23 @@ export interface TaskCustomization { } export namespace TaskCustomization { export function isBuildTask(task: TaskCustomization): boolean { - return task.group === 'build' || !!task.group && typeof task.group === 'object' && task.group.kind === 'build'; + return task.group === 'build' || typeof task.group === 'object' && task.group.kind === 'build'; } export function isDefaultBuildTask(task: TaskCustomization): boolean { - return !!task.group && typeof task.group === 'object' && task.group.kind === 'build' && task.group.isDefault; + return isDefaultTask(task) && isBuildTask(task); + } + + export function isDefaultTask(task: TaskCustomization): boolean { + return typeof task.group === 'object' && task.group.isDefault; } export function isTestTask(task: TaskCustomization): boolean { - return task.group === 'test' || !!task.group && typeof task.group === 'object' && task.group.kind === 'test'; + return task.group === 'test' || typeof task.group === 'object' && task.group.kind === 'test'; } export function isDefaultTestTask(task: TaskCustomization): boolean { - return !!task.group && typeof task.group === 'object' && task.group.kind === 'test' && task.group.isDefault; + return isDefaultTask(task) && isTestTask(task); } } From 2ccacfe150db739cbf6a2fc2509cdf84ce799983 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=A4der?= Date: Fri, 2 Dec 2022 14:23:31 +0100 Subject: [PATCH 2/2] fix tests and linting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Thomas Mäder --- packages/plugin-ext/src/common/plugin-api-rpc.ts | 2 +- packages/plugin-ext/src/plugin/type-converters.spec.ts | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts index 2969fb3bc35b6..9ec9307f24ad5 100644 --- a/packages/plugin-ext/src/common/plugin-api-rpc.ts +++ b/packages/plugin-ext/src/common/plugin-api-rpc.ts @@ -1444,7 +1444,7 @@ export interface CommandProperties { }; } -export type TaskGroupKind = 'build' | 'test' | 'rebuild' | 'clean' +export type TaskGroupKind = 'build' | 'test' | 'rebuild' | 'clean'; export interface TaskDto { type: string; taskType?: 'shell' | 'process' | 'customExecution'; // the task execution type diff --git a/packages/plugin-ext/src/plugin/type-converters.spec.ts b/packages/plugin-ext/src/plugin/type-converters.spec.ts index f7ad3e364301f..314fc01a11c01 100644 --- a/packages/plugin-ext/src/plugin/type-converters.spec.ts +++ b/packages/plugin-ext/src/plugin/type-converters.spec.ts @@ -22,7 +22,6 @@ import * as model from '../common/plugin-api-rpc-model'; import { MarkdownString } from './markdown-string'; import { MarkdownString as MarkdownStringInterface } from '@theia/core/lib/common/markdown-rendering'; import { TaskDto } from '../common/plugin-api-rpc'; -import { TaskGroup } from './types-impl'; describe('Type converters:', () => { @@ -185,7 +184,7 @@ describe('Type converters:', () => { const args = ['run', 'build']; const cwd = '/projects/theia'; const additionalProperty = 'some property'; - const group = TaskGroup.Build; + const group = new types.TaskGroup('build', 'Build'); const shellTaskDto: TaskDto = { type: shellType,