@theia/task 1.45.1 → 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
package/README.md CHANGED
@@ -1,193 +1,193 @@
1
- <div align='center'>
2
-
3
- <br />
4
-
5
- <img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
6
-
7
- <h2>ECLIPSE THEIA - TASK EXTENSION</h2>
8
-
9
- <hr />
10
-
11
- </div>
12
-
13
- ## Description
14
-
15
- The `@theia/task` extension extension permits executing scripts or binaries in the application's backend.
16
-
17
- Tasks launch configurations can be defined independently for each workspace, under `.theia/tasks.json`. When present, they are automatically picked-up when a client opens a workspace, and watches for changes. A task can be executed by triggering the "Run Task" command (shortcut F1). A list of known tasks will then be available, one of which can be selected to trigger execution.
18
-
19
- Each task configuration looks like this:
20
- ``` json
21
- {
22
- "label": "Test task - list workspace files recursively",
23
- "type": "shell",
24
- "command": "ls",
25
- "args": [
26
- "-alR"
27
- ],
28
- "options": {
29
- "cwd": "${workspaceFolder}"
30
- },
31
- "windows": {
32
- "command": "cmd.exe",
33
- "args": [
34
- "/c",
35
- "dir",
36
- "/s"
37
- ]
38
- }
39
- }
40
- ```
41
-
42
- *label*: a unique string that identifies the task. That's what's shown to the user, when it's time to chose one task configuration to run.
43
-
44
- *type*: determines what type of process will be used to execute the task. Can be "process" or "shell". "Shell" processes' output can be shown in Theia's frontend, in a terminal widget. If type set as "process" then task will be run without their output being shown.
45
-
46
- *command*: the actual command or script to execute. The command can have no path (e.g. "ls") if it can be found in the system path. Else it can have an absolute path, in which case there is no confusion. Or it can have a relative path, in which case it will be interpreted to be relative to cwd. e.g. "./task" would be interpreted to mean a script or binary called "task", right under the workspace root directory.
47
-
48
- *args*: a list of strings, each one being one argument to pass to the command.
49
-
50
- *options*: the command options used when the command is executed. This is the place to provide the
51
- - *cwd*: the current working directory, in which the task's command will execute. This is the equivalent of doing a "cd" to that directory, on the command-line, before running the command. This can contain the variable *${workspaceFolder}*, which will be replaced at execution time by the path of the current workspace. If left undefined, will by default be set to workspace root.
52
- - *env*: the environment of the executed program or shell. If omitted the parent process' environment is used.
53
- - *shell*: configuration of the shell when task type is `shell`, where users can specify the shell to use with *shell*, and the arguments to be passed to the shell executable to run in command mode with *args*.
54
-
55
- By default, *command* and *args* above are used on all platforms. However it's not always possible to express a task in the same way, both on Unix and Windows. The command and/or arguments may be different, for example. If a task needs to work on Linux, MacOS, and Windows, it is better to have separated command, command arguments, and options.
56
-
57
- *windows*: if *windows* is defined, its command, command arguments, and options (i.e., *windows.command*, *windows.args*, and *windows.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a Windows backend.
58
-
59
- *osx*: if *osx* is defined, its command, command arguments, and options (i.e., *osx.command*, *osx.args*, and *osx.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a MacOS backend.
60
-
61
- *linux*: if *linux* is defined, its command, command arguments, and options (i.e., *linux.command*, *linux.args*, and *linux.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a Linux backend.
62
-
63
- Here is a sample tasks.json that can be used to test tasks. Just add this content under the theia source directory, in directory `.theia`:
64
- ``` json
65
- {
66
- // Some sample Theia tasks
67
- "tasks": [
68
- {
69
- "label": "[Task] short running test task (~3s)",
70
- "type": "shell",
71
- "command": "./task",
72
- "args": [
73
- "default 1",
74
- "default 2",
75
- "default 3"
76
- ],
77
- "options": {
78
- "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
79
- },
80
- "windows": {
81
- "command": "cmd.exe",
82
- "args": [
83
- "/c",
84
- "task.bat",
85
- "windows abc"
86
- ]
87
- },
88
- "linux": {
89
- "args": [
90
- "linux 1",
91
- "linux 2",
92
- "linux 3"
93
- ]
94
- }
95
- },
96
- {
97
- "label": "[Task] long running test task (~300s)",
98
- "type": "shell",
99
- "command": "./task-long-running",
100
- "args": [],
101
- "options": {
102
- "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
103
- },
104
- "windows": {
105
- "command": "cmd.exe",
106
- "args": [
107
- "/c",
108
- "task-long-running.bat"
109
- ]
110
- }
111
- },
112
- {
113
- "label": "[Task] recursively list files from workspace root",
114
- "type": "shell",
115
- "command": "ls",
116
- "args": [
117
- "-alR"
118
- ],
119
- "options": {
120
- "cwd": "${workspaceFolder}"
121
- },
122
- "windows": {
123
- "command": "cmd.exe",
124
- "args": [
125
- "/c",
126
- "dir",
127
- "/s"
128
- ]
129
- }
130
- },
131
- {
132
- "label": "[Task] Echo a string",
133
- "type": "shell",
134
- "command": "bash",
135
- "args": [
136
- "-c",
137
- "echo 1 2 3"
138
- ],
139
- "options": {
140
- "cwd": "${workspaceFolder}"
141
- }
142
- }
143
- ]
144
- }
145
- ```
146
-
147
- ## Variables substitution
148
- The variables are supported in the following properties, using `${variableName}` syntax:
149
- - `command`
150
- - `args`
151
- - `options.cwd`
152
- - `windows.command`
153
- - `windows.args`
154
- - `windows.options.cwd`
155
- - `osx.command`
156
- - `osx.args`
157
- - `osx.options.cwd`
158
- - `linux.command`
159
- - `linux.args`
160
- - `linux.options.cwd`
161
-
162
- See [here](https://www.theia-ide.org/doc/index.html) for a detailed documentation.
163
-
164
- ## Contribution points
165
- The extension provides contribution points:
166
- - `browser/TaskContribution` - allows an extension to provide its own Task format and/or to provide the Tasks programmatically to the system
167
- ```typescript
168
- export interface TaskContribution {
169
- registerResolvers?(resolvers: TaskResolverRegistry): void;
170
- registerProviders?(providers: TaskProviderRegistry): void;
171
- }
172
- ```
173
- - `node/TaskRunnerContribution` - allows an extension to provide its own way of running/killing a Task
174
- ```typescript
175
- export interface TaskRunnerContribution {
176
- registerRunner(runners: TaskRunnerRegistry): void;
177
- }
178
- ```
179
-
180
- ## Additional Information
181
-
182
- - [API documentation for `@theia/task`](https://eclipse-theia.github.io/theia/docs/next/modules/task.html)
183
- - [Theia - GitHub](https://github.com/eclipse-theia/theia)
184
- - [Theia - Website](https://theia-ide.org/)
185
-
186
- ## License
187
-
188
- - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
189
- - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
190
-
191
- ## Trademark
192
- "Theia" is a trademark of the Eclipse Foundation
193
- https://www.eclipse.org/theia
1
+ <div align='center'>
2
+
3
+ <br />
4
+
5
+ <img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
6
+
7
+ <h2>ECLIPSE THEIA - TASK EXTENSION</h2>
8
+
9
+ <hr />
10
+
11
+ </div>
12
+
13
+ ## Description
14
+
15
+ The `@theia/task` extension extension permits executing scripts or binaries in the application's backend.
16
+
17
+ Tasks launch configurations can be defined independently for each workspace, under `.theia/tasks.json`. When present, they are automatically picked-up when a client opens a workspace, and watches for changes. A task can be executed by triggering the "Run Task" command (shortcut F1). A list of known tasks will then be available, one of which can be selected to trigger execution.
18
+
19
+ Each task configuration looks like this:
20
+ ``` json
21
+ {
22
+ "label": "Test task - list workspace files recursively",
23
+ "type": "shell",
24
+ "command": "ls",
25
+ "args": [
26
+ "-alR"
27
+ ],
28
+ "options": {
29
+ "cwd": "${workspaceFolder}"
30
+ },
31
+ "windows": {
32
+ "command": "cmd.exe",
33
+ "args": [
34
+ "/c",
35
+ "dir",
36
+ "/s"
37
+ ]
38
+ }
39
+ }
40
+ ```
41
+
42
+ *label*: a unique string that identifies the task. That's what's shown to the user, when it's time to chose one task configuration to run.
43
+
44
+ *type*: determines what type of process will be used to execute the task. Can be "process" or "shell". "Shell" processes' output can be shown in Theia's frontend, in a terminal widget. If type set as "process" then task will be run without their output being shown.
45
+
46
+ *command*: the actual command or script to execute. The command can have no path (e.g. "ls") if it can be found in the system path. Else it can have an absolute path, in which case there is no confusion. Or it can have a relative path, in which case it will be interpreted to be relative to cwd. e.g. "./task" would be interpreted to mean a script or binary called "task", right under the workspace root directory.
47
+
48
+ *args*: a list of strings, each one being one argument to pass to the command.
49
+
50
+ *options*: the command options used when the command is executed. This is the place to provide the
51
+ - *cwd*: the current working directory, in which the task's command will execute. This is the equivalent of doing a "cd" to that directory, on the command-line, before running the command. This can contain the variable *${workspaceFolder}*, which will be replaced at execution time by the path of the current workspace. If left undefined, will by default be set to workspace root.
52
+ - *env*: the environment of the executed program or shell. If omitted the parent process' environment is used.
53
+ - *shell*: configuration of the shell when task type is `shell`, where users can specify the shell to use with *shell*, and the arguments to be passed to the shell executable to run in command mode with *args*.
54
+
55
+ By default, *command* and *args* above are used on all platforms. However it's not always possible to express a task in the same way, both on Unix and Windows. The command and/or arguments may be different, for example. If a task needs to work on Linux, MacOS, and Windows, it is better to have separated command, command arguments, and options.
56
+
57
+ *windows*: if *windows* is defined, its command, command arguments, and options (i.e., *windows.command*, *windows.args*, and *windows.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a Windows backend.
58
+
59
+ *osx*: if *osx* is defined, its command, command arguments, and options (i.e., *osx.command*, *osx.args*, and *osx.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a MacOS backend.
60
+
61
+ *linux*: if *linux* is defined, its command, command arguments, and options (i.e., *linux.command*, *linux.args*, and *linux.options*) will take precedence over the *command*, *args*, and *options*, when the task is executed on a Linux backend.
62
+
63
+ Here is a sample tasks.json that can be used to test tasks. Just add this content under the theia source directory, in directory `.theia`:
64
+ ``` json
65
+ {
66
+ // Some sample Theia tasks
67
+ "tasks": [
68
+ {
69
+ "label": "[Task] short running test task (~3s)",
70
+ "type": "shell",
71
+ "command": "./task",
72
+ "args": [
73
+ "default 1",
74
+ "default 2",
75
+ "default 3"
76
+ ],
77
+ "options": {
78
+ "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
79
+ },
80
+ "windows": {
81
+ "command": "cmd.exe",
82
+ "args": [
83
+ "/c",
84
+ "task.bat",
85
+ "windows abc"
86
+ ]
87
+ },
88
+ "linux": {
89
+ "args": [
90
+ "linux 1",
91
+ "linux 2",
92
+ "linux 3"
93
+ ]
94
+ }
95
+ },
96
+ {
97
+ "label": "[Task] long running test task (~300s)",
98
+ "type": "shell",
99
+ "command": "./task-long-running",
100
+ "args": [],
101
+ "options": {
102
+ "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
103
+ },
104
+ "windows": {
105
+ "command": "cmd.exe",
106
+ "args": [
107
+ "/c",
108
+ "task-long-running.bat"
109
+ ]
110
+ }
111
+ },
112
+ {
113
+ "label": "[Task] recursively list files from workspace root",
114
+ "type": "shell",
115
+ "command": "ls",
116
+ "args": [
117
+ "-alR"
118
+ ],
119
+ "options": {
120
+ "cwd": "${workspaceFolder}"
121
+ },
122
+ "windows": {
123
+ "command": "cmd.exe",
124
+ "args": [
125
+ "/c",
126
+ "dir",
127
+ "/s"
128
+ ]
129
+ }
130
+ },
131
+ {
132
+ "label": "[Task] Echo a string",
133
+ "type": "shell",
134
+ "command": "bash",
135
+ "args": [
136
+ "-c",
137
+ "echo 1 2 3"
138
+ ],
139
+ "options": {
140
+ "cwd": "${workspaceFolder}"
141
+ }
142
+ }
143
+ ]
144
+ }
145
+ ```
146
+
147
+ ## Variables substitution
148
+ The variables are supported in the following properties, using `${variableName}` syntax:
149
+ - `command`
150
+ - `args`
151
+ - `options.cwd`
152
+ - `windows.command`
153
+ - `windows.args`
154
+ - `windows.options.cwd`
155
+ - `osx.command`
156
+ - `osx.args`
157
+ - `osx.options.cwd`
158
+ - `linux.command`
159
+ - `linux.args`
160
+ - `linux.options.cwd`
161
+
162
+ See [here](https://www.theia-ide.org/doc/index.html) for a detailed documentation.
163
+
164
+ ## Contribution points
165
+ The extension provides contribution points:
166
+ - `browser/TaskContribution` - allows an extension to provide its own Task format and/or to provide the Tasks programmatically to the system
167
+ ```typescript
168
+ export interface TaskContribution {
169
+ registerResolvers?(resolvers: TaskResolverRegistry): void;
170
+ registerProviders?(providers: TaskProviderRegistry): void;
171
+ }
172
+ ```
173
+ - `node/TaskRunnerContribution` - allows an extension to provide its own way of running/killing a Task
174
+ ```typescript
175
+ export interface TaskRunnerContribution {
176
+ registerRunner(runners: TaskRunnerRegistry): void;
177
+ }
178
+ ```
179
+
180
+ ## Additional Information
181
+
182
+ - [API documentation for `@theia/task`](https://eclipse-theia.github.io/theia/docs/next/modules/task.html)
183
+ - [Theia - GitHub](https://github.com/eclipse-theia/theia)
184
+ - [Theia - Website](https://theia-ide.org/)
185
+
186
+ ## License
187
+
188
+ - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
189
+ - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
190
+
191
+ ## Trademark
192
+ "Theia" is a trademark of the Eclipse Foundation
193
+ https://www.eclipse.org/theia
@@ -1,7 +1,7 @@
1
- export * from './task-service';
2
- export * from './task-contribution';
3
- export * from './task-definition-registry';
4
- export * from './task-problem-matcher-registry';
5
- export * from './task-problem-pattern-registry';
6
- export * from './task-schema-updater';
1
+ export * from './task-service';
2
+ export * from './task-contribution';
3
+ export * from './task-definition-registry';
4
+ export * from './task-problem-matcher-registry';
5
+ export * from './task-problem-pattern-registry';
6
+ export * from './task-schema-updater';
7
7
  //# sourceMappingURL=index.d.ts.map
@@ -1,34 +1,34 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2017 Ericsson and others.
4
- //
5
- // This program and the accompanying materials are made available under the
6
- // terms of the Eclipse Public License v. 2.0 which is available at
7
- // http://www.eclipse.org/legal/epl-2.0.
8
- //
9
- // This Source Code may also be made available under the following Secondary
10
- // Licenses when the conditions for such availability set forth in the Eclipse
11
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
- // with the GNU Classpath Exception which is available at
13
- // https://www.gnu.org/software/classpath/license.html.
14
- //
15
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
- // *****************************************************************************
17
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
18
- if (k2 === undefined) k2 = k;
19
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
20
- }) : (function(o, m, k, k2) {
21
- if (k2 === undefined) k2 = k;
22
- o[k2] = m[k];
23
- }));
24
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
25
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
26
- };
27
- Object.defineProperty(exports, "__esModule", { value: true });
28
- __exportStar(require("./task-service"), exports);
29
- __exportStar(require("./task-contribution"), exports);
30
- __exportStar(require("./task-definition-registry"), exports);
31
- __exportStar(require("./task-problem-matcher-registry"), exports);
32
- __exportStar(require("./task-problem-pattern-registry"), exports);
33
- __exportStar(require("./task-schema-updater"), exports);
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2017 Ericsson and others.
4
+ //
5
+ // This program and the accompanying materials are made available under the
6
+ // terms of the Eclipse Public License v. 2.0 which is available at
7
+ // http://www.eclipse.org/legal/epl-2.0.
8
+ //
9
+ // This Source Code may also be made available under the following Secondary
10
+ // Licenses when the conditions for such availability set forth in the Eclipse
11
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
+ // with the GNU Classpath Exception which is available at
13
+ // https://www.gnu.org/software/classpath/license.html.
14
+ //
15
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
+ // *****************************************************************************
17
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
18
+ if (k2 === undefined) k2 = k;
19
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
20
+ }) : (function(o, m, k, k2) {
21
+ if (k2 === undefined) k2 = k;
22
+ o[k2] = m[k];
23
+ }));
24
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
25
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
26
+ };
27
+ Object.defineProperty(exports, "__esModule", { value: true });
28
+ __exportStar(require("./task-service"), exports);
29
+ __exportStar(require("./task-contribution"), exports);
30
+ __exportStar(require("./task-definition-registry"), exports);
31
+ __exportStar(require("./task-problem-matcher-registry"), exports);
32
+ __exportStar(require("./task-problem-pattern-registry"), exports);
33
+ __exportStar(require("./task-schema-updater"), exports);
34
34
  //# sourceMappingURL=index.js.map
@@ -1,7 +1,7 @@
1
- import { ProcessTaskResolver } from './process-task-resolver';
2
- import { TaskContribution, TaskResolverRegistry } from '../task-contribution';
3
- export declare class ProcessTaskContribution implements TaskContribution {
4
- protected readonly processTaskResolver: ProcessTaskResolver;
5
- registerResolvers(resolvers: TaskResolverRegistry): void;
6
- }
1
+ import { ProcessTaskResolver } from './process-task-resolver';
2
+ import { TaskContribution, TaskResolverRegistry } from '../task-contribution';
3
+ export declare class ProcessTaskContribution implements TaskContribution {
4
+ protected readonly processTaskResolver: ProcessTaskResolver;
5
+ registerResolvers(resolvers: TaskResolverRegistry): void;
6
+ }
7
7
  //# sourceMappingURL=process-task-contribution.d.ts.map
@@ -1,44 +1,44 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2018 Red Hat, Inc. and others.
4
- //
5
- // This program and the accompanying materials are made available under the
6
- // terms of the Eclipse Public License v. 2.0 which is available at
7
- // http://www.eclipse.org/legal/epl-2.0.
8
- //
9
- // This Source Code may also be made available under the following Secondary
10
- // Licenses when the conditions for such availability set forth in the Eclipse
11
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
- // with the GNU Classpath Exception which is available at
13
- // https://www.gnu.org/software/classpath/license.html.
14
- //
15
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
- // *****************************************************************************
17
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
- return c > 3 && r && Object.defineProperty(target, key, r), r;
22
- };
23
- var __metadata = (this && this.__metadata) || function (k, v) {
24
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
- };
26
- Object.defineProperty(exports, "__esModule", { value: true });
27
- exports.ProcessTaskContribution = void 0;
28
- const inversify_1 = require("@theia/core/shared/inversify");
29
- const process_task_resolver_1 = require("./process-task-resolver");
30
- let ProcessTaskContribution = class ProcessTaskContribution {
31
- registerResolvers(resolvers) {
32
- resolvers.registerExecutionResolver('process', this.processTaskResolver);
33
- resolvers.registerExecutionResolver('shell', this.processTaskResolver);
34
- }
35
- };
36
- __decorate([
37
- (0, inversify_1.inject)(process_task_resolver_1.ProcessTaskResolver),
38
- __metadata("design:type", process_task_resolver_1.ProcessTaskResolver)
39
- ], ProcessTaskContribution.prototype, "processTaskResolver", void 0);
40
- ProcessTaskContribution = __decorate([
41
- (0, inversify_1.injectable)()
42
- ], ProcessTaskContribution);
43
- exports.ProcessTaskContribution = ProcessTaskContribution;
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2018 Red Hat, Inc. and others.
4
+ //
5
+ // This program and the accompanying materials are made available under the
6
+ // terms of the Eclipse Public License v. 2.0 which is available at
7
+ // http://www.eclipse.org/legal/epl-2.0.
8
+ //
9
+ // This Source Code may also be made available under the following Secondary
10
+ // Licenses when the conditions for such availability set forth in the Eclipse
11
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
+ // with the GNU Classpath Exception which is available at
13
+ // https://www.gnu.org/software/classpath/license.html.
14
+ //
15
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
+ // *****************************************************************************
17
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
22
+ };
23
+ var __metadata = (this && this.__metadata) || function (k, v) {
24
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
+ };
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.ProcessTaskContribution = void 0;
28
+ const inversify_1 = require("@theia/core/shared/inversify");
29
+ const process_task_resolver_1 = require("./process-task-resolver");
30
+ let ProcessTaskContribution = class ProcessTaskContribution {
31
+ registerResolvers(resolvers) {
32
+ resolvers.registerExecutionResolver('process', this.processTaskResolver);
33
+ resolvers.registerExecutionResolver('shell', this.processTaskResolver);
34
+ }
35
+ };
36
+ __decorate([
37
+ (0, inversify_1.inject)(process_task_resolver_1.ProcessTaskResolver),
38
+ __metadata("design:type", process_task_resolver_1.ProcessTaskResolver)
39
+ ], ProcessTaskContribution.prototype, "processTaskResolver", void 0);
40
+ ProcessTaskContribution = __decorate([
41
+ (0, inversify_1.injectable)()
42
+ ], ProcessTaskContribution);
43
+ exports.ProcessTaskContribution = ProcessTaskContribution;
44
44
  //# sourceMappingURL=process-task-contribution.js.map
@@ -1,3 +1,3 @@
1
- import { interfaces } from '@theia/core/shared/inversify';
2
- export declare function bindProcessTaskModule(bind: interfaces.Bind): void;
1
+ import { interfaces } from '@theia/core/shared/inversify';
2
+ export declare function bindProcessTaskModule(bind: interfaces.Bind): void;
3
3
  //# sourceMappingURL=process-task-frontend-module.d.ts.map
@@ -1,28 +1,28 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2018 Red Hat, Inc. and others.
4
- //
5
- // This program and the accompanying materials are made available under the
6
- // terms of the Eclipse Public License v. 2.0 which is available at
7
- // http://www.eclipse.org/legal/epl-2.0.
8
- //
9
- // This Source Code may also be made available under the following Secondary
10
- // Licenses when the conditions for such availability set forth in the Eclipse
11
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
- // with the GNU Classpath Exception which is available at
13
- // https://www.gnu.org/software/classpath/license.html.
14
- //
15
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
- // *****************************************************************************
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.bindProcessTaskModule = void 0;
19
- const process_task_contribution_1 = require("./process-task-contribution");
20
- const process_task_resolver_1 = require("./process-task-resolver");
21
- const task_contribution_1 = require("../task-contribution");
22
- function bindProcessTaskModule(bind) {
23
- bind(process_task_resolver_1.ProcessTaskResolver).toSelf().inSingletonScope();
24
- bind(process_task_contribution_1.ProcessTaskContribution).toSelf().inSingletonScope();
25
- bind(task_contribution_1.TaskContribution).toService(process_task_contribution_1.ProcessTaskContribution);
26
- }
27
- exports.bindProcessTaskModule = bindProcessTaskModule;
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2018 Red Hat, Inc. and others.
4
+ //
5
+ // This program and the accompanying materials are made available under the
6
+ // terms of the Eclipse Public License v. 2.0 which is available at
7
+ // http://www.eclipse.org/legal/epl-2.0.
8
+ //
9
+ // This Source Code may also be made available under the following Secondary
10
+ // Licenses when the conditions for such availability set forth in the Eclipse
11
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
+ // with the GNU Classpath Exception which is available at
13
+ // https://www.gnu.org/software/classpath/license.html.
14
+ //
15
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
16
+ // *****************************************************************************
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.bindProcessTaskModule = void 0;
19
+ const process_task_contribution_1 = require("./process-task-contribution");
20
+ const process_task_resolver_1 = require("./process-task-resolver");
21
+ const task_contribution_1 = require("../task-contribution");
22
+ function bindProcessTaskModule(bind) {
23
+ bind(process_task_resolver_1.ProcessTaskResolver).toSelf().inSingletonScope();
24
+ bind(process_task_contribution_1.ProcessTaskContribution).toSelf().inSingletonScope();
25
+ bind(task_contribution_1.TaskContribution).toService(process_task_contribution_1.ProcessTaskContribution);
26
+ }
27
+ exports.bindProcessTaskModule = bindProcessTaskModule;
28
28
  //# sourceMappingURL=process-task-frontend-module.js.map