@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,396 +1,396 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 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, named, postConstruct } from '@theia/core/shared/inversify';
18
- import { ILogger, ContributionProvider, CommandContribution, Command, CommandRegistry, MenuContribution, MenuModelRegistry, nls } from '@theia/core/lib/common';
19
- import { QuickOpenTask, TaskTerminateQuickOpen, TaskRunningQuickOpen, TaskRestartRunningQuickOpen } from './quick-open-task';
20
- import {
21
- FrontendApplication, FrontendApplicationContribution, QuickAccessContribution,
22
- KeybindingRegistry, KeybindingContribution, StorageService, StatusBar, StatusBarAlignment
23
- } from '@theia/core/lib/browser';
24
- import { WidgetManager } from '@theia/core/lib/browser/widget-manager';
25
- import { TaskContribution, TaskResolverRegistry, TaskProviderRegistry } from './task-contribution';
26
- import { TaskService } from './task-service';
27
- import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
28
- import { TaskSchemaUpdater } from './task-schema-updater';
29
- import { TaskConfiguration, TaskWatcher } from '../common';
30
- import { EditorManager } from '@theia/editor/lib/browser';
31
- import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
32
-
33
- export namespace TaskCommands {
34
- const TASK_CATEGORY = 'Task';
35
- const TASK_CATEGORY_KEY = nls.getDefaultKey(TASK_CATEGORY);
36
- export const TASK_RUN = Command.toDefaultLocalizedCommand({
37
- id: 'task:run',
38
- category: TASK_CATEGORY,
39
- label: 'Run Task...'
40
- });
41
-
42
- export const TASK_RUN_BUILD = Command.toDefaultLocalizedCommand({
43
- id: 'task:run:build',
44
- category: TASK_CATEGORY,
45
- label: 'Run Build Task'
46
- });
47
-
48
- export const TASK_RUN_TEST = Command.toDefaultLocalizedCommand({
49
- id: 'task:run:test',
50
- category: TASK_CATEGORY,
51
- label: 'Run Test Task'
52
- });
53
-
54
- export const WORKBENCH_RUN_TASK = Command.toLocalizedCommand({
55
- id: 'workbench.action.tasks.runTask',
56
- category: TASK_CATEGORY
57
- }, '', TASK_CATEGORY_KEY);
58
-
59
- export const TASK_RUN_LAST = Command.toDefaultLocalizedCommand({
60
- id: 'task:run:last',
61
- category: TASK_CATEGORY,
62
- label: 'Rerun Last Task'
63
- });
64
-
65
- export const TASK_ATTACH = Command.toLocalizedCommand({
66
- id: 'task:attach',
67
- category: TASK_CATEGORY,
68
- label: 'Attach Task...'
69
- }, 'theia/task/attachTask', TASK_CATEGORY_KEY);
70
-
71
- export const TASK_RUN_TEXT = Command.toDefaultLocalizedCommand({
72
- id: 'task:run:text',
73
- category: TASK_CATEGORY,
74
- label: 'Run Selected Text'
75
- });
76
-
77
- export const TASK_CONFIGURE = Command.toDefaultLocalizedCommand({
78
- id: 'task:configure',
79
- category: TASK_CATEGORY,
80
- label: 'Configure Tasks...'
81
- });
82
-
83
- export const TASK_OPEN_USER = Command.toLocalizedCommand({
84
- id: 'task:open_user',
85
- category: TASK_CATEGORY,
86
- label: 'Open User Tasks'
87
- }, 'theia/task/openUserTasks', TASK_CATEGORY_KEY);
88
-
89
- export const TASK_CLEAR_HISTORY = Command.toLocalizedCommand({
90
- id: 'task:clear-history',
91
- category: TASK_CATEGORY,
92
- label: 'Clear History'
93
- }, 'theia/task/clearHistory', TASK_CATEGORY_KEY);
94
-
95
- export const TASK_SHOW_RUNNING = Command.toDefaultLocalizedCommand({
96
- id: 'task:show-running',
97
- category: TASK_CATEGORY,
98
- label: 'Show Running Tasks'
99
- });
100
-
101
- export const TASK_TERMINATE = Command.toDefaultLocalizedCommand({
102
- id: 'task:terminate',
103
- category: TASK_CATEGORY,
104
- label: 'Terminate Task'
105
- });
106
-
107
- export const TASK_RESTART_RUNNING = Command.toDefaultLocalizedCommand({
108
- id: 'task:restart-running',
109
- category: TASK_CATEGORY,
110
- label: 'Restart Running Task...'
111
- });
112
- }
113
-
114
- const TASKS_STORAGE_KEY = 'tasks';
115
-
116
- @injectable()
117
- export class TaskFrontendContribution implements CommandContribution, MenuContribution, KeybindingContribution, FrontendApplicationContribution, QuickAccessContribution {
118
- @inject(QuickOpenTask)
119
- protected readonly quickOpenTask: QuickOpenTask;
120
-
121
- @inject(EditorManager)
122
- protected readonly editorManager: EditorManager;
123
-
124
- @inject(FrontendApplication)
125
- protected readonly app: FrontendApplication;
126
-
127
- @inject(ILogger) @named('task')
128
- protected readonly logger: ILogger;
129
-
130
- @inject(WidgetManager)
131
- protected readonly widgetManager: WidgetManager;
132
-
133
- @inject(ContributionProvider) @named(TaskContribution)
134
- protected readonly contributionProvider: ContributionProvider<TaskContribution>;
135
-
136
- @inject(TaskProviderRegistry)
137
- protected readonly taskProviderRegistry: TaskProviderRegistry;
138
-
139
- @inject(TaskResolverRegistry)
140
- protected readonly taskResolverRegistry: TaskResolverRegistry;
141
-
142
- @inject(TaskService)
143
- protected readonly taskService: TaskService;
144
-
145
- @inject(TaskSchemaUpdater)
146
- protected readonly schemaUpdater: TaskSchemaUpdater;
147
-
148
- @inject(StorageService)
149
- protected readonly storageService: StorageService;
150
-
151
- @inject(TaskRunningQuickOpen)
152
- protected readonly taskRunningQuickOpen: TaskRunningQuickOpen;
153
-
154
- @inject(TaskTerminateQuickOpen)
155
- protected readonly taskTerminateQuickOpen: TaskTerminateQuickOpen;
156
-
157
- @inject(TaskRestartRunningQuickOpen)
158
- protected readonly taskRestartRunningQuickOpen: TaskRestartRunningQuickOpen;
159
-
160
- @inject(TaskWatcher)
161
- protected readonly taskWatcher: TaskWatcher;
162
-
163
- @inject(StatusBar)
164
- protected readonly statusBar: StatusBar;
165
-
166
- @inject(WorkspaceService)
167
- protected readonly workspaceService: WorkspaceService;
168
-
169
- @postConstruct()
170
- protected async init(): Promise<void> {
171
- this.taskWatcher.onTaskCreated(() => this.updateRunningTasksItem());
172
- this.taskWatcher.onTaskExit(() => this.updateRunningTasksItem());
173
- }
174
-
175
- onStart(): void {
176
- this.contributionProvider.getContributions().forEach(contrib => {
177
- if (contrib.registerResolvers) {
178
- contrib.registerResolvers(this.taskResolverRegistry);
179
- }
180
- if (contrib.registerProviders) {
181
- contrib.registerProviders(this.taskProviderRegistry);
182
- }
183
- });
184
- this.schemaUpdater.update();
185
-
186
- this.storageService.getData<{ recent: TaskConfiguration[] }>(TASKS_STORAGE_KEY, { recent: [] })
187
- .then(tasks => this.taskService.recentTasks = tasks.recent);
188
- }
189
-
190
- onStop(): void {
191
- const recent = this.taskService.recentTasks;
192
- this.storageService.setData<{ recent: TaskConfiguration[] }>(TASKS_STORAGE_KEY, { recent });
193
- }
194
-
195
- /**
196
- * Contribute a status-bar item to trigger
197
- * the `Show Running Tasks` command.
198
- */
199
- protected async updateRunningTasksItem(): Promise<void> {
200
- const id = 'show-running-tasks';
201
- const items = await this.taskService.getRunningTasks();
202
- if (!!items.length) {
203
- this.statusBar.setElement(id, {
204
- text: `$(tools) ${items.length}`,
205
- tooltip: TaskCommands.TASK_SHOW_RUNNING.label,
206
- alignment: StatusBarAlignment.LEFT,
207
- priority: 2,
208
- command: TaskCommands.TASK_SHOW_RUNNING.id,
209
- });
210
- } else {
211
- this.statusBar.removeElement(id);
212
- }
213
- }
214
-
215
- registerCommands(registry: CommandRegistry): void {
216
- registry.registerCommand(
217
- TaskCommands.WORKBENCH_RUN_TASK,
218
- {
219
- isEnabled: () => true,
220
- execute: async (label: string) => {
221
- const didExecute = await this.taskService.runTaskByLabel(this.taskService.startUserAction(), label);
222
- if (!didExecute) {
223
- this.quickOpenTask.open();
224
- }
225
- }
226
- }
227
- );
228
-
229
- registry.registerCommand(
230
- TaskCommands.TASK_RUN,
231
- {
232
- isEnabled: () => true,
233
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
234
- execute: (...args: any[]) => {
235
- const [source, label, scope] = args;
236
- if (source && label) {
237
- return this.taskService.run(this.taskService.startUserAction(), source, label, scope);
238
- }
239
- return this.quickOpenTask.open();
240
- }
241
- }
242
- );
243
- registry.registerCommand(
244
- TaskCommands.TASK_RUN_BUILD,
245
- {
246
- isEnabled: () => this.workspaceService.opened,
247
- execute: () =>
248
- this.quickOpenTask.runBuildOrTestTask('build')
249
- }
250
- );
251
- registry.registerCommand(
252
- TaskCommands.TASK_RUN_TEST,
253
- {
254
- isEnabled: () => this.workspaceService.opened,
255
- execute: () =>
256
- this.quickOpenTask.runBuildOrTestTask('test')
257
- }
258
- );
259
- registry.registerCommand(
260
- TaskCommands.TASK_ATTACH,
261
- {
262
- isEnabled: () => true,
263
- execute: () => this.quickOpenTask.attach()
264
- }
265
- );
266
- registry.registerCommand(
267
- TaskCommands.TASK_RUN_LAST,
268
- {
269
- execute: async () => {
270
- if (!await this.taskService.runLastTask(this.taskService.startUserAction())) {
271
- await this.quickOpenTask.open();
272
- }
273
- }
274
- }
275
- );
276
- registry.registerCommand(
277
- TaskCommands.TASK_RUN_TEXT,
278
- {
279
- isVisible: () => !!this.editorManager.currentEditor,
280
- isEnabled: () => !!this.editorManager.currentEditor,
281
- execute: () => this.taskService.runSelectedText()
282
- }
283
- );
284
-
285
- registry.registerCommand(
286
- TaskCommands.TASK_CONFIGURE,
287
- {
288
- execute: () => this.quickOpenTask.configure()
289
- }
290
- );
291
-
292
- registry.registerCommand(
293
- TaskCommands.TASK_OPEN_USER,
294
- {
295
- execute: () => {
296
- this.taskService.openUserTasks();
297
- }
298
- }
299
- );
300
-
301
- registry.registerCommand(
302
- TaskCommands.TASK_CLEAR_HISTORY,
303
- {
304
- execute: () => this.taskService.clearRecentTasks()
305
- }
306
- );
307
-
308
- registry.registerCommand(
309
- TaskCommands.TASK_SHOW_RUNNING,
310
- {
311
- execute: () => this.taskRunningQuickOpen.open()
312
- }
313
- );
314
-
315
- registry.registerCommand(
316
- TaskCommands.TASK_TERMINATE,
317
- {
318
- execute: () => this.taskTerminateQuickOpen.open()
319
- }
320
- );
321
-
322
- registry.registerCommand(
323
- TaskCommands.TASK_RESTART_RUNNING,
324
- {
325
- execute: () => this.taskRestartRunningQuickOpen.open()
326
- }
327
- );
328
- }
329
-
330
- registerMenus(menus: MenuModelRegistry): void {
331
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
332
- commandId: TaskCommands.TASK_RUN.id,
333
- order: '0'
334
- });
335
-
336
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
337
- commandId: TaskCommands.TASK_RUN_BUILD.id,
338
- order: '1'
339
- });
340
-
341
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
342
- commandId: TaskCommands.TASK_RUN_TEST.id,
343
- order: '2'
344
- });
345
-
346
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
347
- commandId: TaskCommands.TASK_RUN_LAST.id,
348
- order: '3'
349
- });
350
-
351
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
352
- commandId: TaskCommands.TASK_ATTACH.id,
353
- order: '4'
354
- });
355
-
356
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
357
- commandId: TaskCommands.TASK_RUN_TEXT.id,
358
- order: '5'
359
- });
360
-
361
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
362
- commandId: TaskCommands.TASK_SHOW_RUNNING.id,
363
- label: TaskCommands.TASK_SHOW_RUNNING.label + '...',
364
- order: '0'
365
- });
366
-
367
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
368
- commandId: TaskCommands.TASK_RESTART_RUNNING.id,
369
- label: TaskCommands.TASK_RESTART_RUNNING.label,
370
- order: '1'
371
- });
372
-
373
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
374
- commandId: TaskCommands.TASK_TERMINATE.id,
375
- label: TaskCommands.TASK_TERMINATE.label + '...',
376
- order: '2'
377
- });
378
-
379
- menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_CONFIG, {
380
- commandId: TaskCommands.TASK_CONFIGURE.id,
381
- order: '0'
382
- });
383
- }
384
-
385
- registerQuickAccessProvider(): void {
386
- this.quickOpenTask.registerQuickAccessProvider();
387
- }
388
-
389
- registerKeybindings(keybindings: KeybindingRegistry): void {
390
- keybindings.registerKeybinding({
391
- command: TaskCommands.TASK_RUN_LAST.id,
392
- keybinding: 'ctrlcmd+shift+k',
393
- when: '!textInputFocus || editorReadonly'
394
- });
395
- }
396
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 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, named, postConstruct } from '@theia/core/shared/inversify';
18
+ import { ILogger, ContributionProvider, CommandContribution, Command, CommandRegistry, MenuContribution, MenuModelRegistry, nls } from '@theia/core/lib/common';
19
+ import { QuickOpenTask, TaskTerminateQuickOpen, TaskRunningQuickOpen, TaskRestartRunningQuickOpen } from './quick-open-task';
20
+ import {
21
+ FrontendApplication, FrontendApplicationContribution, QuickAccessContribution,
22
+ KeybindingRegistry, KeybindingContribution, StorageService, StatusBar, StatusBarAlignment
23
+ } from '@theia/core/lib/browser';
24
+ import { WidgetManager } from '@theia/core/lib/browser/widget-manager';
25
+ import { TaskContribution, TaskResolverRegistry, TaskProviderRegistry } from './task-contribution';
26
+ import { TaskService } from './task-service';
27
+ import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
28
+ import { TaskSchemaUpdater } from './task-schema-updater';
29
+ import { TaskConfiguration, TaskWatcher } from '../common';
30
+ import { EditorManager } from '@theia/editor/lib/browser';
31
+ import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
32
+
33
+ export namespace TaskCommands {
34
+ const TASK_CATEGORY = 'Task';
35
+ const TASK_CATEGORY_KEY = nls.getDefaultKey(TASK_CATEGORY);
36
+ export const TASK_RUN = Command.toDefaultLocalizedCommand({
37
+ id: 'task:run',
38
+ category: TASK_CATEGORY,
39
+ label: 'Run Task...'
40
+ });
41
+
42
+ export const TASK_RUN_BUILD = Command.toDefaultLocalizedCommand({
43
+ id: 'task:run:build',
44
+ category: TASK_CATEGORY,
45
+ label: 'Run Build Task'
46
+ });
47
+
48
+ export const TASK_RUN_TEST = Command.toDefaultLocalizedCommand({
49
+ id: 'task:run:test',
50
+ category: TASK_CATEGORY,
51
+ label: 'Run Test Task'
52
+ });
53
+
54
+ export const WORKBENCH_RUN_TASK = Command.toLocalizedCommand({
55
+ id: 'workbench.action.tasks.runTask',
56
+ category: TASK_CATEGORY
57
+ }, '', TASK_CATEGORY_KEY);
58
+
59
+ export const TASK_RUN_LAST = Command.toDefaultLocalizedCommand({
60
+ id: 'task:run:last',
61
+ category: TASK_CATEGORY,
62
+ label: 'Rerun Last Task'
63
+ });
64
+
65
+ export const TASK_ATTACH = Command.toLocalizedCommand({
66
+ id: 'task:attach',
67
+ category: TASK_CATEGORY,
68
+ label: 'Attach Task...'
69
+ }, 'theia/task/attachTask', TASK_CATEGORY_KEY);
70
+
71
+ export const TASK_RUN_TEXT = Command.toDefaultLocalizedCommand({
72
+ id: 'task:run:text',
73
+ category: TASK_CATEGORY,
74
+ label: 'Run Selected Text'
75
+ });
76
+
77
+ export const TASK_CONFIGURE = Command.toDefaultLocalizedCommand({
78
+ id: 'task:configure',
79
+ category: TASK_CATEGORY,
80
+ label: 'Configure Tasks...'
81
+ });
82
+
83
+ export const TASK_OPEN_USER = Command.toLocalizedCommand({
84
+ id: 'task:open_user',
85
+ category: TASK_CATEGORY,
86
+ label: 'Open User Tasks'
87
+ }, 'theia/task/openUserTasks', TASK_CATEGORY_KEY);
88
+
89
+ export const TASK_CLEAR_HISTORY = Command.toLocalizedCommand({
90
+ id: 'task:clear-history',
91
+ category: TASK_CATEGORY,
92
+ label: 'Clear History'
93
+ }, 'theia/task/clearHistory', TASK_CATEGORY_KEY);
94
+
95
+ export const TASK_SHOW_RUNNING = Command.toDefaultLocalizedCommand({
96
+ id: 'task:show-running',
97
+ category: TASK_CATEGORY,
98
+ label: 'Show Running Tasks'
99
+ });
100
+
101
+ export const TASK_TERMINATE = Command.toDefaultLocalizedCommand({
102
+ id: 'task:terminate',
103
+ category: TASK_CATEGORY,
104
+ label: 'Terminate Task'
105
+ });
106
+
107
+ export const TASK_RESTART_RUNNING = Command.toDefaultLocalizedCommand({
108
+ id: 'task:restart-running',
109
+ category: TASK_CATEGORY,
110
+ label: 'Restart Running Task...'
111
+ });
112
+ }
113
+
114
+ const TASKS_STORAGE_KEY = 'tasks';
115
+
116
+ @injectable()
117
+ export class TaskFrontendContribution implements CommandContribution, MenuContribution, KeybindingContribution, FrontendApplicationContribution, QuickAccessContribution {
118
+ @inject(QuickOpenTask)
119
+ protected readonly quickOpenTask: QuickOpenTask;
120
+
121
+ @inject(EditorManager)
122
+ protected readonly editorManager: EditorManager;
123
+
124
+ @inject(FrontendApplication)
125
+ protected readonly app: FrontendApplication;
126
+
127
+ @inject(ILogger) @named('task')
128
+ protected readonly logger: ILogger;
129
+
130
+ @inject(WidgetManager)
131
+ protected readonly widgetManager: WidgetManager;
132
+
133
+ @inject(ContributionProvider) @named(TaskContribution)
134
+ protected readonly contributionProvider: ContributionProvider<TaskContribution>;
135
+
136
+ @inject(TaskProviderRegistry)
137
+ protected readonly taskProviderRegistry: TaskProviderRegistry;
138
+
139
+ @inject(TaskResolverRegistry)
140
+ protected readonly taskResolverRegistry: TaskResolverRegistry;
141
+
142
+ @inject(TaskService)
143
+ protected readonly taskService: TaskService;
144
+
145
+ @inject(TaskSchemaUpdater)
146
+ protected readonly schemaUpdater: TaskSchemaUpdater;
147
+
148
+ @inject(StorageService)
149
+ protected readonly storageService: StorageService;
150
+
151
+ @inject(TaskRunningQuickOpen)
152
+ protected readonly taskRunningQuickOpen: TaskRunningQuickOpen;
153
+
154
+ @inject(TaskTerminateQuickOpen)
155
+ protected readonly taskTerminateQuickOpen: TaskTerminateQuickOpen;
156
+
157
+ @inject(TaskRestartRunningQuickOpen)
158
+ protected readonly taskRestartRunningQuickOpen: TaskRestartRunningQuickOpen;
159
+
160
+ @inject(TaskWatcher)
161
+ protected readonly taskWatcher: TaskWatcher;
162
+
163
+ @inject(StatusBar)
164
+ protected readonly statusBar: StatusBar;
165
+
166
+ @inject(WorkspaceService)
167
+ protected readonly workspaceService: WorkspaceService;
168
+
169
+ @postConstruct()
170
+ protected async init(): Promise<void> {
171
+ this.taskWatcher.onTaskCreated(() => this.updateRunningTasksItem());
172
+ this.taskWatcher.onTaskExit(() => this.updateRunningTasksItem());
173
+ }
174
+
175
+ onStart(): void {
176
+ this.contributionProvider.getContributions().forEach(contrib => {
177
+ if (contrib.registerResolvers) {
178
+ contrib.registerResolvers(this.taskResolverRegistry);
179
+ }
180
+ if (contrib.registerProviders) {
181
+ contrib.registerProviders(this.taskProviderRegistry);
182
+ }
183
+ });
184
+ this.schemaUpdater.update();
185
+
186
+ this.storageService.getData<{ recent: TaskConfiguration[] }>(TASKS_STORAGE_KEY, { recent: [] })
187
+ .then(tasks => this.taskService.recentTasks = tasks.recent);
188
+ }
189
+
190
+ onStop(): void {
191
+ const recent = this.taskService.recentTasks;
192
+ this.storageService.setData<{ recent: TaskConfiguration[] }>(TASKS_STORAGE_KEY, { recent });
193
+ }
194
+
195
+ /**
196
+ * Contribute a status-bar item to trigger
197
+ * the `Show Running Tasks` command.
198
+ */
199
+ protected async updateRunningTasksItem(): Promise<void> {
200
+ const id = 'show-running-tasks';
201
+ const items = await this.taskService.getRunningTasks();
202
+ if (!!items.length) {
203
+ this.statusBar.setElement(id, {
204
+ text: `$(tools) ${items.length}`,
205
+ tooltip: TaskCommands.TASK_SHOW_RUNNING.label,
206
+ alignment: StatusBarAlignment.LEFT,
207
+ priority: 2,
208
+ command: TaskCommands.TASK_SHOW_RUNNING.id,
209
+ });
210
+ } else {
211
+ this.statusBar.removeElement(id);
212
+ }
213
+ }
214
+
215
+ registerCommands(registry: CommandRegistry): void {
216
+ registry.registerCommand(
217
+ TaskCommands.WORKBENCH_RUN_TASK,
218
+ {
219
+ isEnabled: () => true,
220
+ execute: async (label: string) => {
221
+ const didExecute = await this.taskService.runTaskByLabel(this.taskService.startUserAction(), label);
222
+ if (!didExecute) {
223
+ this.quickOpenTask.open();
224
+ }
225
+ }
226
+ }
227
+ );
228
+
229
+ registry.registerCommand(
230
+ TaskCommands.TASK_RUN,
231
+ {
232
+ isEnabled: () => true,
233
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
234
+ execute: (...args: any[]) => {
235
+ const [source, label, scope] = args;
236
+ if (source && label) {
237
+ return this.taskService.run(this.taskService.startUserAction(), source, label, scope);
238
+ }
239
+ return this.quickOpenTask.open();
240
+ }
241
+ }
242
+ );
243
+ registry.registerCommand(
244
+ TaskCommands.TASK_RUN_BUILD,
245
+ {
246
+ isEnabled: () => this.workspaceService.opened,
247
+ execute: () =>
248
+ this.quickOpenTask.runBuildOrTestTask('build')
249
+ }
250
+ );
251
+ registry.registerCommand(
252
+ TaskCommands.TASK_RUN_TEST,
253
+ {
254
+ isEnabled: () => this.workspaceService.opened,
255
+ execute: () =>
256
+ this.quickOpenTask.runBuildOrTestTask('test')
257
+ }
258
+ );
259
+ registry.registerCommand(
260
+ TaskCommands.TASK_ATTACH,
261
+ {
262
+ isEnabled: () => true,
263
+ execute: () => this.quickOpenTask.attach()
264
+ }
265
+ );
266
+ registry.registerCommand(
267
+ TaskCommands.TASK_RUN_LAST,
268
+ {
269
+ execute: async () => {
270
+ if (!await this.taskService.runLastTask(this.taskService.startUserAction())) {
271
+ await this.quickOpenTask.open();
272
+ }
273
+ }
274
+ }
275
+ );
276
+ registry.registerCommand(
277
+ TaskCommands.TASK_RUN_TEXT,
278
+ {
279
+ isVisible: () => !!this.editorManager.currentEditor,
280
+ isEnabled: () => !!this.editorManager.currentEditor,
281
+ execute: () => this.taskService.runSelectedText()
282
+ }
283
+ );
284
+
285
+ registry.registerCommand(
286
+ TaskCommands.TASK_CONFIGURE,
287
+ {
288
+ execute: () => this.quickOpenTask.configure()
289
+ }
290
+ );
291
+
292
+ registry.registerCommand(
293
+ TaskCommands.TASK_OPEN_USER,
294
+ {
295
+ execute: () => {
296
+ this.taskService.openUserTasks();
297
+ }
298
+ }
299
+ );
300
+
301
+ registry.registerCommand(
302
+ TaskCommands.TASK_CLEAR_HISTORY,
303
+ {
304
+ execute: () => this.taskService.clearRecentTasks()
305
+ }
306
+ );
307
+
308
+ registry.registerCommand(
309
+ TaskCommands.TASK_SHOW_RUNNING,
310
+ {
311
+ execute: () => this.taskRunningQuickOpen.open()
312
+ }
313
+ );
314
+
315
+ registry.registerCommand(
316
+ TaskCommands.TASK_TERMINATE,
317
+ {
318
+ execute: () => this.taskTerminateQuickOpen.open()
319
+ }
320
+ );
321
+
322
+ registry.registerCommand(
323
+ TaskCommands.TASK_RESTART_RUNNING,
324
+ {
325
+ execute: () => this.taskRestartRunningQuickOpen.open()
326
+ }
327
+ );
328
+ }
329
+
330
+ registerMenus(menus: MenuModelRegistry): void {
331
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
332
+ commandId: TaskCommands.TASK_RUN.id,
333
+ order: '0'
334
+ });
335
+
336
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
337
+ commandId: TaskCommands.TASK_RUN_BUILD.id,
338
+ order: '1'
339
+ });
340
+
341
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
342
+ commandId: TaskCommands.TASK_RUN_TEST.id,
343
+ order: '2'
344
+ });
345
+
346
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
347
+ commandId: TaskCommands.TASK_RUN_LAST.id,
348
+ order: '3'
349
+ });
350
+
351
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
352
+ commandId: TaskCommands.TASK_ATTACH.id,
353
+ order: '4'
354
+ });
355
+
356
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS, {
357
+ commandId: TaskCommands.TASK_RUN_TEXT.id,
358
+ order: '5'
359
+ });
360
+
361
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
362
+ commandId: TaskCommands.TASK_SHOW_RUNNING.id,
363
+ label: TaskCommands.TASK_SHOW_RUNNING.label + '...',
364
+ order: '0'
365
+ });
366
+
367
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
368
+ commandId: TaskCommands.TASK_RESTART_RUNNING.id,
369
+ label: TaskCommands.TASK_RESTART_RUNNING.label,
370
+ order: '1'
371
+ });
372
+
373
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
374
+ commandId: TaskCommands.TASK_TERMINATE.id,
375
+ label: TaskCommands.TASK_TERMINATE.label + '...',
376
+ order: '2'
377
+ });
378
+
379
+ menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_CONFIG, {
380
+ commandId: TaskCommands.TASK_CONFIGURE.id,
381
+ order: '0'
382
+ });
383
+ }
384
+
385
+ registerQuickAccessProvider(): void {
386
+ this.quickOpenTask.registerQuickAccessProvider();
387
+ }
388
+
389
+ registerKeybindings(keybindings: KeybindingRegistry): void {
390
+ keybindings.registerKeybinding({
391
+ command: TaskCommands.TASK_RUN_LAST.id,
392
+ keybinding: 'ctrlcmd+shift+k',
393
+ when: '!textInputFocus || editorReadonly'
394
+ });
395
+ }
396
+ }