Merge pull request #14 from salesforce/r-n-d/task-provider

Add Bazel task provider

Author: LeonovecSergey

.github/workflows/main.yml

@@ -25,7 +25,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '14'
-      - run: sudo npm install -g vsce
+      - run: sudo npm install -g vsce --unsafe-perm
       - run: npm install
       - run: npm run compile
       - run: vsce package

README.md

@@ -52,3 +52,27 @@ You can download the latest build from the [Releases](https://github.com/salesfo
     }
     ```
 10. Once installed, restart VS Code
+
+
+Task Provider
+--------------------
+
+You can use the example from the bazelTaskProvider.ts to create VSCode tasks.
+
+The example provides tasks:
+
+* Run 'Build' and 'Test' to run bazel build an test for all targets.
+
+* Run 'Dependencies' query to creat all targets dependency graph.
+
+* Run 'Formatting' to formatt all BUILD and WORKSPACE files. 
+
+* Run 'Unused deps' to check unused dependencies.
+
+NOTE! Tasks 'Formatting' and 'Unused deps' require [buildifier](https://github.com/bazelbuild/buildtools/blob/master/buildifier/README.md) and [unused deps](https://github.com/bazelbuild/buildtools/blob/master/unused_deps/README.md) installed respectively.
+
+
+Remote Development
+--------------------
+
+If you are using Visual Studio Code Remote Development for work, please note that 'Bazel' and other additional tools must be installed on the server. 

package.json

@@ -42,7 +42,26 @@
 					"group": "MenuViewTitle"
 				}
 			]
-		}
+		},
+		"taskDefinitions": [
+			{
+				"type": "bazel",
+				"required": [
+					"name",
+					"task"
+				],
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "The task name"
+					},
+					"task": {
+						"type": "string",
+						"description": "The task command"
+					}
+				}
+			}
+		]
 	},
 	"scripts": {
 		"vscode:prepublish": "gulp build-plugin",

src/bazelTaskProvider.ts

@@ -0,0 +1,83 @@
+
+import * as vscode from 'vscode';
+
+export class BazelTaskProvider implements vscode.TaskProvider {
+
+	static BazelType = 'bazel';
+	private bazelPromise: Thenable<vscode.Task[]> | undefined = undefined;
+
+	public provideTasks(): Thenable<vscode.Task[]> | undefined {
+		if (!this.bazelPromise) {
+			this.bazelPromise = getBazelTasks();
+		}
+		return this.bazelPromise;
+	}
+
+	public resolveTask(_task: vscode.Task): vscode.Task | undefined {
+		const task = _task.definition.task;
+		if (task) {
+			// resolveTask requires that the same definition object be used.
+			const definition: BazelTaskDefinition = <any>_task.definition;
+			return new vscode.Task(definition, _task.scope ?? vscode.TaskScope.Workspace, definition.name, definition.type, new vscode.ShellExecution(`${definition.task}`));
+		}
+		return undefined;
+	}
+
+}
+
+interface BazelTaskDefinition extends vscode.TaskDefinition {
+
+}
+
+async function getBazelTasks(): Promise<vscode.Task[]> {
+
+	const tasksDefenitions: BazelTaskDefinition[] = [];
+
+	tasksDefenitions.push(
+		{
+			type: 'bazel',
+			name: 'Build',
+			task: 'bazel build //...'
+		}
+	);
+
+	tasksDefenitions.push(
+		{
+			type: 'bazel',
+			name: 'Test',
+			task: 'bazel test //...'
+		}
+	);
+
+	tasksDefenitions.push(
+		{
+			type: 'bazel',
+			name: 'Dependencies',
+			task: 'bazel query  --notool_deps --noimplicit_deps \"deps(//...)\" --output graph'
+		}
+	);
+
+	tasksDefenitions.push(
+		{
+			type: 'bazel',
+			name: 'Formatting',
+			task: 'buildifier -r . && echo \"Formatted\"'
+		}
+	);
+
+	tasksDefenitions.push(
+		{
+			type: 'bazel',
+			name: 'Unused deps',
+			task: 'unused_deps //...'
+		}
+	);
+
+	const result: vscode.Task[] = [];
+
+	tasksDefenitions.forEach(function (value) {
+		result.push(new vscode.Task(value, vscode.TaskScope.Workspace, `${value.name}`, `${value.type}`, new vscode.ShellExecution(`${value.task}`)));
+	});
+
+	return result;
+}

src/extension.ts

@@ -1,6 +1,9 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 import * as pieditor from './editor';
+import { BazelTaskProvider } from './bazelTaskProvider';
+
+let bazelTaskProvider: vscode.Disposable | undefined;
 
 export function activate(context: vscode.ExtensionContext) {
 	let panel: vscode.WebviewPanel | undefined = undefined;
@@ -49,7 +52,14 @@ export function activate(context: vscode.ExtensionContext) {
 	});
 
 	context.subscriptions.push(viewTitleDisp);
+
+	bazelTaskProvider = vscode.tasks.registerTaskProvider(BazelTaskProvider.BazelType, new BazelTaskProvider());
+
 }
 
 // this method is called when your extension is deactivated
-export function deactivate() { }
+export function deactivate() { 
+	if (bazelTaskProvider) {
+		bazelTaskProvider.dispose();
+	}
+}