@theia/task 1.45.0 → 1.46.0-next.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/README.md +193 -193
  2. package/lib/browser/index.d.ts +6 -6
  3. package/lib/browser/index.js +33 -33
  4. package/lib/browser/process/process-task-contribution.d.ts +6 -6
  5. package/lib/browser/process/process-task-contribution.js +43 -43
  6. package/lib/browser/process/process-task-frontend-module.d.ts +2 -2
  7. package/lib/browser/process/process-task-frontend-module.js +27 -27
  8. package/lib/browser/process/process-task-resolver.d.ts +17 -17
  9. package/lib/browser/process/process-task-resolver.js +101 -101
  10. package/lib/browser/provided-task-configurations.d.ts +43 -43
  11. package/lib/browser/provided-task-configurations.js +213 -213
  12. package/lib/browser/provided-task-configurations.spec.d.ts +1 -1
  13. package/lib/browser/provided-task-configurations.spec.js +43 -43
  14. package/lib/browser/quick-open-task.d.ts +144 -144
  15. package/lib/browser/quick-open-task.d.ts.map +1 -1
  16. package/lib/browser/quick-open-task.js +752 -748
  17. package/lib/browser/quick-open-task.js.map +1 -1
  18. package/lib/browser/task-configuration-manager.d.ts +64 -64
  19. package/lib/browser/task-configuration-manager.js +261 -261
  20. package/lib/browser/task-configuration-model.d.ts +32 -32
  21. package/lib/browser/task-configuration-model.js +79 -79
  22. package/lib/browser/task-configurations.d.ts +127 -127
  23. package/lib/browser/task-configurations.js +486 -486
  24. package/lib/browser/task-contribution.d.ts +182 -182
  25. package/lib/browser/task-contribution.js +206 -206
  26. package/lib/browser/task-definition-registry.d.ts +38 -38
  27. package/lib/browser/task-definition-registry.js +134 -134
  28. package/lib/browser/task-definition-registry.spec.d.ts +1 -1
  29. package/lib/browser/task-definition-registry.spec.js +170 -170
  30. package/lib/browser/task-frontend-contribution.d.ts +56 -56
  31. package/lib/browser/task-frontend-contribution.js +358 -358
  32. package/lib/browser/task-frontend-module.d.ts +5 -5
  33. package/lib/browser/task-frontend-module.js +79 -79
  34. package/lib/browser/task-name-resolver.d.ts +13 -13
  35. package/lib/browser/task-name-resolver.js +67 -67
  36. package/lib/browser/task-node.d.ts +9 -9
  37. package/lib/browser/task-node.js +17 -17
  38. package/lib/browser/task-preferences.d.ts +4 -4
  39. package/lib/browser/task-preferences.js +40 -40
  40. package/lib/browser/task-problem-matcher-registry.d.ts +40 -40
  41. package/lib/browser/task-problem-matcher-registry.js +309 -309
  42. package/lib/browser/task-problem-pattern-registry.d.ts +23 -23
  43. package/lib/browser/task-problem-pattern-registry.js +210 -210
  44. package/lib/browser/task-schema-updater.d.ts +58 -58
  45. package/lib/browser/task-schema-updater.js +688 -688
  46. package/lib/browser/task-service.d.ts +279 -279
  47. package/lib/browser/task-service.js +1119 -1119
  48. package/lib/browser/task-source-resolver.d.ts +9 -9
  49. package/lib/browser/task-source-resolver.js +51 -51
  50. package/lib/browser/task-templates.d.ts +13 -13
  51. package/lib/browser/task-templates.js +161 -161
  52. package/lib/browser/task-terminal-widget-manager.d.ts +44 -44
  53. package/lib/browser/task-terminal-widget-manager.js +228 -228
  54. package/lib/browser/tasks-monaco-contribution.d.ts +1 -1
  55. package/lib/browser/tasks-monaco-contribution.js +27 -27
  56. package/lib/common/index.d.ts +4 -4
  57. package/lib/common/index.js +31 -31
  58. package/lib/common/problem-matcher-protocol.d.ts +124 -124
  59. package/lib/common/problem-matcher-protocol.js +132 -132
  60. package/lib/common/process/task-protocol.d.ts +68 -68
  61. package/lib/common/process/task-protocol.js +33 -33
  62. package/lib/common/task-common-module.d.ts +7 -7
  63. package/lib/common/task-common-module.js +33 -33
  64. package/lib/common/task-protocol.d.ts +192 -192
  65. package/lib/common/task-protocol.js +137 -137
  66. package/lib/common/task-util.d.ts +22 -22
  67. package/lib/common/task-util.js +46 -46
  68. package/lib/common/task-watcher.d.ts +17 -17
  69. package/lib/common/task-watcher.js +86 -86
  70. package/lib/node/custom/custom-task-runner-backend-module.d.ts +2 -2
  71. package/lib/node/custom/custom-task-runner-backend-module.js +36 -36
  72. package/lib/node/custom/custom-task-runner-contribution.d.ts +6 -6
  73. package/lib/node/custom/custom-task-runner-contribution.js +42 -42
  74. package/lib/node/custom/custom-task-runner.d.ts +15 -15
  75. package/lib/node/custom/custom-task-runner.js +69 -69
  76. package/lib/node/custom/custom-task.d.ts +20 -20
  77. package/lib/node/custom/custom-task.js +78 -78
  78. package/lib/node/index.d.ts +3 -3
  79. package/lib/node/index.js +30 -30
  80. package/lib/node/process/process-task-runner-backend-module.d.ts +2 -2
  81. package/lib/node/process/process-task-runner-backend-module.js +36 -36
  82. package/lib/node/process/process-task-runner-contribution.d.ts +6 -6
  83. package/lib/node/process/process-task-runner-contribution.js +43 -43
  84. package/lib/node/process/process-task-runner.d.ts +60 -60
  85. package/lib/node/process/process-task-runner.js +355 -355
  86. package/lib/node/process/process-task.d.ts +26 -26
  87. package/lib/node/process/process-task.js +135 -135
  88. package/lib/node/process/process-task.spec.d.ts +1 -1
  89. package/lib/node/process/process-task.spec.js +29 -29
  90. package/lib/node/task-abstract-line-matcher.d.ts +49 -49
  91. package/lib/node/task-abstract-line-matcher.js +273 -273
  92. package/lib/node/task-backend-application-contribution.d.ts +8 -8
  93. package/lib/node/task-backend-application-contribution.js +48 -48
  94. package/lib/node/task-backend-module.d.ts +3 -3
  95. package/lib/node/task-backend-module.js +50 -50
  96. package/lib/node/task-line-matchers.d.ts +27 -27
  97. package/lib/node/task-line-matchers.js +121 -121
  98. package/lib/node/task-manager.d.ts +55 -55
  99. package/lib/node/task-manager.js +135 -135
  100. package/lib/node/task-problem-collector.d.ts +10 -10
  101. package/lib/node/task-problem-collector.js +57 -57
  102. package/lib/node/task-problem-collector.spec.d.ts +1 -1
  103. package/lib/node/task-problem-collector.spec.js +310 -310
  104. package/lib/node/task-runner-protocol.d.ts +16 -16
  105. package/lib/node/task-runner-protocol.js +19 -19
  106. package/lib/node/task-runner.d.ts +50 -50
  107. package/lib/node/task-runner.js +97 -97
  108. package/lib/node/task-server.d.ts +39 -39
  109. package/lib/node/task-server.js +237 -237
  110. package/lib/node/task-server.slow-spec.d.ts +1 -1
  111. package/lib/node/task-server.slow-spec.js +395 -395
  112. package/lib/node/task.d.ts +50 -50
  113. package/lib/node/task.js +77 -77
  114. package/lib/node/test/task-test-container.d.ts +2 -2
  115. package/lib/node/test/task-test-container.js +58 -58
  116. package/package.json +14 -14
  117. package/src/browser/index.ts +22 -22
  118. package/src/browser/process/process-task-contribution.ts +31 -31
  119. package/src/browser/process/process-task-frontend-module.ts +27 -27
  120. package/src/browser/process/process-task-resolver.ts +89 -89
  121. package/src/browser/provided-task-configurations.spec.ts +46 -46
  122. package/src/browser/provided-task-configurations.ts +213 -213
  123. package/src/browser/quick-open-task.ts +831 -827
  124. package/src/browser/style/index.css +19 -19
  125. package/src/browser/task-configuration-manager.ts +256 -256
  126. package/src/browser/task-configuration-model.ts +101 -101
  127. package/src/browser/task-configurations.ts +508 -508
  128. package/src/browser/task-contribution.ts +266 -266
  129. package/src/browser/task-definition-registry.spec.ts +203 -203
  130. package/src/browser/task-definition-registry.ts +131 -131
  131. package/src/browser/task-frontend-contribution.ts +402 -402
  132. package/src/browser/task-frontend-module.ts +86 -86
  133. package/src/browser/task-name-resolver.ts +55 -55
  134. package/src/browser/task-node.ts +37 -37
  135. package/src/browser/task-preferences.ts +40 -40
  136. package/src/browser/task-problem-matcher-registry.ts +308 -308
  137. package/src/browser/task-problem-pattern-registry.ts +196 -196
  138. package/src/browser/task-schema-updater.ts +701 -701
  139. package/src/browser/task-service.ts +1164 -1164
  140. package/src/browser/task-source-resolver.ts +36 -36
  141. package/src/browser/task-templates.ts +168 -168
  142. package/src/browser/task-terminal-widget-manager.ts +224 -224
  143. package/src/browser/tasks-monaco-contribution.ts +27 -27
  144. package/src/common/index.ts +20 -20
  145. package/src/common/problem-matcher-protocol.ts +234 -234
  146. package/src/common/process/task-protocol.ts +97 -97
  147. package/src/common/task-common-module.ts +34 -34
  148. package/src/common/task-protocol.ts +317 -317
  149. package/src/common/task-util.ts +43 -43
  150. package/src/common/task-watcher.ts +78 -78
  151. package/src/node/custom/custom-task-runner-backend-module.ts +37 -37
  152. package/src/node/custom/custom-task-runner-contribution.ts +30 -30
  153. package/src/node/custom/custom-task-runner.ts +60 -60
  154. package/src/node/custom/custom-task.ts +73 -73
  155. package/src/node/index.ts +19 -19
  156. package/src/node/process/process-task-runner-backend-module.ts +37 -37
  157. package/src/node/process/process-task-runner-contribution.ts +31 -31
  158. package/src/node/process/process-task-runner.ts +371 -371
  159. package/src/node/process/process-task.spec.ts +30 -30
  160. package/src/node/process/process-task.ts +144 -144
  161. package/src/node/task-abstract-line-matcher.ts +312 -312
  162. package/src/node/task-backend-application-contribution.ts +36 -36
  163. package/src/node/task-backend-module.ts +57 -57
  164. package/src/node/task-line-matchers.ts +127 -127
  165. package/src/node/task-manager.ts +129 -129
  166. package/src/node/task-problem-collector.spec.ts +338 -338
  167. package/src/node/task-problem-collector.ts +62 -62
  168. package/src/node/task-runner-protocol.ts +33 -33
  169. package/src/node/task-runner.ts +96 -96
  170. package/src/node/task-server.slow-spec.ts +444 -444
  171. package/src/node/task-server.ts +263 -263
  172. package/src/node/task.ts +103 -103
  173. package/src/node/test/task-test-container.ts +63 -63
@@ -1,224 +1,224 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
18
- import { ApplicationShell, WidgetOpenerOptions } from '@theia/core/lib/browser';
19
- import { TerminalWidget } from '@theia/terminal/lib/browser/base/terminal-widget';
20
- import { TerminalWidgetFactoryOptions } from '@theia/terminal/lib/browser/terminal-widget-impl';
21
- import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-service';
22
- import { PanelKind, TaskConfiguration, TaskWatcher, TaskExitedEvent, TaskServer, TaskOutputPresentation, TaskInfo } from '../common';
23
- import { ProcessTaskInfo } from '../common/process/task-protocol';
24
- import { TaskDefinitionRegistry } from './task-definition-registry';
25
- import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
26
- import URI from '@theia/core/lib/common/uri';
27
-
28
- export interface TaskTerminalWidget extends TerminalWidget {
29
- readonly kind: 'task';
30
- dedicated?: boolean;
31
- taskId?: number;
32
- taskConfig?: TaskConfiguration;
33
- busy?: boolean;
34
- }
35
- export namespace TaskTerminalWidget {
36
- export function is(widget: TerminalWidget): widget is TaskTerminalWidget {
37
- return widget.kind === 'task';
38
- }
39
- }
40
-
41
- export interface TaskTerminalWidgetOpenerOptions extends WidgetOpenerOptions {
42
- taskConfig?: TaskConfiguration;
43
- taskInfo?: TaskInfo;
44
- }
45
- export namespace TaskTerminalWidgetOpenerOptions {
46
- export function isDedicatedTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
47
- const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
48
- return !!taskConfig && !!taskConfig.presentation && taskConfig.presentation.panel === PanelKind.Dedicated;
49
- }
50
-
51
- export function isNewTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
52
- const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
53
- return !!taskConfig && !!taskConfig.presentation && taskConfig.presentation.panel === PanelKind.New;
54
- }
55
-
56
- export function isSharedTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
57
- const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
58
- return !!taskConfig && (taskConfig.presentation === undefined || taskConfig.presentation.panel === undefined || taskConfig.presentation.panel === PanelKind.Shared);
59
- }
60
-
61
- export function echoExecutedCommand(options: TaskTerminalWidgetOpenerOptions): boolean {
62
- const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
63
- return !!taskConfig && (taskConfig.presentation === undefined || taskConfig.presentation.echo === undefined || taskConfig.presentation.echo);
64
- }
65
- }
66
-
67
- @injectable()
68
- export class TaskTerminalWidgetManager {
69
-
70
- @inject(ApplicationShell)
71
- protected readonly shell: ApplicationShell;
72
-
73
- @inject(TaskDefinitionRegistry)
74
- protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
75
-
76
- @inject(TerminalService)
77
- protected readonly terminalService: TerminalService;
78
-
79
- @inject(TaskWatcher)
80
- protected readonly taskWatcher: TaskWatcher;
81
-
82
- @inject(TaskServer)
83
- protected readonly taskServer: TaskServer;
84
-
85
- @inject(WorkspaceService)
86
- protected readonly workspaceService: WorkspaceService;
87
-
88
- @postConstruct()
89
- protected init(): void {
90
- this.taskWatcher.onTaskExit((event: TaskExitedEvent) => {
91
- const finishedTaskId = event.taskId;
92
- // find the terminal where the task ran, and mark it as "idle"
93
- for (const terminal of this.getTaskTerminalWidgets()) {
94
- if (terminal.taskId === finishedTaskId) {
95
- const showReuseMessage = !!event.config && TaskOutputPresentation.shouldShowReuseMessage(event.config);
96
- const closeOnFinish = !!event.config && TaskOutputPresentation.shouldCloseTerminalOnFinish(event.config);
97
- this.updateTerminalOnTaskExit(terminal, showReuseMessage, closeOnFinish);
98
- break;
99
- }
100
- }
101
- });
102
-
103
- this.terminalService.onDidCreateTerminal(async (widget: TerminalWidget) => {
104
- const terminal = TaskTerminalWidget.is(widget) && widget;
105
- if (terminal) {
106
- const didConnectListener = terminal.onDidOpen(async () => {
107
- const context = this.workspaceService?.workspace?.resource.toString();
108
- const tasksInfo = await this.taskServer.getTasks(context);
109
- const taskInfo = tasksInfo.find(info => info.terminalId === widget.terminalId);
110
- if (taskInfo) {
111
- const taskConfig = taskInfo.config;
112
- terminal.dedicated = !!taskConfig.presentation && !!taskConfig.presentation.panel && taskConfig.presentation.panel === PanelKind.Dedicated;
113
- terminal.taskId = taskInfo.taskId;
114
- terminal.taskConfig = taskConfig;
115
- terminal.busy = true;
116
- } else {
117
- this.updateTerminalOnTaskExit(terminal, true, false);
118
- }
119
- });
120
- const didConnectFailureListener = terminal.onDidOpenFailure(async () => {
121
- this.updateTerminalOnTaskExit(terminal, true, false);
122
- });
123
- terminal.onDidDispose(() => {
124
- didConnectListener.dispose();
125
- didConnectFailureListener.dispose();
126
- });
127
- }
128
- });
129
- }
130
-
131
- async newTaskTerminal(factoryOptions: TerminalWidgetFactoryOptions): Promise<TerminalWidget> {
132
- return this.terminalService.newTerminal({ ...factoryOptions, kind: 'task' });
133
- }
134
-
135
- async open(factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions): Promise<TerminalWidget> {
136
- const taskInfo = openerOptions.taskInfo;
137
- const taskConfig = taskInfo ? taskInfo.config : openerOptions.taskConfig;
138
- const dedicated = TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions);
139
- if (dedicated && !taskConfig) {
140
- throw new Error('"taskConfig" must be included as part of the "option.taskInfo" if "isDedicated" is true');
141
- }
142
-
143
- const { isNew, widget } = await this.getWidgetToRunTask(factoryOptions, openerOptions);
144
- if (isNew) {
145
- this.shell.addWidget(widget, { area: openerOptions.widgetOptions ? openerOptions.widgetOptions.area : 'bottom' });
146
- widget.resetTerminal();
147
- } else {
148
- if (factoryOptions.title) {
149
- widget.setTitle(factoryOptions.title);
150
- }
151
- if (taskConfig && TaskOutputPresentation.shouldClearTerminalBeforeRun(taskConfig)) {
152
- widget.clearOutput();
153
- }
154
- }
155
- this.terminalService.open(widget, openerOptions);
156
-
157
- if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) &&
158
- taskInfo && ProcessTaskInfo.is(taskInfo) && taskInfo.command && taskInfo.command.length > 0
159
- ) {
160
- widget.writeLine(`\x1b[1m> Executing task: ${taskInfo.command} <\x1b[0m\n`);
161
- }
162
- return widget;
163
- }
164
-
165
- protected async getWidgetToRunTask(
166
- factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions
167
- ): Promise<{ isNew: boolean, widget: TerminalWidget }> {
168
- let reusableTerminalWidget: TerminalWidget | undefined;
169
- const taskConfig = openerOptions.taskInfo ? openerOptions.taskInfo.config : openerOptions.taskConfig;
170
- if (TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions)) {
171
- for (const widget of this.getTaskTerminalWidgets()) {
172
- // to run a task whose `taskPresentation === 'dedicated'`, the terminal to be reused must be
173
- // 1) dedicated, 2) idle, 3) the one that ran the same task
174
- if (widget.dedicated &&
175
- !widget.busy &&
176
- widget.taskConfig && taskConfig &&
177
- this.taskDefinitionRegistry.compareTasks(taskConfig, widget.taskConfig)) {
178
-
179
- reusableTerminalWidget = widget;
180
- break;
181
- }
182
- }
183
- } else if (TaskTerminalWidgetOpenerOptions.isSharedTerminal(openerOptions)) {
184
- const availableWidgets: TerminalWidget[] = [];
185
- for (const widget of this.getTaskTerminalWidgets()) {
186
- // to run a task whose `taskPresentation === 'shared'`, the terminal to be used must be
187
- // 1) not dedicated, and 2) idle
188
- if (!widget.dedicated && !widget.busy) {
189
- availableWidgets.push(widget);
190
- }
191
- }
192
- const lastUsedWidget = availableWidgets.find(w => {
193
- const lastUsedTerminal = this.terminalService.lastUsedTerminal;
194
- return lastUsedTerminal && lastUsedTerminal.id === w.id;
195
- });
196
- reusableTerminalWidget = lastUsedWidget || availableWidgets[0];
197
- }
198
-
199
- // we are unable to find a terminal widget to run the task, or `taskPresentation === 'new'`
200
- const lastCwd = taskConfig?.options?.cwd ? new URI(taskConfig.options.cwd) : new URI();
201
-
202
- if (!reusableTerminalWidget) {
203
- const widget = await this.newTaskTerminal(factoryOptions);
204
- widget.lastCwd = lastCwd;
205
- return { isNew: true, widget };
206
- }
207
- reusableTerminalWidget.lastCwd = lastCwd;
208
- return { isNew: false, widget: reusableTerminalWidget };
209
- }
210
-
211
- protected getTaskTerminalWidgets(): TaskTerminalWidget[] {
212
- return this.terminalService.all.filter(TaskTerminalWidget.is);
213
- }
214
-
215
- protected updateTerminalOnTaskExit(terminal: TaskTerminalWidget, showReuseMessage: boolean, closeOnFinish: boolean): void {
216
- terminal.busy = false;
217
- if (closeOnFinish) {
218
- terminal.close();
219
- } else if (showReuseMessage) {
220
- terminal.scrollToBottom();
221
- terminal.writeLine('\x1b[1m\n\rTerminal will be reused by tasks. \x1b[0m\n');
222
- }
223
- }
224
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
18
+ import { ApplicationShell, WidgetOpenerOptions } from '@theia/core/lib/browser';
19
+ import { TerminalWidget } from '@theia/terminal/lib/browser/base/terminal-widget';
20
+ import { TerminalWidgetFactoryOptions } from '@theia/terminal/lib/browser/terminal-widget-impl';
21
+ import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-service';
22
+ import { PanelKind, TaskConfiguration, TaskWatcher, TaskExitedEvent, TaskServer, TaskOutputPresentation, TaskInfo } from '../common';
23
+ import { ProcessTaskInfo } from '../common/process/task-protocol';
24
+ import { TaskDefinitionRegistry } from './task-definition-registry';
25
+ import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
26
+ import URI from '@theia/core/lib/common/uri';
27
+
28
+ export interface TaskTerminalWidget extends TerminalWidget {
29
+ readonly kind: 'task';
30
+ dedicated?: boolean;
31
+ taskId?: number;
32
+ taskConfig?: TaskConfiguration;
33
+ busy?: boolean;
34
+ }
35
+ export namespace TaskTerminalWidget {
36
+ export function is(widget: TerminalWidget): widget is TaskTerminalWidget {
37
+ return widget.kind === 'task';
38
+ }
39
+ }
40
+
41
+ export interface TaskTerminalWidgetOpenerOptions extends WidgetOpenerOptions {
42
+ taskConfig?: TaskConfiguration;
43
+ taskInfo?: TaskInfo;
44
+ }
45
+ export namespace TaskTerminalWidgetOpenerOptions {
46
+ export function isDedicatedTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
47
+ const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
48
+ return !!taskConfig && !!taskConfig.presentation && taskConfig.presentation.panel === PanelKind.Dedicated;
49
+ }
50
+
51
+ export function isNewTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
52
+ const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
53
+ return !!taskConfig && !!taskConfig.presentation && taskConfig.presentation.panel === PanelKind.New;
54
+ }
55
+
56
+ export function isSharedTerminal(options: TaskTerminalWidgetOpenerOptions): boolean {
57
+ const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
58
+ return !!taskConfig && (taskConfig.presentation === undefined || taskConfig.presentation.panel === undefined || taskConfig.presentation.panel === PanelKind.Shared);
59
+ }
60
+
61
+ export function echoExecutedCommand(options: TaskTerminalWidgetOpenerOptions): boolean {
62
+ const taskConfig = options.taskInfo ? options.taskInfo.config : options.taskConfig;
63
+ return !!taskConfig && (taskConfig.presentation === undefined || taskConfig.presentation.echo === undefined || taskConfig.presentation.echo);
64
+ }
65
+ }
66
+
67
+ @injectable()
68
+ export class TaskTerminalWidgetManager {
69
+
70
+ @inject(ApplicationShell)
71
+ protected readonly shell: ApplicationShell;
72
+
73
+ @inject(TaskDefinitionRegistry)
74
+ protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
75
+
76
+ @inject(TerminalService)
77
+ protected readonly terminalService: TerminalService;
78
+
79
+ @inject(TaskWatcher)
80
+ protected readonly taskWatcher: TaskWatcher;
81
+
82
+ @inject(TaskServer)
83
+ protected readonly taskServer: TaskServer;
84
+
85
+ @inject(WorkspaceService)
86
+ protected readonly workspaceService: WorkspaceService;
87
+
88
+ @postConstruct()
89
+ protected init(): void {
90
+ this.taskWatcher.onTaskExit((event: TaskExitedEvent) => {
91
+ const finishedTaskId = event.taskId;
92
+ // find the terminal where the task ran, and mark it as "idle"
93
+ for (const terminal of this.getTaskTerminalWidgets()) {
94
+ if (terminal.taskId === finishedTaskId) {
95
+ const showReuseMessage = !!event.config && TaskOutputPresentation.shouldShowReuseMessage(event.config);
96
+ const closeOnFinish = !!event.config && TaskOutputPresentation.shouldCloseTerminalOnFinish(event.config);
97
+ this.updateTerminalOnTaskExit(terminal, showReuseMessage, closeOnFinish);
98
+ break;
99
+ }
100
+ }
101
+ });
102
+
103
+ this.terminalService.onDidCreateTerminal(async (widget: TerminalWidget) => {
104
+ const terminal = TaskTerminalWidget.is(widget) && widget;
105
+ if (terminal) {
106
+ const didConnectListener = terminal.onDidOpen(async () => {
107
+ const context = this.workspaceService?.workspace?.resource.toString();
108
+ const tasksInfo = await this.taskServer.getTasks(context);
109
+ const taskInfo = tasksInfo.find(info => info.terminalId === widget.terminalId);
110
+ if (taskInfo) {
111
+ const taskConfig = taskInfo.config;
112
+ terminal.dedicated = !!taskConfig.presentation && !!taskConfig.presentation.panel && taskConfig.presentation.panel === PanelKind.Dedicated;
113
+ terminal.taskId = taskInfo.taskId;
114
+ terminal.taskConfig = taskConfig;
115
+ terminal.busy = true;
116
+ } else {
117
+ this.updateTerminalOnTaskExit(terminal, true, false);
118
+ }
119
+ });
120
+ const didConnectFailureListener = terminal.onDidOpenFailure(async () => {
121
+ this.updateTerminalOnTaskExit(terminal, true, false);
122
+ });
123
+ terminal.onDidDispose(() => {
124
+ didConnectListener.dispose();
125
+ didConnectFailureListener.dispose();
126
+ });
127
+ }
128
+ });
129
+ }
130
+
131
+ async newTaskTerminal(factoryOptions: TerminalWidgetFactoryOptions): Promise<TerminalWidget> {
132
+ return this.terminalService.newTerminal({ ...factoryOptions, kind: 'task' });
133
+ }
134
+
135
+ async open(factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions): Promise<TerminalWidget> {
136
+ const taskInfo = openerOptions.taskInfo;
137
+ const taskConfig = taskInfo ? taskInfo.config : openerOptions.taskConfig;
138
+ const dedicated = TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions);
139
+ if (dedicated && !taskConfig) {
140
+ throw new Error('"taskConfig" must be included as part of the "option.taskInfo" if "isDedicated" is true');
141
+ }
142
+
143
+ const { isNew, widget } = await this.getWidgetToRunTask(factoryOptions, openerOptions);
144
+ if (isNew) {
145
+ this.shell.addWidget(widget, { area: openerOptions.widgetOptions ? openerOptions.widgetOptions.area : 'bottom' });
146
+ widget.resetTerminal();
147
+ } else {
148
+ if (factoryOptions.title) {
149
+ widget.setTitle(factoryOptions.title);
150
+ }
151
+ if (taskConfig && TaskOutputPresentation.shouldClearTerminalBeforeRun(taskConfig)) {
152
+ widget.clearOutput();
153
+ }
154
+ }
155
+ this.terminalService.open(widget, openerOptions);
156
+
157
+ if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) &&
158
+ taskInfo && ProcessTaskInfo.is(taskInfo) && taskInfo.command && taskInfo.command.length > 0
159
+ ) {
160
+ widget.writeLine(`\x1b[1m> Executing task: ${taskInfo.command} <\x1b[0m\n`);
161
+ }
162
+ return widget;
163
+ }
164
+
165
+ protected async getWidgetToRunTask(
166
+ factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions
167
+ ): Promise<{ isNew: boolean, widget: TerminalWidget }> {
168
+ let reusableTerminalWidget: TerminalWidget | undefined;
169
+ const taskConfig = openerOptions.taskInfo ? openerOptions.taskInfo.config : openerOptions.taskConfig;
170
+ if (TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions)) {
171
+ for (const widget of this.getTaskTerminalWidgets()) {
172
+ // to run a task whose `taskPresentation === 'dedicated'`, the terminal to be reused must be
173
+ // 1) dedicated, 2) idle, 3) the one that ran the same task
174
+ if (widget.dedicated &&
175
+ !widget.busy &&
176
+ widget.taskConfig && taskConfig &&
177
+ this.taskDefinitionRegistry.compareTasks(taskConfig, widget.taskConfig)) {
178
+
179
+ reusableTerminalWidget = widget;
180
+ break;
181
+ }
182
+ }
183
+ } else if (TaskTerminalWidgetOpenerOptions.isSharedTerminal(openerOptions)) {
184
+ const availableWidgets: TerminalWidget[] = [];
185
+ for (const widget of this.getTaskTerminalWidgets()) {
186
+ // to run a task whose `taskPresentation === 'shared'`, the terminal to be used must be
187
+ // 1) not dedicated, and 2) idle
188
+ if (!widget.dedicated && !widget.busy) {
189
+ availableWidgets.push(widget);
190
+ }
191
+ }
192
+ const lastUsedWidget = availableWidgets.find(w => {
193
+ const lastUsedTerminal = this.terminalService.lastUsedTerminal;
194
+ return lastUsedTerminal && lastUsedTerminal.id === w.id;
195
+ });
196
+ reusableTerminalWidget = lastUsedWidget || availableWidgets[0];
197
+ }
198
+
199
+ // we are unable to find a terminal widget to run the task, or `taskPresentation === 'new'`
200
+ const lastCwd = taskConfig?.options?.cwd ? new URI(taskConfig.options.cwd) : new URI();
201
+
202
+ if (!reusableTerminalWidget) {
203
+ const widget = await this.newTaskTerminal(factoryOptions);
204
+ widget.lastCwd = lastCwd;
205
+ return { isNew: true, widget };
206
+ }
207
+ reusableTerminalWidget.lastCwd = lastCwd;
208
+ return { isNew: false, widget: reusableTerminalWidget };
209
+ }
210
+
211
+ protected getTaskTerminalWidgets(): TaskTerminalWidget[] {
212
+ return this.terminalService.all.filter(TaskTerminalWidget.is);
213
+ }
214
+
215
+ protected updateTerminalOnTaskExit(terminal: TaskTerminalWidget, showReuseMessage: boolean, closeOnFinish: boolean): void {
216
+ terminal.busy = false;
217
+ if (closeOnFinish) {
218
+ terminal.close();
219
+ } else if (showReuseMessage) {
220
+ terminal.scrollToBottom();
221
+ terminal.writeLine('\x1b[1m\n\rTerminal will be reused by tasks. \x1b[0m\n');
222
+ }
223
+ }
224
+ }
@@ -1,27 +1,27 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2019 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import * as monaco from '@theia/monaco-editor-core';
18
-
19
- monaco.languages.register({
20
- id: 'jsonc',
21
- 'aliases': [
22
- 'JSON with Comments'
23
- ],
24
- 'filenames': [
25
- 'tasks.json'
26
- ]
27
- });
1
+ // *****************************************************************************
2
+ // Copyright (C) 2019 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import * as monaco from '@theia/monaco-editor-core';
18
+
19
+ monaco.languages.register({
20
+ id: 'jsonc',
21
+ 'aliases': [
22
+ 'JSON with Comments'
23
+ ],
24
+ 'filenames': [
25
+ 'tasks.json'
26
+ ]
27
+ });
@@ -1,20 +1,20 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2018 Red Hat, Inc. and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- export * from './task-protocol';
18
- export * from './task-watcher';
19
- export * from './problem-matcher-protocol';
20
- export * from './task-util';
1
+ // *****************************************************************************
2
+ // Copyright (C) 2018 Red Hat, Inc. and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ export * from './task-protocol';
18
+ export * from './task-watcher';
19
+ export * from './problem-matcher-protocol';
20
+ export * from './task-util';