@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,62 +1,62 @@
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 { AbstractLineMatcher } from './task-abstract-line-matcher';
18
- import { ProblemMatcher, ProblemMatch } from '../common/problem-matcher-protocol';
19
- import { StartStopLineMatcher, WatchModeLineMatcher } from './task-line-matchers';
20
-
21
- export class ProblemCollector {
22
-
23
- private lineMatchers: AbstractLineMatcher[] = [];
24
-
25
- constructor(
26
- public problemMatchers: ProblemMatcher[]
27
- ) {
28
- for (const matcher of problemMatchers) {
29
- if (ProblemMatcher.isWatchModeWatcher(matcher)) {
30
- this.lineMatchers.push(new WatchModeLineMatcher(matcher));
31
- } else {
32
- this.lineMatchers.push(new StartStopLineMatcher(matcher));
33
- }
34
- }
35
- }
36
-
37
- processLine(line: string): ProblemMatch[] {
38
- const markers: ProblemMatch[] = [];
39
- this.lineMatchers.forEach(lineMatcher => {
40
- const match = lineMatcher.match(line);
41
- if (match) {
42
- markers.push(match);
43
- }
44
- });
45
- return markers;
46
- }
47
-
48
- isTaskActiveOnStart(): boolean {
49
- const activeOnStart = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.activeOnStart);
50
- return activeOnStart;
51
- }
52
-
53
- matchBeginMatcher(line: string): boolean {
54
- const match = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.matchBegin(line));
55
- return match;
56
- }
57
-
58
- matchEndMatcher(line: string): boolean {
59
- const match = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.matchEnd(line));
60
- return match;
61
- }
62
- }
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 { AbstractLineMatcher } from './task-abstract-line-matcher';
18
+ import { ProblemMatcher, ProblemMatch } from '../common/problem-matcher-protocol';
19
+ import { StartStopLineMatcher, WatchModeLineMatcher } from './task-line-matchers';
20
+
21
+ export class ProblemCollector {
22
+
23
+ private lineMatchers: AbstractLineMatcher[] = [];
24
+
25
+ constructor(
26
+ public problemMatchers: ProblemMatcher[]
27
+ ) {
28
+ for (const matcher of problemMatchers) {
29
+ if (ProblemMatcher.isWatchModeWatcher(matcher)) {
30
+ this.lineMatchers.push(new WatchModeLineMatcher(matcher));
31
+ } else {
32
+ this.lineMatchers.push(new StartStopLineMatcher(matcher));
33
+ }
34
+ }
35
+ }
36
+
37
+ processLine(line: string): ProblemMatch[] {
38
+ const markers: ProblemMatch[] = [];
39
+ this.lineMatchers.forEach(lineMatcher => {
40
+ const match = lineMatcher.match(line);
41
+ if (match) {
42
+ markers.push(match);
43
+ }
44
+ });
45
+ return markers;
46
+ }
47
+
48
+ isTaskActiveOnStart(): boolean {
49
+ const activeOnStart = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.activeOnStart);
50
+ return activeOnStart;
51
+ }
52
+
53
+ matchBeginMatcher(line: string): boolean {
54
+ const match = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.matchBegin(line));
55
+ return match;
56
+ }
57
+
58
+ matchEndMatcher(line: string): boolean {
59
+ const match = this.lineMatchers.some(lineMatcher => (lineMatcher instanceof WatchModeLineMatcher) && lineMatcher.matchEnd(line));
60
+ return match;
61
+ }
62
+ }
@@ -1,33 +1,33 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2022 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 { TaskConfiguration } from '../common';
18
- import { Task } from './task';
19
-
20
- export const TaskRunner = Symbol('TaskRunner');
21
- /**
22
- * A {@link TaskRunner} knows how to run a task configuration of a particular type.
23
- */
24
- export interface TaskRunner {
25
- /**
26
- * Runs a task based on the given `TaskConfiguration`.
27
- * @param taskConfig the task configuration that should be executed.
28
- * @param ctx the execution context.
29
- *
30
- * @returns a promise of the (currently running) {@link Task}.
31
- */
32
- run(tskConfig: TaskConfiguration, ctx?: string): Promise<Task>;
33
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2022 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 { TaskConfiguration } from '../common';
18
+ import { Task } from './task';
19
+
20
+ export const TaskRunner = Symbol('TaskRunner');
21
+ /**
22
+ * A {@link TaskRunner} knows how to run a task configuration of a particular type.
23
+ */
24
+ export interface TaskRunner {
25
+ /**
26
+ * Runs a task based on the given `TaskConfiguration`.
27
+ * @param taskConfig the task configuration that should be executed.
28
+ * @param ctx the execution context.
29
+ *
30
+ * @returns a promise of the (currently running) {@link Task}.
31
+ */
32
+ run(tskConfig: TaskConfiguration, ctx?: string): Promise<Task>;
33
+ }
@@ -1,96 +1,96 @@
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
- import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
- import { Disposable } from '@theia/core/lib/common/disposable';
19
- import { ProcessTaskRunner } from './process/process-task-runner';
20
- import { TaskRunner } from './task-runner-protocol';
21
- export { TaskRunner };
22
-
23
- export const TaskRunnerContribution = Symbol('TaskRunnerContribution');
24
-
25
- /** The {@link TaskRunnerContribution} can be used to contribute custom {@link TaskRunner}s. */
26
- export interface TaskRunnerContribution {
27
- /**
28
- * Register custom runners using the given {@link TaskRunnerRegistry}.
29
- * @param runners the common task runner registry.
30
- */
31
- registerRunner(runners: TaskRunnerRegistry): void;
32
- }
33
-
34
- /**
35
- * The {@link TaskRunnerRegistry} is the common component for the registration and provisioning of
36
- * {@link TaskRunner}s. Theia will collect all {@link TaskRunner}s and invoke {@link TaskRunnerContribution#registerRunner}
37
- * for each contribution. The `TaskServer` will use the runners provided by this registry to execute `TaskConfiguration`s that
38
- * have been triggered by the user.
39
- */
40
- @injectable()
41
- export class TaskRunnerRegistry {
42
-
43
- protected runners: Map<string, TaskRunner>;
44
- /** A Task Runner that will be used for executing a Task without an associated Runner. */
45
- protected defaultRunner: TaskRunner;
46
-
47
- @inject(ProcessTaskRunner)
48
- protected readonly processTaskRunner: ProcessTaskRunner;
49
-
50
- @postConstruct()
51
- protected init(): void {
52
- this.runners = new Map();
53
- this.defaultRunner = this.processTaskRunner;
54
- }
55
- /**
56
- * Registers the given {@link TaskRunner} to execute Tasks of the specified type.
57
- * If there is already a {@link TaskRunner} registered for the specified type the registration will
58
- * be overwritten with the new value.
59
- * @param type the task type for which the given runner should be registered.
60
- * @param runner the task runner that should be registered.
61
- *
62
- * @returns a `Disposable` that can be invoked to unregister the given runner.
63
- */
64
- registerRunner(type: string, runner: TaskRunner): Disposable {
65
- this.runners.set(type, runner);
66
- return {
67
- dispose: () => this.runners.delete(type)
68
- };
69
- }
70
-
71
- /**
72
- * Looks for a registered {@link TaskRunner} for each of the task types in sequence and returns the first that is found
73
- * If no task runner is registered for any of the types, the default runner is returned.
74
- * @param types the task types.
75
- *
76
- * @returns the registered {@link TaskRunner} or a default runner if none is registered for the specified types.
77
- */
78
- getRunner(...types: string[]): TaskRunner {
79
- for (const type of types) {
80
- const runner = this.runners.get(type);
81
- if (runner) {
82
- return runner;
83
- }
84
- }
85
- return this.defaultRunner;
86
- }
87
-
88
- /**
89
- * Derives all task types for which a {@link TaskRunner} is registered.
90
- *
91
- * @returns all derived task types.
92
- */
93
- getRunnerTypes(): string[] {
94
- return [...this.runners.keys()];
95
- }
96
- }
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
+ import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
+ import { Disposable } from '@theia/core/lib/common/disposable';
19
+ import { ProcessTaskRunner } from './process/process-task-runner';
20
+ import { TaskRunner } from './task-runner-protocol';
21
+ export { TaskRunner };
22
+
23
+ export const TaskRunnerContribution = Symbol('TaskRunnerContribution');
24
+
25
+ /** The {@link TaskRunnerContribution} can be used to contribute custom {@link TaskRunner}s. */
26
+ export interface TaskRunnerContribution {
27
+ /**
28
+ * Register custom runners using the given {@link TaskRunnerRegistry}.
29
+ * @param runners the common task runner registry.
30
+ */
31
+ registerRunner(runners: TaskRunnerRegistry): void;
32
+ }
33
+
34
+ /**
35
+ * The {@link TaskRunnerRegistry} is the common component for the registration and provisioning of
36
+ * {@link TaskRunner}s. Theia will collect all {@link TaskRunner}s and invoke {@link TaskRunnerContribution#registerRunner}
37
+ * for each contribution. The `TaskServer` will use the runners provided by this registry to execute `TaskConfiguration`s that
38
+ * have been triggered by the user.
39
+ */
40
+ @injectable()
41
+ export class TaskRunnerRegistry {
42
+
43
+ protected runners: Map<string, TaskRunner>;
44
+ /** A Task Runner that will be used for executing a Task without an associated Runner. */
45
+ protected defaultRunner: TaskRunner;
46
+
47
+ @inject(ProcessTaskRunner)
48
+ protected readonly processTaskRunner: ProcessTaskRunner;
49
+
50
+ @postConstruct()
51
+ protected init(): void {
52
+ this.runners = new Map();
53
+ this.defaultRunner = this.processTaskRunner;
54
+ }
55
+ /**
56
+ * Registers the given {@link TaskRunner} to execute Tasks of the specified type.
57
+ * If there is already a {@link TaskRunner} registered for the specified type the registration will
58
+ * be overwritten with the new value.
59
+ * @param type the task type for which the given runner should be registered.
60
+ * @param runner the task runner that should be registered.
61
+ *
62
+ * @returns a `Disposable` that can be invoked to unregister the given runner.
63
+ */
64
+ registerRunner(type: string, runner: TaskRunner): Disposable {
65
+ this.runners.set(type, runner);
66
+ return {
67
+ dispose: () => this.runners.delete(type)
68
+ };
69
+ }
70
+
71
+ /**
72
+ * Looks for a registered {@link TaskRunner} for each of the task types in sequence and returns the first that is found
73
+ * If no task runner is registered for any of the types, the default runner is returned.
74
+ * @param types the task types.
75
+ *
76
+ * @returns the registered {@link TaskRunner} or a default runner if none is registered for the specified types.
77
+ */
78
+ getRunner(...types: string[]): TaskRunner {
79
+ for (const type of types) {
80
+ const runner = this.runners.get(type);
81
+ if (runner) {
82
+ return runner;
83
+ }
84
+ }
85
+ return this.defaultRunner;
86
+ }
87
+
88
+ /**
89
+ * Derives all task types for which a {@link TaskRunner} is registered.
90
+ *
91
+ * @returns all derived task types.
92
+ */
93
+ getRunnerTypes(): string[] {
94
+ return [...this.runners.keys()];
95
+ }
96
+ }