Merge pull request #410 from jackrl/workspace-lint-task

Create a task provider for linting the whole workspace

client/src/extension.ts

@@ -8,7 +8,7 @@ import * as path from 'path';
 import * as fs from 'fs';
 import {
 	workspace as Workspace, window as Window, commands as Commands, languages as Languages, Disposable, ExtensionContext, Uri, StatusBarAlignment, TextDocument,
-	CodeActionContext, Diagnostic, ProviderResult, Command, QuickPickItem, WorkspaceFolder as VWorkspaceFolder
+	CodeActionContext, Diagnostic, ProviderResult, Command, QuickPickItem, WorkspaceFolder as VWorkspaceFolder, Task, TaskDefinition, ShellExecution
 } from 'vscode';
 import {
 	LanguageClient, LanguageClientOptions, RequestType, TransportKind,
@@ -241,6 +241,52 @@ function createDefaultConfiguration(): void {
 	});
 }
 
+let taskProvider: Disposable | undefined;
+
+function manageEslintTask(): void {
+	let enableLintTask: boolean = Workspace.getConfiguration('eslint').get('enableLintTask');
+
+	if(!taskProvider && enableLintTask) {
+		interface EslintTaskDefinition extends TaskDefinition {}
+
+		function createTask(): Task[] {
+			try {
+				let tasks: Task[] = [];
+
+				const kind: EslintTaskDefinition = {
+					type: 'eslint'
+				};
+				const taskName = 'lint workspace'
+				let command = ".\\node_modules\\.bin\\eslint ."
+				if(process.platform !== 'win32') {
+					command = "./node_modules/.bin/eslint ."
+				}
+				tasks.push(new Task(kind, taskName, 'ESLint', new ShellExecution(command), '$eslint-stylish'));
+				return tasks;
+			} catch (e) {
+				throw new Error(e);
+			}
+		}
+
+		taskProvider = Workspace.registerTaskProvider('eslint', {
+			provideTasks: () => {
+				return createTask();
+			},
+			resolveTask(_task: Task): Task | undefined {
+				return undefined;
+			}
+		});
+	} else if(taskProvider && !enableLintTask) {
+		const reloadAction = 'Reload';
+		Window.showInformationMessage("'ESLint: lint workspace' task will be removed after reloading the window.", reloadAction)
+			.then(selectedAction => {
+				if(selectedAction === reloadAction) {
+					Commands.executeCommand('workbench.action.reloadWindow');
+				}
+			});
+	}
+}
+
 let dummyCommands: Disposable[];
 
 let defaultLanguages = ['javascript', 'javascriptreact'];
@@ -279,6 +325,7 @@ export function activate(context: ExtensionContext) {
 		if (activated) {
 			return;
 		}
+		manageEslintTask();
 		for (let textDocument of Workspace.textDocuments) {
 			if (shouldBeValidated(textDocument)) {
 				openListener.dispose();
@@ -723,4 +770,8 @@ export function deactivate() {
 	if (dummyCommands) {
 		dummyCommands.forEach(command => command.dispose());
 	}
+
+	if (taskProvider) {
+		taskProvider.dispose();
+	}
 }

package.json

@@ -155,6 +155,12 @@
 						"javascriptreact"
 					],
 					"description": "An array of language ids which should be validated by ESLint"
+				},
+				"eslint.enableLintTask": {
+					"scope": "resource",
+					"type": "boolean",
+					"default": false,
+					"description": "Controls whether a task for linting the whole workspace will be available."
 				}
 			}
 		},