@theia/task 1.34.3 → 1.34.4

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,89 +1,89 @@
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 } from '@theia/core/shared/inversify';
18
- import { VariableResolverService } from '@theia/variable-resolver/lib/browser';
19
- import { TaskResolver } from '../task-contribution';
20
- import { TaskConfiguration } from '../../common/task-protocol';
21
- import { ProcessTaskConfiguration } from '../../common/process/task-protocol';
22
- import { TaskDefinitionRegistry } from '../task-definition-registry';
23
- import URI from '@theia/core/lib/common/uri';
24
- import { WorkspaceService } from '@theia/workspace/lib/browser';
25
-
26
- @injectable()
27
- export class ProcessTaskResolver implements TaskResolver {
28
-
29
- @inject(VariableResolverService)
30
- protected readonly variableResolverService: VariableResolverService;
31
-
32
- @inject(TaskDefinitionRegistry)
33
- protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
34
-
35
- @inject(WorkspaceService)
36
- protected readonly workspaceService: WorkspaceService;
37
-
38
- /**
39
- * Perform some adjustments to the task launch configuration, before sending
40
- * it to the backend to be executed. We can make sure that parameters that
41
- * are optional to the user but required by the server will be defined, with
42
- * sane default values. Also, resolve all known variables, e.g. `${workspaceFolder}`.
43
- */
44
- async resolveTask(taskConfig: TaskConfiguration): Promise<TaskConfiguration> {
45
- const type = taskConfig.taskType || taskConfig.type;
46
- if (type !== 'process' && type !== 'shell') {
47
- throw new Error('Unsupported task configuration type.');
48
- }
49
- const context = typeof taskConfig._scope === 'string' ? new URI(taskConfig._scope) : undefined;
50
- const variableResolverOptions = {
51
- context, configurationSection: 'tasks'
52
- };
53
- const processTaskConfig = taskConfig as ProcessTaskConfiguration;
54
- let cwd = processTaskConfig.options && processTaskConfig.options.cwd;
55
- if (!cwd) {
56
- const rootURI = this.workspaceService.getWorkspaceRootUri(context);
57
- if (rootURI) {
58
- cwd = rootURI.toString();
59
- }
60
- }
61
-
62
- const result: ProcessTaskConfiguration = {
63
- ...processTaskConfig,
64
- command: await this.variableResolverService.resolve(processTaskConfig.command, variableResolverOptions),
65
- args: processTaskConfig.args ? await this.variableResolverService.resolve(processTaskConfig.args, variableResolverOptions) : undefined,
66
- windows: processTaskConfig.windows ? {
67
- command: await this.variableResolverService.resolve(processTaskConfig.windows.command, variableResolverOptions),
68
- args: processTaskConfig.windows.args ? await this.variableResolverService.resolve(processTaskConfig.windows.args, variableResolverOptions) : undefined,
69
- options: processTaskConfig.windows.options
70
- } : undefined,
71
- osx: processTaskConfig.osx ? {
72
- command: await this.variableResolverService.resolve(processTaskConfig.osx.command, variableResolverOptions),
73
- args: processTaskConfig.osx.args ? await this.variableResolverService.resolve(processTaskConfig.osx.args, variableResolverOptions) : undefined,
74
- options: processTaskConfig.osx.options
75
- } : undefined,
76
- linux: processTaskConfig.linux ? {
77
- command: await this.variableResolverService.resolve(processTaskConfig.linux.command, variableResolverOptions),
78
- args: processTaskConfig.linux.args ? await this.variableResolverService.resolve(processTaskConfig.linux.args, variableResolverOptions) : undefined,
79
- options: processTaskConfig.linux.options
80
- } : undefined,
81
- options: {
82
- cwd: await this.variableResolverService.resolve(cwd, variableResolverOptions),
83
- env: processTaskConfig.options?.env && await this.variableResolverService.resolve(processTaskConfig.options.env, variableResolverOptions),
84
- shell: processTaskConfig.options && processTaskConfig.options.shell
85
- }
86
- };
87
- return result;
88
- }
89
- }
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 } from '@theia/core/shared/inversify';
18
+ import { VariableResolverService } from '@theia/variable-resolver/lib/browser';
19
+ import { TaskResolver } from '../task-contribution';
20
+ import { TaskConfiguration } from '../../common/task-protocol';
21
+ import { ProcessTaskConfiguration } from '../../common/process/task-protocol';
22
+ import { TaskDefinitionRegistry } from '../task-definition-registry';
23
+ import URI from '@theia/core/lib/common/uri';
24
+ import { WorkspaceService } from '@theia/workspace/lib/browser';
25
+
26
+ @injectable()
27
+ export class ProcessTaskResolver implements TaskResolver {
28
+
29
+ @inject(VariableResolverService)
30
+ protected readonly variableResolverService: VariableResolverService;
31
+
32
+ @inject(TaskDefinitionRegistry)
33
+ protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
34
+
35
+ @inject(WorkspaceService)
36
+ protected readonly workspaceService: WorkspaceService;
37
+
38
+ /**
39
+ * Perform some adjustments to the task launch configuration, before sending
40
+ * it to the backend to be executed. We can make sure that parameters that
41
+ * are optional to the user but required by the server will be defined, with
42
+ * sane default values. Also, resolve all known variables, e.g. `${workspaceFolder}`.
43
+ */
44
+ async resolveTask(taskConfig: TaskConfiguration): Promise<TaskConfiguration> {
45
+ const type = taskConfig.taskType || taskConfig.type;
46
+ if (type !== 'process' && type !== 'shell') {
47
+ throw new Error('Unsupported task configuration type.');
48
+ }
49
+ const context = typeof taskConfig._scope === 'string' ? new URI(taskConfig._scope) : undefined;
50
+ const variableResolverOptions = {
51
+ context, configurationSection: 'tasks'
52
+ };
53
+ const processTaskConfig = taskConfig as ProcessTaskConfiguration;
54
+ let cwd = processTaskConfig.options && processTaskConfig.options.cwd;
55
+ if (!cwd) {
56
+ const rootURI = this.workspaceService.getWorkspaceRootUri(context);
57
+ if (rootURI) {
58
+ cwd = rootURI.toString();
59
+ }
60
+ }
61
+
62
+ const result: ProcessTaskConfiguration = {
63
+ ...processTaskConfig,
64
+ command: await this.variableResolverService.resolve(processTaskConfig.command, variableResolverOptions),
65
+ args: processTaskConfig.args ? await this.variableResolverService.resolve(processTaskConfig.args, variableResolverOptions) : undefined,
66
+ windows: processTaskConfig.windows ? {
67
+ command: await this.variableResolverService.resolve(processTaskConfig.windows.command, variableResolverOptions),
68
+ args: processTaskConfig.windows.args ? await this.variableResolverService.resolve(processTaskConfig.windows.args, variableResolverOptions) : undefined,
69
+ options: processTaskConfig.windows.options
70
+ } : undefined,
71
+ osx: processTaskConfig.osx ? {
72
+ command: await this.variableResolverService.resolve(processTaskConfig.osx.command, variableResolverOptions),
73
+ args: processTaskConfig.osx.args ? await this.variableResolverService.resolve(processTaskConfig.osx.args, variableResolverOptions) : undefined,
74
+ options: processTaskConfig.osx.options
75
+ } : undefined,
76
+ linux: processTaskConfig.linux ? {
77
+ command: await this.variableResolverService.resolve(processTaskConfig.linux.command, variableResolverOptions),
78
+ args: processTaskConfig.linux.args ? await this.variableResolverService.resolve(processTaskConfig.linux.args, variableResolverOptions) : undefined,
79
+ options: processTaskConfig.linux.options
80
+ } : undefined,
81
+ options: {
82
+ cwd: await this.variableResolverService.resolve(cwd, variableResolverOptions),
83
+ env: processTaskConfig.options?.env && await this.variableResolverService.resolve(processTaskConfig.options.env, variableResolverOptions),
84
+ shell: processTaskConfig.options && processTaskConfig.options.shell
85
+ }
86
+ };
87
+ return result;
88
+ }
89
+ }
@@ -1,46 +1,46 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2019 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 { assert } from 'chai';
18
- import { Container } from '@theia/core/shared/inversify';
19
- import { ProvidedTaskConfigurations } from './provided-task-configurations';
20
- import { TaskDefinitionRegistry } from './task-definition-registry';
21
- import { TaskProviderRegistry } from './task-contribution';
22
- import { TaskConfiguration } from '../common';
23
-
24
- describe('provided-task-configurations', () => {
25
- let container: Container;
26
- beforeEach(() => {
27
- container = new Container();
28
- container.bind(ProvidedTaskConfigurations).toSelf().inSingletonScope();
29
- container.bind(TaskProviderRegistry).toSelf().inSingletonScope();
30
- container.bind(TaskDefinitionRegistry).toSelf().inSingletonScope();
31
- });
32
-
33
- it('provided-task-search', async () => {
34
- const providerRegistry = container.get(TaskProviderRegistry);
35
- providerRegistry.register('test', {
36
- provideTasks(): Promise<TaskConfiguration[]> {
37
- return Promise.resolve([{ type: 'test', label: 'task from test', _source: 'test', _scope: 'test' } as TaskConfiguration]);
38
- }
39
- });
40
-
41
- const task = await container.get(ProvidedTaskConfigurations).getTask(1, 'test', 'task from test', 'test');
42
- assert.isOk(task);
43
- assert.equal(task!.type, 'test');
44
- assert.equal(task!.label, 'task from test');
45
- });
46
- });
1
+ // *****************************************************************************
2
+ // Copyright (C) 2019 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 { assert } from 'chai';
18
+ import { Container } from '@theia/core/shared/inversify';
19
+ import { ProvidedTaskConfigurations } from './provided-task-configurations';
20
+ import { TaskDefinitionRegistry } from './task-definition-registry';
21
+ import { TaskProviderRegistry } from './task-contribution';
22
+ import { TaskConfiguration } from '../common';
23
+
24
+ describe('provided-task-configurations', () => {
25
+ let container: Container;
26
+ beforeEach(() => {
27
+ container = new Container();
28
+ container.bind(ProvidedTaskConfigurations).toSelf().inSingletonScope();
29
+ container.bind(TaskProviderRegistry).toSelf().inSingletonScope();
30
+ container.bind(TaskDefinitionRegistry).toSelf().inSingletonScope();
31
+ });
32
+
33
+ it('provided-task-search', async () => {
34
+ const providerRegistry = container.get(TaskProviderRegistry);
35
+ providerRegistry.register('test', {
36
+ provideTasks(): Promise<TaskConfiguration[]> {
37
+ return Promise.resolve([{ type: 'test', label: 'task from test', _source: 'test', _scope: 'test' } as TaskConfiguration]);
38
+ }
39
+ });
40
+
41
+ const task = await container.get(ProvidedTaskConfigurations).getTask(1, 'test', 'task from test', 'test');
42
+ assert.isOk(task);
43
+ assert.equal(task!.type, 'test');
44
+ assert.equal(task!.label, 'task from test');
45
+ });
46
+ });
@@ -1,170 +1,170 @@
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 { inject, injectable } from '@theia/core/shared/inversify';
18
- import { TaskProviderRegistry } from './task-contribution';
19
- import { TaskDefinitionRegistry } from './task-definition-registry';
20
- import { TaskConfiguration, TaskCustomization, TaskOutputPresentation, TaskConfigurationScope, TaskScope } from '../common';
21
-
22
- @injectable()
23
- export class ProvidedTaskConfigurations {
24
- /**
25
- * Map of source (name of extension, or path of root folder that the task config comes from) and `task config map`.
26
- * For the second level of inner map, the key is task label.
27
- * For the third level of inner map, the key is the task scope and value TaskConfiguration.
28
- */
29
- protected tasksMap = new Map<string, Map<string, Map<string | undefined, TaskConfiguration>>>();
30
-
31
- @inject(TaskProviderRegistry)
32
- protected readonly taskProviderRegistry: TaskProviderRegistry;
33
-
34
- @inject(TaskDefinitionRegistry)
35
- protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
36
-
37
- private currentToken: number = 0;
38
- private nextToken = 1;
39
-
40
- startUserAction(): number {
41
- return this.nextToken++;
42
- }
43
-
44
- /** returns a list of provided tasks */
45
- async getTasks(token: number): Promise<TaskConfiguration[]> {
46
- await this.refreshTasks(token);
47
- const tasks: TaskConfiguration[] = [];
48
- for (const taskLabelMap of this.tasksMap!.values()) {
49
- for (const taskScopeMap of taskLabelMap.values()) {
50
- for (const task of taskScopeMap.values()) {
51
- tasks.push(task);
52
- }
53
- }
54
- }
55
- return tasks;
56
- }
57
-
58
- protected async refreshTasks(token: number): Promise<void> {
59
- if (token !== this.currentToken) {
60
- this.currentToken = token;
61
- const providers = await this.taskProviderRegistry.getProviders();
62
- const providedTasks: TaskConfiguration[] = (await Promise.all(providers.map(p => p.provideTasks())))
63
- .reduce((acc, taskArray) => acc.concat(taskArray), [])
64
- // Global/User tasks from providers are not supported.
65
- .filter(task => task.scope !== TaskScope.Global)
66
- .map(providedTask => {
67
- const originalPresentation = providedTask.presentation || {};
68
- return {
69
- ...providedTask,
70
- presentation: {
71
- ...TaskOutputPresentation.getDefault(),
72
- ...originalPresentation
73
- }
74
- };
75
- });
76
- this.cacheTasks(providedTasks);
77
- }
78
- }
79
-
80
- /** returns the task configuration for a given source and label or undefined if none */
81
- async getTask(token: number, source: string, taskLabel: string, scope: TaskConfigurationScope): Promise<TaskConfiguration | undefined> {
82
- await this.refreshTasks(token);
83
- return this.getCachedTask(source, taskLabel, scope);
84
- }
85
-
86
- /**
87
- * Finds the detected task for the given task customization.
88
- * The detected task is considered as a "match" to the task customization if it has all the `required` properties.
89
- * In case that more than one customization is found, return the one that has the biggest number of matched properties.
90
- *
91
- * @param customization the task customization
92
- * @return the detected task for the given task customization. If the task customization is not found, `undefined` is returned.
93
- */
94
- async getTaskToCustomize(token: number, customization: TaskCustomization, scope: TaskConfigurationScope): Promise<TaskConfiguration | undefined> {
95
- const definition = this.taskDefinitionRegistry.getDefinition(customization);
96
- if (!definition) {
97
- return undefined;
98
- }
99
-
100
- const matchedTasks: TaskConfiguration[] = [];
101
- let highest = -1;
102
- const tasks = await this.getTasks(token);
103
- for (const task of tasks) { // find detected tasks that match the `definition`
104
- const required = definition.properties.required || [];
105
- if (!required.every(requiredProp => customization[requiredProp] !== undefined)) {
106
- continue;
107
- }
108
- let score = required.length; // number of required properties
109
- const requiredProps = new Set(required);
110
- // number of optional properties
111
- score += definition.properties.all.filter(p => !requiredProps.has(p) && customization[p] !== undefined).length;
112
- if (score >= highest) {
113
- if (score > highest) {
114
- highest = score;
115
- matchedTasks.length = 0;
116
- }
117
- matchedTasks.push(task);
118
- }
119
- }
120
-
121
- // Tasks with scope set to 'Workspace' can be customized in a workspace root, and will not match
122
- // providers scope 'TaskScope.Workspace' unless specifically included as below.
123
- const scopes = [scope, TaskScope.Workspace];
124
- // find the task that matches the `customization`.
125
- // The scenario where more than one match is found should not happen unless users manually enter multiple customizations for one type of task
126
- // If this does happen, return the first match
127
- const matchedTask = matchedTasks.find(t =>
128
- scopes.some(scp => scp === t._scope) && definition.properties.all.every(p => t[p] === customization[p])
129
- );
130
- return matchedTask;
131
- }
132
-
133
- protected getCachedTask(source: string, taskLabel: string, scope?: TaskConfigurationScope): TaskConfiguration | undefined {
134
- const labelConfigMap = this.tasksMap.get(source);
135
- if (labelConfigMap) {
136
- const scopeConfigMap = labelConfigMap.get(taskLabel);
137
- if (scopeConfigMap) {
138
- if (scope) {
139
- return scopeConfigMap.get(scope.toString());
140
- }
141
- return Array.from(scopeConfigMap.values())[0];
142
- }
143
- }
144
- }
145
-
146
- protected cacheTasks(tasks: TaskConfiguration[]): void {
147
- this.tasksMap.clear();
148
- for (const task of tasks) {
149
- const label = task.label;
150
- const source = task._source;
151
- const scope = task._scope;
152
- if (this.tasksMap.has(source)) {
153
- const labelConfigMap = this.tasksMap.get(source)!;
154
- if (labelConfigMap.has(label)) {
155
- labelConfigMap.get(label)!.set(scope.toString(), task);
156
- } else {
157
- const newScopeConfigMap = new Map<undefined | string, TaskConfiguration>();
158
- newScopeConfigMap.set(scope.toString(), task);
159
- labelConfigMap.set(label, newScopeConfigMap);
160
- }
161
- } else {
162
- const newLabelConfigMap = new Map<string, Map<undefined | string, TaskConfiguration>>();
163
- const newScopeConfigMap = new Map<undefined | string, TaskConfiguration>();
164
- newScopeConfigMap.set(scope.toString(), task);
165
- newLabelConfigMap.set(label, newScopeConfigMap);
166
- this.tasksMap.set(source, newLabelConfigMap);
167
- }
168
- }
169
- }
170
- }
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 { inject, injectable } from '@theia/core/shared/inversify';
18
+ import { TaskProviderRegistry } from './task-contribution';
19
+ import { TaskDefinitionRegistry } from './task-definition-registry';
20
+ import { TaskConfiguration, TaskCustomization, TaskOutputPresentation, TaskConfigurationScope, TaskScope } from '../common';
21
+
22
+ @injectable()
23
+ export class ProvidedTaskConfigurations {
24
+ /**
25
+ * Map of source (name of extension, or path of root folder that the task config comes from) and `task config map`.
26
+ * For the second level of inner map, the key is task label.
27
+ * For the third level of inner map, the key is the task scope and value TaskConfiguration.
28
+ */
29
+ protected tasksMap = new Map<string, Map<string, Map<string | undefined, TaskConfiguration>>>();
30
+
31
+ @inject(TaskProviderRegistry)
32
+ protected readonly taskProviderRegistry: TaskProviderRegistry;
33
+
34
+ @inject(TaskDefinitionRegistry)
35
+ protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
36
+
37
+ private currentToken: number = 0;
38
+ private nextToken = 1;
39
+
40
+ startUserAction(): number {
41
+ return this.nextToken++;
42
+ }
43
+
44
+ /** returns a list of provided tasks */
45
+ async getTasks(token: number): Promise<TaskConfiguration[]> {
46
+ await this.refreshTasks(token);
47
+ const tasks: TaskConfiguration[] = [];
48
+ for (const taskLabelMap of this.tasksMap!.values()) {
49
+ for (const taskScopeMap of taskLabelMap.values()) {
50
+ for (const task of taskScopeMap.values()) {
51
+ tasks.push(task);
52
+ }
53
+ }
54
+ }
55
+ return tasks;
56
+ }
57
+
58
+ protected async refreshTasks(token: number): Promise<void> {
59
+ if (token !== this.currentToken) {
60
+ this.currentToken = token;
61
+ const providers = await this.taskProviderRegistry.getProviders();
62
+ const providedTasks: TaskConfiguration[] = (await Promise.all(providers.map(p => p.provideTasks())))
63
+ .reduce((acc, taskArray) => acc.concat(taskArray), [])
64
+ // Global/User tasks from providers are not supported.
65
+ .filter(task => task.scope !== TaskScope.Global)
66
+ .map(providedTask => {
67
+ const originalPresentation = providedTask.presentation || {};
68
+ return {
69
+ ...providedTask,
70
+ presentation: {
71
+ ...TaskOutputPresentation.getDefault(),
72
+ ...originalPresentation
73
+ }
74
+ };
75
+ });
76
+ this.cacheTasks(providedTasks);
77
+ }
78
+ }
79
+
80
+ /** returns the task configuration for a given source and label or undefined if none */
81
+ async getTask(token: number, source: string, taskLabel: string, scope: TaskConfigurationScope): Promise<TaskConfiguration | undefined> {
82
+ await this.refreshTasks(token);
83
+ return this.getCachedTask(source, taskLabel, scope);
84
+ }
85
+
86
+ /**
87
+ * Finds the detected task for the given task customization.
88
+ * The detected task is considered as a "match" to the task customization if it has all the `required` properties.
89
+ * In case that more than one customization is found, return the one that has the biggest number of matched properties.
90
+ *
91
+ * @param customization the task customization
92
+ * @return the detected task for the given task customization. If the task customization is not found, `undefined` is returned.
93
+ */
94
+ async getTaskToCustomize(token: number, customization: TaskCustomization, scope: TaskConfigurationScope): Promise<TaskConfiguration | undefined> {
95
+ const definition = this.taskDefinitionRegistry.getDefinition(customization);
96
+ if (!definition) {
97
+ return undefined;
98
+ }
99
+
100
+ const matchedTasks: TaskConfiguration[] = [];
101
+ let highest = -1;
102
+ const tasks = await this.getTasks(token);
103
+ for (const task of tasks) { // find detected tasks that match the `definition`
104
+ const required = definition.properties.required || [];
105
+ if (!required.every(requiredProp => customization[requiredProp] !== undefined)) {
106
+ continue;
107
+ }
108
+ let score = required.length; // number of required properties
109
+ const requiredProps = new Set(required);
110
+ // number of optional properties
111
+ score += definition.properties.all.filter(p => !requiredProps.has(p) && customization[p] !== undefined).length;
112
+ if (score >= highest) {
113
+ if (score > highest) {
114
+ highest = score;
115
+ matchedTasks.length = 0;
116
+ }
117
+ matchedTasks.push(task);
118
+ }
119
+ }
120
+
121
+ // Tasks with scope set to 'Workspace' can be customized in a workspace root, and will not match
122
+ // providers scope 'TaskScope.Workspace' unless specifically included as below.
123
+ const scopes = [scope, TaskScope.Workspace];
124
+ // find the task that matches the `customization`.
125
+ // The scenario where more than one match is found should not happen unless users manually enter multiple customizations for one type of task
126
+ // If this does happen, return the first match
127
+ const matchedTask = matchedTasks.find(t =>
128
+ scopes.some(scp => scp === t._scope) && definition.properties.all.every(p => t[p] === customization[p])
129
+ );
130
+ return matchedTask;
131
+ }
132
+
133
+ protected getCachedTask(source: string, taskLabel: string, scope?: TaskConfigurationScope): TaskConfiguration | undefined {
134
+ const labelConfigMap = this.tasksMap.get(source);
135
+ if (labelConfigMap) {
136
+ const scopeConfigMap = labelConfigMap.get(taskLabel);
137
+ if (scopeConfigMap) {
138
+ if (scope) {
139
+ return scopeConfigMap.get(scope.toString());
140
+ }
141
+ return Array.from(scopeConfigMap.values())[0];
142
+ }
143
+ }
144
+ }
145
+
146
+ protected cacheTasks(tasks: TaskConfiguration[]): void {
147
+ this.tasksMap.clear();
148
+ for (const task of tasks) {
149
+ const label = task.label;
150
+ const source = task._source;
151
+ const scope = task._scope;
152
+ if (this.tasksMap.has(source)) {
153
+ const labelConfigMap = this.tasksMap.get(source)!;
154
+ if (labelConfigMap.has(label)) {
155
+ labelConfigMap.get(label)!.set(scope.toString(), task);
156
+ } else {
157
+ const newScopeConfigMap = new Map<undefined | string, TaskConfiguration>();
158
+ newScopeConfigMap.set(scope.toString(), task);
159
+ labelConfigMap.set(label, newScopeConfigMap);
160
+ }
161
+ } else {
162
+ const newLabelConfigMap = new Map<string, Map<undefined | string, TaskConfiguration>>();
163
+ const newScopeConfigMap = new Map<undefined | string, TaskConfiguration>();
164
+ newScopeConfigMap.set(scope.toString(), task);
165
+ newLabelConfigMap.set(label, newScopeConfigMap);
166
+ this.tasksMap.set(source, newLabelConfigMap);
167
+ }
168
+ }
169
+ }
170
+ }