aboutsummaryrefslogtreecommitdiff
path: root/editors/code/src/tasks.ts
diff options
context:
space:
mode:
authorJonathan Dickinson <[email protected]>2020-04-23 01:05:04 +0100
committerJonathan Dickinson <[email protected]>2020-04-23 01:05:04 +0100
commit1d8c25b75c3df04099501403126104d49ab36e7c (patch)
tree0256d51fc780d49c9a05c44ec983f73ba2d6a910 /editors/code/src/tasks.ts
parent3f1f3a835a07983344f6f3becf7a0c32b96d68bc (diff)
tasks.json Support
Move the task provider anonymous class into a real class, as this seems to be how Microsoft do this in their documentation. resolveTask is now implemented, which is used by VSCode to determine how to execute tasks that the user has defined in tasks.json.
Diffstat (limited to 'editors/code/src/tasks.ts')
-rw-r--r--editors/code/src/tasks.ts103
1 files changed, 67 insertions, 36 deletions
diff --git a/editors/code/src/tasks.ts b/editors/code/src/tasks.ts
index fa1c4a951..1366c76d6 100644
--- a/editors/code/src/tasks.ts
+++ b/editors/code/src/tasks.ts
@@ -4,49 +4,80 @@ import * as vscode from 'vscode';
4// our configuration should be compatible with it so use the same key. 4// our configuration should be compatible with it so use the same key.
5const TASK_TYPE = 'cargo'; 5const TASK_TYPE = 'cargo';
6 6
7export function activateTaskProvider(target: vscode.WorkspaceFolder): vscode.Disposable { 7interface CargoTaskDefinition extends vscode.TaskDefinition {
8 const provider: vscode.TaskProvider = { 8 command?: string;
9 args?: string[];
10 cwd?: string;
11 env?: { [key: string]: string };
12}
13
14class CargoTaskProvider implements vscode.TaskProvider {
15 private readonly target: vscode.WorkspaceFolder;
16
17 constructor(target: vscode.WorkspaceFolder) {
18 this.target = target;
19 }
20
21 provideTasks(): vscode.Task[] {
9 // Detect Rust tasks. Currently we do not do any actual detection 22 // Detect Rust tasks. Currently we do not do any actual detection
10 // of tasks (e.g. aliases in .cargo/config) and just return a fixed 23 // of tasks (e.g. aliases in .cargo/config) and just return a fixed
11 // set of tasks that always exist. These tasks cannot be removed in 24 // set of tasks that always exist. These tasks cannot be removed in
12 // tasks.json - only tweaked. 25 // tasks.json - only tweaked.
13 provideTasks: () => getStandardCargoTasks(target),
14 26
15 // We don't need to implement this. 27 return [
16 resolveTask: () => undefined, 28 { command: 'build', group: vscode.TaskGroup.Build },
17 }; 29 { command: 'check', group: vscode.TaskGroup.Build },
30 { command: 'test', group: vscode.TaskGroup.Test },
31 { command: 'clean', group: vscode.TaskGroup.Clean },
32 { command: 'run', group: undefined },
33 ]
34 .map(({ command, group }) => {
35 const vscodeTask = new vscode.Task(
36 // The contents of this object end up in the tasks.json entries.
37 {
38 type: TASK_TYPE,
39 command,
40 },
41 // The scope of the task - workspace or specific folder (global
42 // is not supported).
43 this.target,
44 // The task name, and task source. These are shown in the UI as
45 // `${source}: ${name}`, e.g. `rust: cargo build`.
46 `cargo ${command}`,
47 'rust',
48 // What to do when this command is executed.
49 new vscode.ShellExecution('cargo', [command]),
50 // Problem matchers.
51 ['$rustc'],
52 );
53 vscodeTask.group = group;
54 return vscodeTask;
55 });
56 }
18 57
19 return vscode.tasks.registerTaskProvider(TASK_TYPE, provider); 58 resolveTask(task: vscode.Task): vscode.Task | undefined {
20} 59 // VSCode calls this for every cargo task in the user's tasks.json,
60 // we need to inform VSCode how to execute that command by creating
61 // a ShellExecution for it.
21 62
22function getStandardCargoTasks(target: vscode.WorkspaceFolder): vscode.Task[] { 63 const definition = task.definition as CargoTaskDefinition;
23 return [ 64
24 { command: 'build', group: vscode.TaskGroup.Build }, 65 if (definition.type === 'cargo' && definition.command) {
25 { command: 'check', group: vscode.TaskGroup.Build }, 66 const args = [definition.command].concat(definition.args ?? []);
26 { command: 'test', group: vscode.TaskGroup.Test }, 67
27 { command: 'clean', group: vscode.TaskGroup.Clean }, 68 return new vscode.Task(
28 { command: 'run', group: undefined }, 69 definition,
29 ] 70 task.name,
30 .map(({ command, group }) => {
31 const vscodeTask = new vscode.Task(
32 // The contents of this object end up in the tasks.json entries.
33 {
34 type: TASK_TYPE,
35 command,
36 },
37 // The scope of the task - workspace or specific folder (global
38 // is not supported).
39 target,
40 // The task name, and task source. These are shown in the UI as
41 // `${source}: ${name}`, e.g. `rust: cargo build`.
42 `cargo ${command}`,
43 'rust', 71 'rust',
44 // What to do when this command is executed. 72 new vscode.ShellExecution('cargo', args, definition),
45 new vscode.ShellExecution('cargo', [command]),
46 // Problem matchers.
47 ['$rustc'],
48 ); 73 );
49 vscodeTask.group = group; 74 }
50 return vscodeTask; 75
51 }); 76 return undefined;
77 }
52} 78}
79
80export function activateTaskProvider(target: vscode.WorkspaceFolder): vscode.Disposable {
81 const provider = new CargoTaskProvider(target);
82 return vscode.tasks.registerTaskProvider(TASK_TYPE, provider);
83} \ No newline at end of file