Add support for testing computeEditInfo (#53)

lib/__tests__/fixtures/plugin-foo.js

@@ -18,7 +18,7 @@ const messages = ruleMessages(ruleName, {
 const isString = (value) => typeof value === 'string';
 
 /** @type {import('stylelint').Rule} */
-const ruleFunction = (primary, secondaryOptions, { fix }) => {
+const ruleFunction = (primary, secondaryOptions) => {
 	return (root, result) => {
 		const validOptions = validateOptions(
 			result,
@@ -59,24 +59,28 @@ const ruleFunction = (primary, secondaryOptions, { fix }) => {
 
 			if (primary === selector) return;
 
-			if (fix) {
-				rule.selector = primary;
-
-				return;
-			}
-
 			report({
 				result,
 				ruleName,
 				message: messages.rejected(selector),
 				node: rule,
 				word: selector,
+				fix: {
+					apply: () => {
+						rule.selector = primary;
+					},
+					node: rule,
+				},
 			});
 		});
 	};
 };
 
 ruleFunction.ruleName = ruleName;
 ruleFunction.messages = messages;
+ruleFunction.meta = {
+	url: 'plugin/foo',
+	fixable: true,
+};
 
 export default createPlugin(ruleName, ruleFunction);

lib/__tests__/testRule.test.js

@@ -99,3 +99,32 @@ testRule({
 		},
 	],
 });
+
+testRule({
+	plugins,
+	ruleName,
+	config: ['.a'],
+	computeEditInfo: true,
+
+	accept: [],
+
+	reject: [
+		{
+			code: '#a {}',
+			message: messages.rejected('#a'),
+			fix: {
+				range: [0, 1],
+				text: '.',
+			},
+		},
+		{
+			code: '.a {} #a {}',
+			message: messages.rejected('#a'),
+			description: 'with description',
+			fix: {
+				range: [6, 7],
+				text: '.',
+			},
+		},
+	],
+});

lib/index.d.ts

@@ -66,6 +66,13 @@ export type Warning = {
 	 * Expected end column number of the warning.
 	 */
 	endColumn?: number | undefined;
+
+	/**
+	 * Expected `EditInfo` of the warning.
+	 *
+	 * @experimental
+	 */
+	fix?: { range: [number, number]; text: string };
 };
 
 /**
@@ -120,6 +127,13 @@ export type TestSchema = {
 	 */
 	fix?: boolean | undefined;
 
+	/**
+	 * Turn on computing `EditInfo`. Default: `false`.
+	 *
+	 * @experimental
+	 */
+	computeEditInfo?: boolean;
+
 	/**
 	 * Maps to Stylelint's `plugins` configuration property.
 	 *

lib/index.js

@@ -73,6 +73,7 @@ export function testRule(schema) {
 					config: stylelintConfig,
 					customSyntax,
 					codeFilename: testCase.codeFilename || codeFilename,
+					computeEditInfo: schema.computeEditInfo,
 				};
 
 				const { results } = await lint(stylelintOptions);
@@ -122,6 +123,10 @@ export function testRule(schema) {
 							'Warning "endColumn" does not match',
 						);
 					}
+
+					if ('fix' in actualWarning && 'fix' in expected) {
+						assert.deepStrictEqual(actualWarning.fix, expected.fix, 'Warning "fix" does not match');
+					}
 				}
 
 				if (!fix) return;