@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,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 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 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 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 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 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 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
+ }