@theia/task 1.34.2 → 1.34.3

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 (169) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +193 -193
  3. package/lib/browser/index.d.ts +6 -6
  4. package/lib/browser/index.js +33 -33
  5. package/lib/browser/process/process-task-contribution.d.ts +6 -6
  6. package/lib/browser/process/process-task-contribution.js +43 -43
  7. package/lib/browser/process/process-task-frontend-module.d.ts +2 -2
  8. package/lib/browser/process/process-task-frontend-module.js +27 -27
  9. package/lib/browser/process/process-task-resolver.d.ts +17 -17
  10. package/lib/browser/process/process-task-resolver.js +93 -93
  11. package/lib/browser/provided-task-configurations.d.ts +32 -32
  12. package/lib/browser/provided-task-configurations.js +171 -171
  13. package/lib/browser/provided-task-configurations.spec.d.ts +1 -1
  14. package/lib/browser/provided-task-configurations.spec.js +43 -43
  15. package/lib/browser/quick-open-task.d.ts +129 -129
  16. package/lib/browser/quick-open-task.js +636 -636
  17. package/lib/browser/task-configuration-manager.d.ts +64 -64
  18. package/lib/browser/task-configuration-manager.js +261 -261
  19. package/lib/browser/task-configuration-model.d.ts +32 -32
  20. package/lib/browser/task-configuration-model.js +79 -79
  21. package/lib/browser/task-configurations.d.ts +127 -127
  22. package/lib/browser/task-configurations.js +479 -479
  23. package/lib/browser/task-contribution.d.ts +173 -173
  24. package/lib/browser/task-contribution.js +199 -199
  25. package/lib/browser/task-definition-registry.d.ts +38 -38
  26. package/lib/browser/task-definition-registry.js +131 -131
  27. package/lib/browser/task-definition-registry.spec.d.ts +1 -1
  28. package/lib/browser/task-definition-registry.spec.js +170 -170
  29. package/lib/browser/task-frontend-contribution.d.ts +56 -56
  30. package/lib/browser/task-frontend-contribution.js +353 -353
  31. package/lib/browser/task-frontend-module.d.ts +5 -5
  32. package/lib/browser/task-frontend-module.js +79 -79
  33. package/lib/browser/task-name-resolver.d.ts +13 -13
  34. package/lib/browser/task-name-resolver.js +65 -65
  35. package/lib/browser/task-node.d.ts +9 -9
  36. package/lib/browser/task-node.js +17 -17
  37. package/lib/browser/task-preferences.d.ts +4 -4
  38. package/lib/browser/task-preferences.js +40 -40
  39. package/lib/browser/task-problem-matcher-registry.d.ts +40 -40
  40. package/lib/browser/task-problem-matcher-registry.js +310 -310
  41. package/lib/browser/task-problem-pattern-registry.d.ts +23 -23
  42. package/lib/browser/task-problem-pattern-registry.js +208 -208
  43. package/lib/browser/task-schema-updater.d.ts +58 -58
  44. package/lib/browser/task-schema-updater.js +672 -672
  45. package/lib/browser/task-service.d.ts +276 -276
  46. package/lib/browser/task-service.js +1119 -1119
  47. package/lib/browser/task-source-resolver.d.ts +9 -9
  48. package/lib/browser/task-source-resolver.js +51 -51
  49. package/lib/browser/task-templates.d.ts +13 -13
  50. package/lib/browser/task-templates.js +161 -161
  51. package/lib/browser/task-terminal-widget-manager.d.ts +44 -44
  52. package/lib/browser/task-terminal-widget-manager.js +224 -224
  53. package/lib/browser/tasks-monaco-contribution.d.ts +1 -1
  54. package/lib/browser/tasks-monaco-contribution.js +27 -27
  55. package/lib/common/index.d.ts +3 -3
  56. package/lib/common/index.js +30 -30
  57. package/lib/common/problem-matcher-protocol.d.ts +124 -124
  58. package/lib/common/problem-matcher-protocol.js +132 -132
  59. package/lib/common/process/task-protocol.d.ts +68 -68
  60. package/lib/common/process/task-protocol.js +33 -33
  61. package/lib/common/task-common-module.d.ts +7 -7
  62. package/lib/common/task-common-module.js +33 -33
  63. package/lib/common/task-protocol.d.ts +190 -190
  64. package/lib/common/task-protocol.js +125 -125
  65. package/lib/common/task-watcher.d.ts +17 -17
  66. package/lib/common/task-watcher.js +86 -86
  67. package/lib/node/custom/custom-task-runner-backend-module.d.ts +2 -2
  68. package/lib/node/custom/custom-task-runner-backend-module.js +36 -36
  69. package/lib/node/custom/custom-task-runner-contribution.d.ts +6 -6
  70. package/lib/node/custom/custom-task-runner-contribution.js +42 -42
  71. package/lib/node/custom/custom-task-runner.d.ts +15 -15
  72. package/lib/node/custom/custom-task-runner.js +69 -69
  73. package/lib/node/custom/custom-task.d.ts +20 -20
  74. package/lib/node/custom/custom-task.js +78 -78
  75. package/lib/node/index.d.ts +3 -3
  76. package/lib/node/index.js +30 -30
  77. package/lib/node/process/process-task-runner-backend-module.d.ts +2 -2
  78. package/lib/node/process/process-task-runner-backend-module.js +36 -36
  79. package/lib/node/process/process-task-runner-contribution.d.ts +6 -6
  80. package/lib/node/process/process-task-runner-contribution.js +43 -43
  81. package/lib/node/process/process-task-runner.d.ts +60 -60
  82. package/lib/node/process/process-task-runner.js +352 -352
  83. package/lib/node/process/process-task.d.ts +26 -26
  84. package/lib/node/process/process-task.js +139 -139
  85. package/lib/node/process/process-task.spec.d.ts +1 -1
  86. package/lib/node/process/process-task.spec.js +29 -29
  87. package/lib/node/task-abstract-line-matcher.d.ts +49 -49
  88. package/lib/node/task-abstract-line-matcher.js +278 -278
  89. package/lib/node/task-backend-application-contribution.d.ts +8 -8
  90. package/lib/node/task-backend-application-contribution.js +48 -48
  91. package/lib/node/task-backend-module.d.ts +3 -3
  92. package/lib/node/task-backend-module.js +50 -50
  93. package/lib/node/task-line-matchers.d.ts +27 -27
  94. package/lib/node/task-line-matchers.js +121 -121
  95. package/lib/node/task-manager.d.ts +55 -55
  96. package/lib/node/task-manager.js +135 -135
  97. package/lib/node/task-problem-collector.d.ts +10 -10
  98. package/lib/node/task-problem-collector.js +57 -57
  99. package/lib/node/task-problem-collector.spec.d.ts +1 -1
  100. package/lib/node/task-problem-collector.spec.js +310 -310
  101. package/lib/node/task-runner-protocol.d.ts +16 -16
  102. package/lib/node/task-runner-protocol.js +19 -19
  103. package/lib/node/task-runner.d.ts +50 -50
  104. package/lib/node/task-runner.js +97 -97
  105. package/lib/node/task-server.d.ts +39 -39
  106. package/lib/node/task-server.js +237 -237
  107. package/lib/node/task-server.slow-spec.d.ts +1 -1
  108. package/lib/node/task-server.slow-spec.js +395 -395
  109. package/lib/node/task.d.ts +50 -50
  110. package/lib/node/task.js +77 -77
  111. package/lib/node/test/task-test-container.d.ts +2 -2
  112. package/lib/node/test/task-test-container.js +58 -58
  113. package/package.json +13 -13
  114. package/src/browser/index.ts +22 -22
  115. package/src/browser/process/process-task-contribution.ts +31 -31
  116. package/src/browser/process/process-task-frontend-module.ts +27 -27
  117. package/src/browser/process/process-task-resolver.ts +89 -89
  118. package/src/browser/provided-task-configurations.spec.ts +46 -46
  119. package/src/browser/provided-task-configurations.ts +170 -170
  120. package/src/browser/quick-open-task.ts +701 -701
  121. package/src/browser/style/index.css +19 -19
  122. package/src/browser/task-configuration-manager.ts +256 -256
  123. package/src/browser/task-configuration-model.ts +101 -101
  124. package/src/browser/task-configurations.ts +507 -507
  125. package/src/browser/task-contribution.ts +254 -254
  126. package/src/browser/task-definition-registry.spec.ts +203 -203
  127. package/src/browser/task-definition-registry.ts +128 -128
  128. package/src/browser/task-frontend-contribution.ts +396 -396
  129. package/src/browser/task-frontend-module.ts +86 -86
  130. package/src/browser/task-name-resolver.ts +55 -55
  131. package/src/browser/task-node.ts +37 -37
  132. package/src/browser/task-preferences.ts +40 -40
  133. package/src/browser/task-problem-matcher-registry.ts +308 -308
  134. package/src/browser/task-problem-pattern-registry.ts +195 -195
  135. package/src/browser/task-schema-updater.ts +703 -703
  136. package/src/browser/task-service.ts +1163 -1163
  137. package/src/browser/task-source-resolver.ts +36 -36
  138. package/src/browser/task-templates.ts +168 -168
  139. package/src/browser/task-terminal-widget-manager.ts +221 -221
  140. package/src/browser/tasks-monaco-contribution.ts +27 -27
  141. package/src/common/index.ts +19 -19
  142. package/src/common/problem-matcher-protocol.ts +235 -235
  143. package/src/common/process/task-protocol.ts +97 -97
  144. package/src/common/task-common-module.ts +34 -34
  145. package/src/common/task-protocol.ts +310 -310
  146. package/src/common/task-watcher.ts +78 -78
  147. package/src/node/custom/custom-task-runner-backend-module.ts +37 -37
  148. package/src/node/custom/custom-task-runner-contribution.ts +30 -30
  149. package/src/node/custom/custom-task-runner.ts +60 -60
  150. package/src/node/custom/custom-task.ts +73 -73
  151. package/src/node/index.ts +19 -19
  152. package/src/node/process/process-task-runner-backend-module.ts +37 -37
  153. package/src/node/process/process-task-runner-contribution.ts +31 -31
  154. package/src/node/process/process-task-runner.ts +371 -371
  155. package/src/node/process/process-task.spec.ts +30 -30
  156. package/src/node/process/process-task.ts +147 -147
  157. package/src/node/task-abstract-line-matcher.ts +317 -317
  158. package/src/node/task-backend-application-contribution.ts +36 -36
  159. package/src/node/task-backend-module.ts +57 -57
  160. package/src/node/task-line-matchers.ts +127 -127
  161. package/src/node/task-manager.ts +129 -129
  162. package/src/node/task-problem-collector.spec.ts +338 -338
  163. package/src/node/task-problem-collector.ts +62 -62
  164. package/src/node/task-runner-protocol.ts +33 -33
  165. package/src/node/task-runner.ts +96 -96
  166. package/src/node/task-server.slow-spec.ts +444 -444
  167. package/src/node/task-server.ts +263 -263
  168. package/src/node/task.ts +103 -103
  169. package/src/node/test/task-test-container.ts +63 -63
@@ -1,221 +1,221 @@
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 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
- this.notifyTaskFinished(terminal, showReuseMessage);
97
- break;
98
- }
99
- }
100
- });
101
-
102
- this.terminalService.onDidCreateTerminal(async (widget: TerminalWidget) => {
103
- const terminal = TaskTerminalWidget.is(widget) && widget;
104
- if (terminal) {
105
- const didConnectListener = terminal.onDidOpen(async () => {
106
- const context = this.workspaceService?.workspace?.resource.toString();
107
- const tasksInfo = await this.taskServer.getTasks(context);
108
- const taskInfo = tasksInfo.find(info => info.terminalId === widget.terminalId);
109
- if (taskInfo) {
110
- const taskConfig = taskInfo.config;
111
- terminal.dedicated = !!taskConfig.presentation && !!taskConfig.presentation.panel && taskConfig.presentation.panel === PanelKind.Dedicated;
112
- terminal.taskId = taskInfo.taskId;
113
- terminal.taskConfig = taskConfig;
114
- terminal.busy = true;
115
- } else {
116
- this.notifyTaskFinished(terminal, true);
117
- }
118
- });
119
- const didConnectFailureListener = terminal.onDidOpenFailure(async () => {
120
- this.notifyTaskFinished(terminal, true);
121
- });
122
- terminal.onDidDispose(() => {
123
- didConnectListener.dispose();
124
- didConnectFailureListener.dispose();
125
- });
126
- }
127
- });
128
- }
129
-
130
- async newTaskTerminal(factoryOptions: TerminalWidgetFactoryOptions): Promise<TerminalWidget> {
131
- return this.terminalService.newTerminal({ ...factoryOptions, kind: 'task' });
132
- }
133
-
134
- async open(factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions): Promise<TerminalWidget> {
135
- const taskInfo = openerOptions.taskInfo;
136
- const taskConfig = taskInfo ? taskInfo.config : openerOptions.taskConfig;
137
- const dedicated = TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions);
138
- if (dedicated && !taskConfig) {
139
- throw new Error('"taskConfig" must be included as part of the "option.taskInfo" if "isDedicated" is true');
140
- }
141
-
142
- const { isNew, widget } = await this.getWidgetToRunTask(factoryOptions, openerOptions);
143
- if (isNew) {
144
- this.shell.addWidget(widget, { area: openerOptions.widgetOptions ? openerOptions.widgetOptions.area : 'bottom' });
145
- widget.resetTerminal();
146
- } else {
147
- if (factoryOptions.title) {
148
- widget.setTitle(factoryOptions.title);
149
- }
150
- if (taskConfig && TaskOutputPresentation.shouldClearTerminalBeforeRun(taskConfig)) {
151
- widget.clearOutput();
152
- }
153
- }
154
- this.terminalService.open(widget, openerOptions);
155
-
156
- if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) &&
157
- taskInfo && ProcessTaskInfo.is(taskInfo) && taskInfo.command && taskInfo.command.length > 0
158
- ) {
159
- widget.writeLine(`\x1b[1m> Executing task: ${taskInfo.command} <\x1b[0m\n`);
160
- }
161
- return widget;
162
- }
163
-
164
- protected async getWidgetToRunTask(
165
- factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions
166
- ): Promise<{ isNew: boolean, widget: TerminalWidget }> {
167
- let reusableTerminalWidget: TerminalWidget | undefined;
168
- const taskConfig = openerOptions.taskInfo ? openerOptions.taskInfo.config : openerOptions.taskConfig;
169
- if (TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions)) {
170
- for (const widget of this.getTaskTerminalWidgets()) {
171
- // to run a task whose `taskPresentation === 'dedicated'`, the terminal to be reused must be
172
- // 1) dedicated, 2) idle, 3) the one that ran the same task
173
- if (widget.dedicated &&
174
- !widget.busy &&
175
- widget.taskConfig && taskConfig &&
176
- this.taskDefinitionRegistry.compareTasks(taskConfig, widget.taskConfig)) {
177
-
178
- reusableTerminalWidget = widget;
179
- break;
180
- }
181
- }
182
- } else if (TaskTerminalWidgetOpenerOptions.isSharedTerminal(openerOptions)) {
183
- const availableWidgets: TerminalWidget[] = [];
184
- for (const widget of this.getTaskTerminalWidgets()) {
185
- // to run a task whose `taskPresentation === 'shared'`, the terminal to be used must be
186
- // 1) not dedicated, and 2) idle
187
- if (!widget.dedicated && !widget.busy) {
188
- availableWidgets.push(widget);
189
- }
190
- }
191
- const lastUsedWidget = availableWidgets.find(w => {
192
- const lastUsedTerminal = this.terminalService.lastUsedTerminal;
193
- return lastUsedTerminal && lastUsedTerminal.id === w.id;
194
- });
195
- reusableTerminalWidget = lastUsedWidget || availableWidgets[0];
196
- }
197
-
198
- // we are unable to find a terminal widget to run the task, or `taskPresentation === 'new'`
199
- const lastCwd = taskConfig?.options?.cwd ? new URI(taskConfig.options.cwd) : new URI();
200
-
201
- if (!reusableTerminalWidget) {
202
- const widget = await this.newTaskTerminal(factoryOptions);
203
- widget.lastCwd = lastCwd;
204
- return { isNew: true, widget };
205
- }
206
- reusableTerminalWidget.lastCwd = lastCwd;
207
- return { isNew: false, widget: reusableTerminalWidget };
208
- }
209
-
210
- protected getTaskTerminalWidgets(): TaskTerminalWidget[] {
211
- return this.terminalService.all.filter(TaskTerminalWidget.is);
212
- }
213
-
214
- protected notifyTaskFinished(terminal: TaskTerminalWidget, showReuseMessage: boolean): void {
215
- terminal.busy = false;
216
- terminal.scrollToBottom();
217
- if (showReuseMessage) {
218
- terminal.writeLine('\x1b[1m\n\rTerminal will be reused by tasks. \x1b[0m\n');
219
- }
220
- }
221
- }
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 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
+ this.notifyTaskFinished(terminal, showReuseMessage);
97
+ break;
98
+ }
99
+ }
100
+ });
101
+
102
+ this.terminalService.onDidCreateTerminal(async (widget: TerminalWidget) => {
103
+ const terminal = TaskTerminalWidget.is(widget) && widget;
104
+ if (terminal) {
105
+ const didConnectListener = terminal.onDidOpen(async () => {
106
+ const context = this.workspaceService?.workspace?.resource.toString();
107
+ const tasksInfo = await this.taskServer.getTasks(context);
108
+ const taskInfo = tasksInfo.find(info => info.terminalId === widget.terminalId);
109
+ if (taskInfo) {
110
+ const taskConfig = taskInfo.config;
111
+ terminal.dedicated = !!taskConfig.presentation && !!taskConfig.presentation.panel && taskConfig.presentation.panel === PanelKind.Dedicated;
112
+ terminal.taskId = taskInfo.taskId;
113
+ terminal.taskConfig = taskConfig;
114
+ terminal.busy = true;
115
+ } else {
116
+ this.notifyTaskFinished(terminal, true);
117
+ }
118
+ });
119
+ const didConnectFailureListener = terminal.onDidOpenFailure(async () => {
120
+ this.notifyTaskFinished(terminal, true);
121
+ });
122
+ terminal.onDidDispose(() => {
123
+ didConnectListener.dispose();
124
+ didConnectFailureListener.dispose();
125
+ });
126
+ }
127
+ });
128
+ }
129
+
130
+ async newTaskTerminal(factoryOptions: TerminalWidgetFactoryOptions): Promise<TerminalWidget> {
131
+ return this.terminalService.newTerminal({ ...factoryOptions, kind: 'task' });
132
+ }
133
+
134
+ async open(factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions): Promise<TerminalWidget> {
135
+ const taskInfo = openerOptions.taskInfo;
136
+ const taskConfig = taskInfo ? taskInfo.config : openerOptions.taskConfig;
137
+ const dedicated = TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions);
138
+ if (dedicated && !taskConfig) {
139
+ throw new Error('"taskConfig" must be included as part of the "option.taskInfo" if "isDedicated" is true');
140
+ }
141
+
142
+ const { isNew, widget } = await this.getWidgetToRunTask(factoryOptions, openerOptions);
143
+ if (isNew) {
144
+ this.shell.addWidget(widget, { area: openerOptions.widgetOptions ? openerOptions.widgetOptions.area : 'bottom' });
145
+ widget.resetTerminal();
146
+ } else {
147
+ if (factoryOptions.title) {
148
+ widget.setTitle(factoryOptions.title);
149
+ }
150
+ if (taskConfig && TaskOutputPresentation.shouldClearTerminalBeforeRun(taskConfig)) {
151
+ widget.clearOutput();
152
+ }
153
+ }
154
+ this.terminalService.open(widget, openerOptions);
155
+
156
+ if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) &&
157
+ taskInfo && ProcessTaskInfo.is(taskInfo) && taskInfo.command && taskInfo.command.length > 0
158
+ ) {
159
+ widget.writeLine(`\x1b[1m> Executing task: ${taskInfo.command} <\x1b[0m\n`);
160
+ }
161
+ return widget;
162
+ }
163
+
164
+ protected async getWidgetToRunTask(
165
+ factoryOptions: TerminalWidgetFactoryOptions, openerOptions: TaskTerminalWidgetOpenerOptions
166
+ ): Promise<{ isNew: boolean, widget: TerminalWidget }> {
167
+ let reusableTerminalWidget: TerminalWidget | undefined;
168
+ const taskConfig = openerOptions.taskInfo ? openerOptions.taskInfo.config : openerOptions.taskConfig;
169
+ if (TaskTerminalWidgetOpenerOptions.isDedicatedTerminal(openerOptions)) {
170
+ for (const widget of this.getTaskTerminalWidgets()) {
171
+ // to run a task whose `taskPresentation === 'dedicated'`, the terminal to be reused must be
172
+ // 1) dedicated, 2) idle, 3) the one that ran the same task
173
+ if (widget.dedicated &&
174
+ !widget.busy &&
175
+ widget.taskConfig && taskConfig &&
176
+ this.taskDefinitionRegistry.compareTasks(taskConfig, widget.taskConfig)) {
177
+
178
+ reusableTerminalWidget = widget;
179
+ break;
180
+ }
181
+ }
182
+ } else if (TaskTerminalWidgetOpenerOptions.isSharedTerminal(openerOptions)) {
183
+ const availableWidgets: TerminalWidget[] = [];
184
+ for (const widget of this.getTaskTerminalWidgets()) {
185
+ // to run a task whose `taskPresentation === 'shared'`, the terminal to be used must be
186
+ // 1) not dedicated, and 2) idle
187
+ if (!widget.dedicated && !widget.busy) {
188
+ availableWidgets.push(widget);
189
+ }
190
+ }
191
+ const lastUsedWidget = availableWidgets.find(w => {
192
+ const lastUsedTerminal = this.terminalService.lastUsedTerminal;
193
+ return lastUsedTerminal && lastUsedTerminal.id === w.id;
194
+ });
195
+ reusableTerminalWidget = lastUsedWidget || availableWidgets[0];
196
+ }
197
+
198
+ // we are unable to find a terminal widget to run the task, or `taskPresentation === 'new'`
199
+ const lastCwd = taskConfig?.options?.cwd ? new URI(taskConfig.options.cwd) : new URI();
200
+
201
+ if (!reusableTerminalWidget) {
202
+ const widget = await this.newTaskTerminal(factoryOptions);
203
+ widget.lastCwd = lastCwd;
204
+ return { isNew: true, widget };
205
+ }
206
+ reusableTerminalWidget.lastCwd = lastCwd;
207
+ return { isNew: false, widget: reusableTerminalWidget };
208
+ }
209
+
210
+ protected getTaskTerminalWidgets(): TaskTerminalWidget[] {
211
+ return this.terminalService.all.filter(TaskTerminalWidget.is);
212
+ }
213
+
214
+ protected notifyTaskFinished(terminal: TaskTerminalWidget, showReuseMessage: boolean): void {
215
+ terminal.busy = false;
216
+ terminal.scrollToBottom();
217
+ if (showReuseMessage) {
218
+ terminal.writeLine('\x1b[1m\n\rTerminal will be reused by tasks. \x1b[0m\n');
219
+ }
220
+ }
221
+ }
@@ -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 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 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,19 +1,19 @@
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 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- export * from './task-protocol';
18
- export * from './task-watcher';
19
- export * from './problem-matcher-protocol';
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 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ export * from './task-protocol';
18
+ export * from './task-watcher';
19
+ export * from './problem-matcher-protocol';