Add eslint.codeActionsOnSave.options (#1999)

* Add eslint.codeActionsOnSave.options

* fix

* Nit fixes for `markdownDescription`

* Whitespace fixes

---------

Co-authored-by: Phillip Huang <[email protected]>
Co-authored-by: Dirk Bäumer <[email protected]>

Author: 3 people

$shared/settings.ts

@@ -64,9 +64,19 @@ export namespace CodeActionsOnSaveRules {
 	}
 }
 
+export namespace CodeActionsOnSaveOptions {
+	export function from(value: object | undefined | null): ESLintOptions | undefined {
+		if (value === undefined || value === null || typeof value !== 'object') {
+			return undefined;
+		}
+		return value;
+	}
+}
+
 export type CodeActionsOnSaveSettings = {
 	mode: CodeActionsOnSaveMode;
 	rules?: string[];
+	options?: ESLintOptions;
 };
 
 export enum ESLintSeverity {

client/src/client.ts

@@ -20,7 +20,7 @@ import {
 
 import { LegacyDirectoryItem, Migration, PatternItem, ValidateItem } from './settings';
 import { ExitCalled, NoConfigRequest, NoESLintLibraryRequest, OpenESLintDocRequest, ProbeFailedRequest, ShowOutputChannel, Status, StatusNotification, StatusParams } from './shared/customMessages';
-import { CodeActionSettings, CodeActionsOnSaveMode, CodeActionsOnSaveRules, ConfigurationSettings, DirectoryItem, ESLintOptions, ESLintSeverity, ModeItem, PackageManagers, RuleCustomization, RunValues, Validate } from './shared/settings';
+import { CodeActionSettings, CodeActionsOnSaveMode, CodeActionsOnSaveOptions, CodeActionsOnSaveRules, ConfigurationSettings, DirectoryItem, ESLintOptions, ESLintSeverity, ModeItem, PackageManagers, RuleCustomization, RunValues, Validate } from './shared/settings';
 import { convert2RegExp, Is, Semaphore, toOSPath, toPosixPath } from './node-utils';
 import { pickFolder } from './vscode-utils';
 
@@ -713,6 +713,7 @@ export namespace ESLintClient {
 					settings.format = !!config.get<boolean>('format.enable', false);
 					settings.codeActionOnSave.mode = CodeActionsOnSaveMode.from(config.get<CodeActionsOnSaveMode>('codeActionsOnSave.mode', CodeActionsOnSaveMode.all));
 					settings.codeActionOnSave.rules = CodeActionsOnSaveRules.from(config.get<string[] | null>('codeActionsOnSave.rules', null));
+					settings.codeActionOnSave.options = CodeActionsOnSaveOptions.from(config.get<ESLintOptions | null>('codeActionsOnSave.options', null));
 				}
 				if (workspaceFolder !== undefined) {
 					settings.workspaceFolder = {

package.json

@@ -458,6 +458,12 @@
 					"default": null,
 					"markdownDescription": "The rules that should be executed when computing the code actions on save or formatting a file. Defaults to the rules configured via the ESLint configuration"
 				},
+				"eslint.codeActionsOnSave.options": {
+					"scope": "resource",
+					"type": "object",
+					"default": {},
+					"markdownDescription": "The ESLint options object to use on save (see https://eslint.org/docs/developer-guide/nodejs-api#eslint-class). `eslint.codeActionsOnSave.rules`, if specified, will take priority over any rule options here."
+				},
 				"eslint.format.enable": {
 					"scope": "resource",
 					"type": "boolean",

server/src/eslint.ts

@@ -18,7 +18,7 @@ import {
 import { URI } from 'vscode-uri';
 
 import { ProbeFailedParams, ProbeFailedRequest, NoESLintLibraryRequest, Status, NoConfigRequest, StatusNotification } from './shared/customMessages';
-import { ConfigurationSettings, DirectoryItem, ESLintSeverity, ModeEnum, ModeItem, PackageManagers, RuleCustomization, RuleSeverity, Validate } from './shared/settings';
+import { ConfigurationSettings, DirectoryItem, ESLintOptions, ESLintSeverity, ModeEnum, ModeItem, PackageManagers, RuleCustomization, RuleSeverity, Validate } from './shared/settings';
 
 import * as Is from './is';
 import { LRUCache } from './linkedMap';
@@ -471,7 +471,7 @@ export class Fixes {
 	}
 }
 
-export type SaveRuleConfigItem = { offRules: Set<string>; onRules: Set<string>};
+export type SaveRuleConfigItem = { offRules: Set<string>; onRules: Set<string>; options: ESLintOptions | undefined};
 
 /**
  * Manages the special save rule configurations done in the VS Code settings.
@@ -491,8 +491,9 @@ export namespace SaveRuleConfigs {
 			return result;
 		}
 		const rules = settings.codeActionOnSave.rules;
+		const options = settings.codeActionOnSave.options;
 		result = await ESLint.withClass(async (eslint) => {
-			if (rules === undefined || eslint.isCLIEngine) {
+			if ((rules === undefined && options === undefined) || eslint.isCLIEngine) {
 				return undefined;
 			}
 			const config = await eslint.calculateConfigForFile(filePath);
@@ -501,18 +502,20 @@ export namespace SaveRuleConfigs {
 			}
 			const offRules: Set<string> = new Set();
 			const onRules: Set<string> = new Set();
-			if (rules.length === 0) {
-				Object.keys(config.rules).forEach(ruleId => offRules.add(ruleId));
-			} else {
-				for (const ruleId of Object.keys(config.rules)) {
-					if (isOff(ruleId, rules)) {
-						offRules.add(ruleId);
-					} else {
-						onRules.add(ruleId);
+			if (rules !== undefined) {
+				if (rules.length === 0) {
+					Object.keys(config.rules).forEach(ruleId => offRules.add(ruleId));
+				} else {
+					for (const ruleId of Object.keys(config.rules)) {
+						if (isOff(ruleId, rules)) {
+							offRules.add(ruleId);
+						} else {
+							onRules.add(ruleId);
+						}
 					}
 				}
 			}
-			return offRules.size > 0 ? { offRules, onRules } : undefined;
+			return (offRules.size > 0 || options) ? { offRules, onRules, options } : undefined;
 		}, settings);
 		if (result === undefined || result === null) {
 			saveRuleConfigCache.set(uri, null);

server/src/eslintServer.ts

@@ -21,7 +21,7 @@ import {
 import { Validate, CodeActionsOnSaveMode } from './shared/settings';
 
 import {
-	CodeActions, ConfigData, ESLint, FixableProblem, Fixes, Problem, RuleMetaData, RuleSeverities,
+	CodeActions, ESLint, ESLintClassOptions, FixableProblem, Fixes, Problem, RuleMetaData, RuleSeverities,
 	SaveRuleConfigs, SuggestionsProblem, TextDocumentSettings,
 } from './eslint';
 
@@ -771,11 +771,18 @@ async function computeAllFixes(identifier: VersionedTextDocumentIdentifier, mode
 	} else {
 		const saveConfig = filePath !== undefined && mode === AllFixesMode.onSave ? await SaveRuleConfigs.get(uri, settings) : undefined;
 		const offRules = saveConfig?.offRules;
-		let overrideConfig: Required<ConfigData> | undefined;
-		if (offRules !== undefined) {
-			overrideConfig = { rules: Object.create(null) };
-			for (const ruleId of offRules) {
-				overrideConfig.rules[ruleId] = 'off';
+		const overrideOptions = saveConfig?.options;
+		let eslintOptions: ESLintClassOptions = { fix: true };
+		if (offRules !== undefined || overrideOptions !== undefined) {
+			if (overrideOptions !== undefined) {
+				eslintOptions = { ...eslintOptions, ...overrideOptions };
+			}
+			if (offRules !== undefined && offRules.size > 0) {
+				const overrideConfig = { rules: Object.create(null) };
+				for (const ruleId of offRules) {
+					overrideConfig.rules[ruleId] = 'off';
+				}
+				eslintOptions.overrideConfig = overrideConfig;
 			}
 		}
 		return ESLint.withClass(async (eslintClass) => {
@@ -800,7 +807,7 @@ async function computeAllFixes(identifier: VersionedTextDocumentIdentifier, mode
 				}
 			}
 			return result;
-		}, settings, overrideConfig !== undefined ? { fix: true, overrideConfig } : { fix: true });
+		}, settings, eslintOptions);
 	}
 }