fix: Types to align with older ESLint types (#155)

nzakas · fasttime · web-flow · commit 664740a8d4a9 · 2025-02-21T12:47:20.000+01:00
Co-authored-by: Francesco Trotta &lt;github@fasttime.org&gt;
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -459,6 +459,15 @@ export interface RuleTextEdit {
 
 // #endregion
 
+/**
+ * Fixes a violation.
+ * @param fixer The text editor to apply the fix.
+ * @returns The fix(es) for the violation.
+ */
+type RuleFixer = (
+	fixer: RuleTextEditor,
+) => RuleTextEdit | Iterable<RuleTextEdit> | null;
+
 interface ViolationReportBase {
 	/**
 	 * The type of node that the violation is for.
@@ -473,22 +482,22 @@ interface ViolationReportBase {
 
 	/**
 	 * The fix to be applied for the violation.
-	 * @param fixer The text editor to apply the fix.
-	 * @returns The fix(es) for the violation.
 	 */
-	fix?(fixer: RuleTextEditor): RuleTextEdit | Iterable<RuleTextEdit> | null;
+	fix?: RuleFixer | null | undefined;
 
 	/**
 	 * An array of suggested fixes for the problem. These fixes may change the
 	 * behavior of the code, so they are not applied automatically.
 	 */
-	suggest?: SuggestedEdit[];
+	suggest?: SuggestedEdit[] | null | undefined;
 }
 
 type ViolationMessage<MessageIds = string> =
 	| { message: string }
 	| { messageId: MessageIds };
-type ViolationLocation<Node> = { loc: SourceLocation } | { node: Node };
+type ViolationLocation<Node> =
+	| { loc: SourceLocation | Position }
+	| { node: Node };
 
 export type ViolationReport<
 	Node = unknown,
@@ -507,10 +516,8 @@ interface SuggestedEditBase {
 
 	/**
 	 * The fix to be applied for the suggestion.
-	 * @param fixer The text editor to apply the fix.
-	 * @returns The fix for the suggestion.
 	 */
-	fix?(fixer: RuleTextEditor): RuleTextEdit | Iterable<RuleTextEdit> | null;
+	fix?: RuleFixer | null | undefined;
 }
 
 type SuggestionMessage = { desc: string } | { messageId: string };
diff --git a/packages/core/tests/types/types.test.ts b/packages/core/tests/types/types.test.ts
@@ -257,6 +257,7 @@ const testRule: RuleDefinition<{
 									: "👎",
 							);
 						},
+						suggest: undefined,
 					});
 				}
 			},
@@ -268,10 +269,20 @@ const testRule: RuleDefinition<{
 					suggest: [
 						{
 							messageId: "Bar",
+							fix: null,
 						},
 					],
 				});
 			},
+			Baz(node: TestNode) {
+				// node.type === "Baz"
+				context.report({
+					message: "This baz is foobar",
+					loc: { line: node.start, column: 1 },
+					fix: null,
+					suggest: null,
+				});
+			},
 		};
 	},
 };
