refactor: minor improvements

Rel1cx · Rel1cx · commit d96e562f661c · 2024-12-07T08:36:10.000+08:00
diff --git a/packages/core/docs/README.md b/packages/core/docs/README.md
@@ -41,6 +41,7 @@
 ## Functions
 
 - [getComponentNameFromIdentifier](functions/getComponentNameFromIdentifier.md)
+- [getElementType](functions/getElementType.md)
 - [getFunctionComponentIdentifier](functions/getFunctionComponentIdentifier.md)
 - [hasNoneOrValidComponentName](functions/hasNoneOrValidComponentName.md)
 - [isCallFromReact](functions/isCallFromReact.md)
diff --git a/packages/core/docs/functions/getElementType.md b/packages/core/docs/functions/getElementType.md
@@ -0,0 +1,23 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / getElementType
+
+# Function: getElementType()
+
+> **getElementType**(`node`, `context`): `string`
+
+## Parameters
+
+### node
+
+`JSXOpeningElement`
+
+### context
+
+`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
+
+## Returns
+
+`string`
diff --git a/packages/core/src/element/get-element-type.ts b/packages/core/src/element/get-element-type.ts
@@ -0,0 +1,20 @@
+import * as JSX from "@eslint-react/jsx";
+import { decodeSettings, normalizeSettings } from "@eslint-react/shared";
+import { F, isString, O } from "@eslint-react/tools";
+import type { RuleContext } from "@eslint-react/types";
+import type { TSESTree } from "@typescript-eslint/types";
+
+export function getElementType(node: TSESTree.JSXOpeningElement, context: RuleContext) {
+  const elementName = JSX.getElementName(node);
+  if (elementName === elementName.toLowerCase()) return elementName;
+  const { components, polymorphicPropName } = normalizeSettings(decodeSettings(context.settings));
+  const asElementName = components.get(elementName);
+  if (isString(asElementName)) return asElementName;
+  return F.pipe(
+    O.fromNullable(polymorphicPropName),
+    O.flatMap(JSX.findPropInAttributes(node.attributes, context.sourceCode.getScope(node))),
+    O.flatMap(attr => JSX.getPropValue(attr, context.sourceCode.getScope(attr))),
+    O.filter(isString),
+    O.getOrElse(() => elementName),
+  );
+}
diff --git a/packages/core/src/element/index.ts b/packages/core/src/element/index.ts
@@ -1,2 +1,3 @@
+export * from "./get-element-type";
 export * from "./hierarchy";
 export * from "./misc";
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-children-in-void-dom-elements.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-children-in-void-dom-elements.ts
@@ -1,7 +1,6 @@
+import { getElementType } from "@eslint-react/core";
 import * as JSX from "@eslint-react/jsx";
-import { decodeSettings, normalizeSettings } from "@eslint-react/shared";
 import { O } from "@eslint-react/tools";
-import type { TSESTree } from "@typescript-eslint/utils";
 import type { CamelCase } from "string-ts";
 
 import { createRule } from "../utils";
@@ -43,12 +42,9 @@ export default createRule<[], MessageID>({
   },
   name: RULE_NAME,
   create(context) {
-    const { components, polymorphicPropName } = normalizeSettings(decodeSettings(context.settings));
     return {
       JSXElement(node) {
-        const openingElementNameExpression = node.openingElement;
-        const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
-        const elementType = JSX.getElementType(jsxCtx, components, polymorphicPropName)(openingElementNameExpression);
+        const elementType = getElementType(node.openingElement, context);
         if (!elementType || !voidElements.has(elementType)) return;
         if (node.children.length > 0) {
           context.report({
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-missing-button-type.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-missing-button-type.ts
@@ -1,7 +1,6 @@
+import { getElementType } from "@eslint-react/core";
 import * as JSX from "@eslint-react/jsx";
-import { decodeSettings, normalizeSettings } from "@eslint-react/shared";
 import { O } from "@eslint-react/tools";
-import type { TSESTree } from "@typescript-eslint/utils";
 import type { CamelCase } from "string-ts";
 
 import { createRule } from "../utils";
@@ -24,11 +23,9 @@ export default createRule<[], MessageID>({
   },
   name: RULE_NAME,
   create(context) {
-    const { components, polymorphicPropName } = normalizeSettings(decodeSettings(context.settings));
     return {
       JSXElement(node) {
-        const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
-        const elementType = JSX.getElementType(jsxCtx, components, polymorphicPropName)(node.openingElement);
+        const elementType = getElementType(node.openingElement, context);
         if (elementType !== "button") return;
         const { attributes } = node.openingElement;
         const initialScope = context.sourceCode.getScope(node);
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-missing-iframe-sandbox.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-missing-iframe-sandbox.ts
@@ -5,6 +5,7 @@ import type { TSESTree } from "@typescript-eslint/utils";
 import type { CamelCase } from "string-ts";
 
 import { createRule } from "../utils";
+import { getElementType } from "@eslint-react/core";
 
 export const RULE_NAME = "no-missing-iframe-sandbox";
 
@@ -43,11 +44,9 @@ export default createRule<[], MessageID>({
   },
   name: RULE_NAME,
   create(context) {
-    const { components, polymorphicPropName } = normalizeSettings(decodeSettings(context.settings));
     return {
       JSXElement(node) {
-        const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
-        const elementType = JSX.getElementType(jsxCtx, components, polymorphicPropName)(node.openingElement);
+        const elementType = getElementType(node.openingElement, context);
         if (elementType !== "iframe") return;
         const { attributes } = node.openingElement;
         const initialScope = context.sourceCode.getScope(node);
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-unsafe-iframe-sandbox.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-unsafe-iframe-sandbox.ts
@@ -6,6 +6,7 @@ import type { CamelCase } from "string-ts";
 import { match, P } from "ts-pattern";
 
 import { createRule } from "../utils";
+import { getElementType } from "@eslint-react/core";
 
 export const RULE_NAME = "no-unsafe-iframe-sandbox";
 
@@ -30,11 +31,9 @@ export default createRule<[], MessageID>({
   },
   name: RULE_NAME,
   create(context) {
-    const { components, polymorphicPropName } = normalizeSettings(decodeSettings(context.settings));
     return {
       JSXElement(node) {
-        const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
-        const elementType = JSX.getElementType(jsxCtx, components, polymorphicPropName)(node.openingElement);
+        const elementType = getElementType(node.openingElement, context);
         if (elementType !== "iframe") return;
         const { attributes } = node.openingElement;
         const initialScope = context.sourceCode.getScope(node);
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-unsafe-target-blank.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-unsafe-target-blank.ts
@@ -1,3 +1,4 @@
+import { getElementType } from "@eslint-react/core";
 import * as JSX from "@eslint-react/jsx";
 import { decodeSettings, normalizeSettings } from "@eslint-react/shared";
 import { F, isString, O } from "@eslint-react/tools";
@@ -38,13 +39,10 @@ export default createRule<[], MessageID>({
   name: RULE_NAME,
   create(context) {
     const settings = normalizeSettings(decodeSettings(context.settings));
-    const polymorphicPropName = settings.polymorphicPropName;
-    const components = settings.components;
     const additionalComponents = settings.additionalComponents.filter(c => c.as === "a");
     function getReportDescriptor(node: TSESTree.JSXElement): O.Option<ReportDescriptor<MessageID>> {
       const name = JSX.getElementName(node.openingElement);
-      const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) };
-      const elementType = JSX.getElementType(jsxCtx, components, polymorphicPropName)(node.openingElement);
+      const elementType = getElementType(node.openingElement, context);
       if (elementType !== "a" && !additionalComponents.some(c => c.re.test(name))) return O.none();
       const { attributes } = node.openingElement;
       const initialScope = context.sourceCode.getScope(node);
@@ -61,7 +59,7 @@ export default createRule<[], MessageID>({
         ? O.fromNullable(targetPropDefaultValue)
         : F.pipe(
           targetProp,
-          O.flatMap(attr => JSX.getPropValue(attr, jsxCtx.getScope(attr))),
+          O.flatMap(attr => JSX.getPropValue(attr, context.sourceCode.getScope(attr))),
           O.flatMapNullable(v =>
             match(v)
               .with(P.string, F.identity)
@@ -80,7 +78,7 @@ export default createRule<[], MessageID>({
         ? O.fromNullable(hrefPropDefaultValue)
         : F.pipe(
           hrefProp,
-          O.flatMap(attr => JSX.getPropValue(attr, jsxCtx.getScope(attr))),
+          O.flatMap(attr => JSX.getPropValue(attr, context.sourceCode.getScope(attr))),
           O.flatMapNullable(v =>
             match(v)
               .with(P.string, F.identity)
@@ -99,7 +97,7 @@ export default createRule<[], MessageID>({
         ? O.fromNullable(relPropDefaultValue)
         : F.pipe(
           relProp,
-          O.flatMap(attr => JSX.getPropValue(attr, jsxCtx.getScope(attr))),
+          O.flatMap(attr => JSX.getPropValue(attr, context.sourceCode.getScope(attr))),
           O.flatMapNullable(v =>
             match(v)
               .with(P.string, F.identity)
diff --git a/packages/utilities/jsx/src/get-element-type.ts b/packages/utilities/jsx/src/get-element-type.ts
diff --git a/packages/utilities/jsx/src/index.ts b/packages/utilities/jsx/src/index.ts
@@ -1,5 +1,4 @@
 export * from "./get-element-name";
-export * from "./get-element-type";
 export * from "./get-prop";
 export * from "./has-prop";
 export * from "./is-element";

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+export * from "./get-element-type";`
`1`	`2`	`export * from "./hierarchy";`
`2`	`3`	`export * from "./misc";`