fix: require fix in suggestion objects (#298)

Author: jaymarvelz

packages/core/src/types.ts

@@ -487,7 +487,7 @@ interface ViolationReportBase {
 	/**
 	 * The data to insert into the message.
 	 */
-	data?: Record<string, string> | undefined;
+	data?: Record<string, unknown> | undefined;
 
 	/**
 	 * The fix to be applied for the violation.
@@ -521,12 +521,12 @@ interface SuggestedEditBase {
 	/**
 	 * The data to insert into the message.
 	 */
-	data?: Record<string, string> | undefined;
+	data?: Record<string, unknown> | undefined;
 
 	/**
 	 * The fix to be applied for the suggestion.
 	 */
-	fix?: RuleFixer | null | undefined;
+	fix: RuleFixer;
 }
 
 type SuggestionMessage = { desc: string } | { messageId: string };

packages/core/tests/types/types.test.ts

@@ -298,6 +298,7 @@ const testRule: RuleDefinition<{
 							start: { line: node.start, column: 1 },
 							end: { line: node.start + 1, column: Infinity },
 						},
+						data: undefined,
 						fix(fixer: RuleTextEditor): RuleTextEdit {
 							return fixer.replaceText(
 								node,
@@ -318,6 +319,12 @@ const testRule: RuleDefinition<{
 					suggest: [
 						{
 							messageId: "Bar",
+							data: {
+								foo: "foo",
+								bar: 1,
+								baz: true,
+							},
+							// @ts-expect-error -- 'fix' is required in suggestion objects
 							fix: null,
 						},
 					],
@@ -328,6 +335,11 @@ const testRule: RuleDefinition<{
 				context.report({
 					message: "This baz is foobar",
 					loc: { line: node.start, column: 1 },
+					data: {
+						foo: "foo",
+						bar: 1,
+						baz: true,
+					},
 					fix: null,
 					suggest: null,
 				});