refactor(kit): refactor report function into namespace based API

Author: Rel1cx

packages/plugins/eslint-plugin-react-debug/src/rules/jsx.ts

@@ -2,7 +2,7 @@ import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
 import type { CamelCase } from "string-ts";
 import { flow } from "@eslint-react/eff";
 import * as JSX from "@eslint-react/jsx";
-import { createReport, JsxConfig, type RuleContext, type RuleFeature } from "@eslint-react/kit";
+import { JsxConfig, Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
 import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
 import { match, P } from "ts-pattern";
 import { JsxEmit } from "typescript";
@@ -70,6 +70,6 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
   }
 
   return {
-    "JSXElement, JSXFragment": flow(getReportDescriptor, createReport(context)),
+    "JSXElement, JSXFragment": flow(getReportDescriptor, Report.make(context).send),
   };
 }

packages/plugins/eslint-plugin-react-dom/src/rules/no-unknown-property.ts

@@ -5,7 +5,7 @@
 import { getSettingsFromContext } from "@eslint-react/shared";
 import { createRule } from "../utils";
 import { compare } from "compare-versions";
-import { createReport } from "@eslint-react/kit";
+import { Report } from "@eslint-react/kit";
 import type { RuleContext, RuleFeature } from "@eslint-react/kit";
 import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
 
@@ -1090,7 +1090,7 @@ export default createRule({
 });
 
 export function create(context: RuleContext<MessageID, unknown[]>): RuleListener {
-  const report = createReport(context);
+  const report = Report.make(context);
   function getIgnoreConfig() {
     return context.options[0]?.ignore || DEFAULTS.ignore;
   }
@@ -1117,7 +1117,7 @@ export function create(context: RuleContext<MessageID, unknown[]>): RuleListener
 
       if (isValidDataAttribute(name)) {
         if (getRequireDataLowercase() && hasUpperCaseCharacter(name)) {
-          report({
+          report.send({
             node,
             messageId: "dataLowercaseRequired",
             data: {
@@ -1147,7 +1147,7 @@ export function create(context: RuleContext<MessageID, unknown[]>): RuleListener
       if (tagName && allowedTags) {
         // Scenario 1A: Allowed attribute found where not supposed to, report it
         if (allowedTags.indexOf(tagName) === -1) {
-          report({
+          report.send({
             node,
             messageId: "invalidPropOnTag",
             data: {
@@ -1174,7 +1174,7 @@ export function create(context: RuleContext<MessageID, unknown[]>): RuleListener
 
       if (hasStandardNameButIsNotUsed) {
         // Scenario 2B: The name of the attribute is close to a standard one, report it with the standard name
-        report({
+        report.send({
           node,
           messageId: "unknownPropWithStandardName",
           data: {
@@ -1189,7 +1189,7 @@ export function create(context: RuleContext<MessageID, unknown[]>): RuleListener
       }
 
       // Scenario 3: We have an attribute that is unknown, report it
-      report({
+      report.send({
         node,
         messageId: "unknownProp",
         data: {

packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.ts

@@ -4,7 +4,7 @@ import type { CamelCase } from "string-ts";
 import * as AST from "@eslint-react/ast";
 import * as ER from "@eslint-react/core";
 import { _ } from "@eslint-react/eff";
-import { createReport, type RuleContext, type RuleFeature } from "@eslint-react/kit";
+import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
 import { unsafeDecodeSettings } from "@eslint-react/shared";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import { isMatching } from "ts-pattern";
@@ -109,7 +109,7 @@ export default createRule<[], MessageID>({
 });
 
 export function create(context: RuleContext<MessageID, []>): RuleListener {
-  const report = createReport(context);
+  const report = Report.make(context);
   const indexParamNames: Array<string | _> = [];
 
   function isArrayIndex(node: TSESTree.Node): node is TSESTree.Identifier {
@@ -200,7 +200,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
           continue;
         }
         for (const descriptor of getReportDescriptors(prop.value)) {
-          report(descriptor);
+          report.send(descriptor);
         }
       }
     },
@@ -218,7 +218,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
         return;
       }
       for (const descriptor of getReportDescriptors(node.value.expression)) {
-        report(descriptor);
+        report.send(descriptor);
       }
     },
   };

packages/plugins/eslint-plugin-react-x/src/rules/no-leaked-conditional-rendering.ts

@@ -3,7 +3,7 @@ import type { ReportDescriptor, RuleListener } from "@typescript-eslint/utils/ts
 import type { CamelCase } from "string-ts";
 import * as AST from "@eslint-react/ast";
 import { _, flow } from "@eslint-react/eff";
-import { createReport, type RuleContext, type RuleFeature } from "@eslint-react/kit";
+import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
 import { getSettingsFromContext } from "@eslint-react/shared";
 import * as VAR from "@eslint-react/var";
 import { getConstrainedTypeAtLocation } from "@typescript-eslint/type-utils";
@@ -260,7 +260,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
       })
       .otherwise(() => _);
   }
-  const visitorFunction = flow(getReportDescriptor, createReport(context));
+  const visitorFunction = flow(getReportDescriptor, Report.make(context).send);
   return {
     "JSXExpressionContainer > ConditionalExpression": visitorFunction,
     "JSXExpressionContainer > LogicalExpression": visitorFunction,

packages/plugins/eslint-plugin-react-x/src/rules/no-missing-key.ts

@@ -3,7 +3,7 @@ import type { ReportDescriptor, RuleListener } from "@typescript-eslint/utils/ts
 import * as AST from "@eslint-react/ast";
 import * as ER from "@eslint-react/core";
 import * as JSX from "@eslint-react/jsx";
-import { createReport, type RuleContext, type RuleFeature } from "@eslint-react/kit";
+import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
 
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 import { match } from "ts-pattern";
@@ -36,7 +36,7 @@ export default createRule<[], MessageID>({
 });
 
 export function create(context: RuleContext<MessageID, []>): RuleListener {
-  const report = createReport(context);
+  const report = Report.make(context);
   const state = { isWithinChildrenToArray: false };
 
   function checkIteratorElement(node: TSESTree.Node): null | ReportDescriptor<MessageID> {
@@ -104,7 +104,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
       const initialScope = context.sourceCode.getScope(node);
       for (const element of elements) {
         if (!JSX.hasAttribute("key", element.openingElement.attributes, initialScope)) {
-          report({
+          report.send({
             messageId: "missingKey",
             node: element,
           });
@@ -121,10 +121,10 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
       if (!AST.isFunction(callback)) return;
       const body = callback.body;
       if (body.type === T.BlockStatement) {
-        checkBlockStatement(body).forEach(report);
+        checkBlockStatement(body).forEach(report.send);
         return;
       }
-      report(checkExpression(body));
+      report.send(checkExpression(body));
     },
     "CallExpression:exit"(node) {
       if (!ER.isChildrenToArrayCall(context, node)) {
@@ -137,7 +137,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
         return;
       }
       if (node.parent.type === T.ArrayExpression) {
-        report({
+        report.send({
           messageId: "unexpectedFragmentSyntax",
           node,
         });

packages/utilities/kit/docs/@eslint-react/namespaces/Report/README.md

@@ -0,0 +1,11 @@
+[**@eslint-react/kit**](../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../README.md) / Report
+
+# Report
+
+## Functions
+
+- [make](functions/make.md)

packages/utilities/kit/docs/@eslint-react/namespaces/Report/functions/make.md

@@ -0,0 +1,63 @@
+[**@eslint-react/kit**](../../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../../README.md) / [Report](../README.md) / make
+
+# Function: make()
+
+> **make**\<`TMessageID`\>(`context`): `object`
+
+## Type Parameters
+
+### TMessageID
+
+`TMessageID` *extends* `string`
+
+## Parameters
+
+### context
+
+[`RuleContext`](../../../../type-aliases/RuleContext.md)\<`TMessageID`\>
+
+## Returns
+
+`object`
+
+### send()
+
+> `readonly` **send**(`descriptor`): `void`
+
+#### Parameters
+
+##### descriptor
+
+`undefined` | `null` | `ReportDescriptor`\<`TMessageID`\>
+
+#### Returns
+
+`void`
+
+### sendOrElse()
+
+> `readonly` **sendOrElse**\<`TElse`\>(`descriptor`, `fallback`): `void` \| `TElse`
+
+#### Type Parameters
+
+##### TElse
+
+`TElse`
+
+#### Parameters
+
+##### descriptor
+
+`undefined` | `null` | `ReportDescriptor`\<`TMessageID`\>
+
+##### fallback
+
+() => `TElse`
+
+#### Returns
+
+`void` \| `TElse`

packages/utilities/kit/docs/README.md

@@ -9,6 +9,7 @@
 - [JsxConfig](@eslint-react/namespaces/JsxConfig/README.md)
 - [LanguagePreference](@eslint-react/namespaces/LanguagePreference/README.md)
 - [RE](@eslint-react/namespaces/RE/README.md)
+- [Report](@eslint-react/namespaces/Report/README.md)
 - [SEL](@eslint-react/namespaces/SEL/README.md)
 
 ## Type Aliases
@@ -17,7 +18,3 @@
 - [RuleFeature](type-aliases/RuleFeature.md)
 - [RulePreset](type-aliases/RulePreset.md)
 - [RuleSeverity](type-aliases/RuleSeverity.md)
-
-## Functions
-
-- [createReport](functions/createReport.md)

packages/utilities/kit/docs/functions/createReport.md

@@ -0,0 +1,16 @@
+import type { ReportDescriptor } from "@typescript-eslint/utils/ts-eslint";
+import type { RuleContext } from "./types";
+import { type _ } from "@eslint-react/eff";
+
+export function make<TMessageID extends string>(context: RuleContext<TMessageID>) {
+  return {
+    send(descriptor: _ | null | ReportDescriptor<TMessageID>) {
+      if (descriptor == null) return;
+      return context.report(descriptor);
+    },
+    sendOrElse<TElse>(descriptor: _ | null | ReportDescriptor<TMessageID>, fallback: () => TElse) {
+      if (descriptor == null) return fallback();
+      return context.report(descriptor);
+    },
+  } as const;
+}