Handle unused directive problems (#1588)

* Add directive fix type * Handle unused directive problems * Avoid double sets * Add explanation * Simplify metadata * Replace ifs by map entry
microsoft · Feb 16, 2023 · 560df86 · 560df86
1 parent 0dee5b2
commit 560df86
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/server/src/eslint.ts b/server/src/eslint.ts
@@ -123,8 +123,19 @@ export type RuleMetaData = {
 };
 
 export namespace RuleMetaData {
+	// For unused eslint-disable comments, ESLint does not include a rule ID
+	// nor any other metadata (although they do provide a fix). In order to
+	// provide code actions for these, we create a fake rule ID and metadata.
+	export const unusedDisableDirectiveId = 'unused-disable-directive';
+	const unusedDisableDirectiveMeta: RuleMetaData = {
+		docs: {
+			url: 'https://eslint.org/docs/latest/use/configure/rules#report-unused-eslint-disable-comments'
+		},
+		type: 'directive'
+	};
+
 	const handled: Set<string> = new Set();
-	const ruleId2Meta: Map<string, RuleMetaData> = new Map();
+	const ruleId2Meta: Map<string, RuleMetaData> = new Map([[unusedDisableDirectiveId, unusedDisableDirectiveMeta]]);
 
 	export function capture(eslint: ESLintClass, reports: ESLintDocumentReport[]): void {
 		let rulesMetaData: Record<string, RuleMetaData> | undefined;
@@ -154,6 +165,7 @@ export namespace RuleMetaData {
 	export function clear(): void {
 		handled.clear();
 		ruleId2Meta.clear();
+		ruleId2Meta.set(unusedDisableDirectiveId, unusedDisableDirectiveMeta);
 	}
 
 	export function getUrl(ruleId: string): string | undefined {
@@ -167,6 +179,10 @@ export namespace RuleMetaData {
 	export function hasRuleId(ruleId: string): boolean {
 		return ruleId2Meta.has(ruleId);
 	}
+
+	export function isUnusedDisableDirectiveProblem(problem: ESLintProblem): boolean {
+		return problem.ruleId === null && problem.message.startsWith('Unused eslint-disable directive');
+	}
 }
 
 export type ParserOptions = {
@@ -1081,7 +1097,7 @@ export namespace ESLint {
 		}
 	}
 
-	const validFixTypes = new Set<string>(['problem', 'suggestion', 'layout']);
+	const validFixTypes = new Set<string>(['problem', 'suggestion', 'layout', 'directive']);
 	export async function validate(document: TextDocument, settings: TextDocumentSettings & { library: ESLintModule }): Promise<Diagnostic[]> {
 		const newOptions: CLIOptions = Object.assign(Object.create(null), settings.options);
 		let fixTypes: Set<string> | undefined = undefined;
@@ -1121,6 +1137,10 @@ export namespace ESLint {
 									CodeActions.record(document, diagnostic, problem);
 								}
 							} else {
+								if (RuleMetaData.isUnusedDisableDirectiveProblem(problem)) {
+									problem.ruleId = RuleMetaData.unusedDisableDirectiveId;
+								}
+
 								CodeActions.record(document, diagnostic, problem);
 							}
 						}

diff --git a/server/src/eslintServer.ts b/server/src/eslintServer.ts
@@ -845,7 +845,7 @@ messageQueue.registerRequest(CodeActionRequest.type, async (params) => {
 			});
 		}
 
-		if (settings.codeAction.disableRuleComment.enable) {
+		if (settings.codeAction.disableRuleComment.enable && ruleId !== RuleMetaData.unusedDisableDirectiveId) {
 			let workspaceChange = new WorkspaceChange();
 			if (settings.codeAction.disableRuleComment.location === 'sameLine') {
 				workspaceChange.getTextEditChange({ uri, version: documentVersion }).add(createDisableSameLineTextEdit(textDocument, editInfo));