Eslint plugin: prefer-box-no-classname rule w/ autofix + merged into prefer-box-lonely-ref

docs/src/Eslint Plugin.doc.js

@@ -32,23 +32,24 @@ card(
       `}
     />
     <MainSection.Subsection
-      title="gestalt/prefer-box"
+      title="gestalt/prefer-box-inline-style"
       description={`
         Prevent using \`<div>\` inline styling for attributes that are already implemented in Box.
 
         [Learn more about Box](/Box).
       `}
     />
     <MainSection.Subsection
-      title="gestalt/prefer-box-lonely-ref"
-      description={`
-        Prevent \`<div>\` tags used to only contain a \`ref\` attribute.
+      title="gestalt/prefer-box-no-disallowed"
+      description={`Prevent \`<div>\` tags that don't contain disallowed attributes: className and onClick. Use Gestalt Box, instead. Other attributes are disallowed as well so this Eslint rule doesn't conflict with [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y).
 
-        Instead, use \`ref\` props supported in Box or other elements such as Button or TextField.
+[Read more about Box](/Box).
 
-        With AUTOFIX!
+It also prevents \`<div>\` tags used to only contain a \`ref\` attribute. \`ref\` is supported in Box and other elements such as Button or TextField.
+
+[Read more about the ref prop in Box](/Box#Using-as-a-ref).
 
-        [Read more about the ref prop in Box](/Box#Using-as-a-ref).
+With AUTOFIX!
       `}
     />
     <MainSection.Subsection

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-lonely-ref/invalid/gestalt-import-with-renamed-box-input.js → packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-lonely-ref/gestalt-import-with-renamed-box-input.js

@@ -3,10 +3,10 @@ import { Box as RenamedBox } from 'gestalt';
 export default function TestElement() {
   const ref = useRef(null);
   return (
-    <Box>
+    <RenamedBox>
       <div ref={ref}>
-        <Box />
+        <RenamedBox />
       </div>
-    </Box>
+    </RenamedBox>
   );
 }

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-lonely-ref/invalid/gestalt-import-with-renamed-box-output.js → packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-lonely-ref/gestalt-import-with-renamed-box-output.js

@@ -3,10 +3,10 @@ import { Box as RenamedBox } from 'gestalt';
 export default function TestElement() {
   const ref = useRef(null);
   return (
-    <Box>
-      <Box ref={ref}>
-        <Box />
-      </Box>
-    </Box>
+    <RenamedBox>
+      <RenamedBox ref={ref}>
+        <RenamedBox />
+      </RenamedBox>
+    </RenamedBox>
   );
 }

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-lonely-ref/invalid/no-gestalt-import-input.js → packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-lonely-ref/no-gestalt-import-input.js

@@ -3,7 +3,7 @@ export default function TestElement() {
   const ref = useRef(null);
   return (
     <div ref={ref}>
-      <div />
+      <button />
     </div>
   );
 }

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-lonely-ref/invalid/no-gestalt-import-output.js → packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-lonely-ref/no-gestalt-import-output.js

@@ -4,7 +4,7 @@ export default function TestElement() {
   const ref = useRef(null);
   return (
     <Box ref={ref}>
-      <div />
+      <button />
     </Box>
   );
 }

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-box-inline-style-input.js

@@ -0,0 +1,10 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  return (
+    <Box>
+      <div onBlur={() => {}} style={{ marginTop: 200 }}>
+        <Box />
+      </div>
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-box-inline-style-output.js

@@ -0,0 +1,10 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  return (
+    <Box>
+      <Box onBlur={() => {}} dangerouslySetInlineStyle={{ __style: { marginTop: 200 } }}>
+        <Box />
+      </Box>
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-lonely-ref/valid.js → packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-box-input.js

@@ -2,8 +2,9 @@ import { Box } from 'gestalt';
 export default function TestElement() {
   return (
     <Box>
-      <Box ref={undefined} />
-      <div ref={undefined} className={undefined} />
+      <div onBlur={() => {}}>
+        <Box />
+      </div>
     </Box>
   );
 }

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-box-output.js

@@ -0,0 +1,10 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  return (
+    <Box>
+      <Box onBlur={() => {}}>
+        <Box />
+      </Box>
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-renamed-box-input.js

@@ -0,0 +1,10 @@
+import { Box as RenamedBox } from 'gestalt';
+export default function TestElement() {
+  return (
+    <RenamedBox>
+      <div onBlur={() => {}}>
+        <RenamedBox />
+      </div>
+    </RenamedBox>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-with-renamed-box-output.js

@@ -0,0 +1,10 @@
+import { Box as RenamedBox } from 'gestalt';
+export default function TestElement() {
+  return (
+    <RenamedBox>
+      <RenamedBox onBlur={() => {}}>
+        <RenamedBox />
+      </RenamedBox>
+    </RenamedBox>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-without-box-input.js

@@ -0,0 +1,8 @@
+import { Text, Flex } from 'gestalt';
+export default function TestElement() {
+  return (
+    <div onBlur={() => {}}>
+      <Text>Test</Text>
+    </div>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/gestalt-import-without-box-output.js

@@ -0,0 +1,8 @@
+import { Box, Flex, Text } from 'gestalt';
+export default function TestElement() {
+  return (
+    <Box onBlur={() => {}}>
+      <Text>Test</Text>
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/no-gestalt-import-input.js

@@ -0,0 +1,7 @@
+export default function TestElement() {
+  return (
+    <div onBlur={() => {}}>
+      <button />
+    </div>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/no-gestalt-import-output.js

@@ -0,0 +1,8 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  return (
+    <Box onBlur={() => {}}>
+      <button />
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/no-gestalt-import-selfclosed-input.js

@@ -0,0 +1,3 @@
+export default function TestElement() {
+  return <div onBlur={() => {}} />;
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/invalid-no-disallowed/no-gestalt-import-selfclosed-output.js

@@ -0,0 +1,4 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  return <Box onBlur={() => {}} />;
+}

packages/eslint-plugin-gestalt/src/__fixtures__/prefer-box-no-disallowed/valid/valid.js

@@ -0,0 +1,17 @@
+import { Box } from 'gestalt';
+export default function TestElement() {
+  const props = { onBlur: () => {} };
+  return (
+    <Box>
+      <Box ref={undefined} />
+      <div ref={undefined} className={undefined} />
+      <div ref={undefined} onClick={() => {}} />
+      <div ref={undefined} tabIndex={-1} />
+      <div ref={undefined} role="button" />
+      <div ref={undefined} onMouseOver={() => {}} />
+      <div ref={undefined} accessKey="test" />
+      <div ref={undefined} autoFocus />
+      <div ref={undefined} {...props} />
+    </Box>
+  );
+}

packages/eslint-plugin-gestalt/src/eslintASTFixers.js

@@ -1,5 +1,9 @@
 // @flow strict
-import { getNamedImportsComponents, getTextNodeFromSourceCode } from './eslintASTHelpers.js';
+import {
+  getLocalComponentImportName,
+  getNamedImportsComponents,
+  getTextNodeFromSourceCode,
+} from './eslintASTHelpers.js';
 
 // $FlowFixMe[unclear-type]
 type GenericNode = {| [string]: any |};
@@ -56,7 +60,9 @@ type RenameTagFixerType = ({|
   context: GenericNode,
   elementNode: GenericNode,
   fixer: GenericNode,
+  gestaltImportNode: GenericNode,
   newComponentName: string,
+  replaceRegexCallback?: ({| input: string |}) => string,
   tagName: string,
 |}) => $ReadOnlyArray<GenericNode>;
 
@@ -70,42 +76,55 @@ export const renameTagFixer: RenameTagFixerType = ({
   context,
   elementNode,
   fixer,
+  gestaltImportNode,
   newComponentName,
+  replaceRegexCallback = ({ input }) => input,
   tagName,
 }) => {
   return [elementNode.openingElement, elementNode.closingElement]
     .map((node) => {
       // $FlowFixMe[incompatible-type] Flow is not detecting the method filter(Boolean)
       if (!node) return false;
+      const namedImportsComponents =
+        getNamedImportsComponents({
+          importNode: gestaltImportNode,
+        }) ?? [];
 
-      return fixer.replaceText(
-        node,
-        getTextNodeFromSourceCode({ context, elementNode: node }).replace(
+      const componentNameMatch = namedImportsComponents.find(
+        (item) => item[0] === newComponentName,
+      );
+
+      const replacedText = replaceRegexCallback({
+        input: getTextNodeFromSourceCode({ context, elementNode: node }).replace(
           tagName,
-          newComponentName,
+          (componentNameMatch && componentNameMatch[1]) ?? newComponentName,
         ),
-      );
+      });
+      return fixer.replaceText(node, replacedText);
     })
     .filter(Boolean);
 };
 
 type RenameTagWithPropsFixerType = ({|
-  additionalPropsString: string,
+  fixedPropsString: string,
   context: GenericNode,
   elementNode: GenericNode,
   fixer: GenericNode,
+  gestaltImportNode: GenericNode,
   newComponentName: string,
   tagName: string,
+  propsToRemove?: $ReadOnlyArray<string>,
 |}) => $ReadOnlyArray<GenericNode>;
 
 /** This function is a more complex version of renameTagFixer. It has the same tag replacement functionality, but it also rebuild the props in the opening tag to include a new prop. The new prop must be formatted as a string, p.e. `as="article"`
 Examples 1:
 "\<div\>\<\/div\>" if tagName="div", newComponentName="Box", and completePropsString=`as="article"` returns "\<Box as="article"\>\<\/Box\>"
 */
 export const renameTagWithPropsFixer: RenameTagWithPropsFixerType = ({
-  additionalPropsString,
+  fixedPropsString,
   context,
   elementNode,
+  gestaltImportNode,
   fixer,
   newComponentName,
   tagName,
@@ -115,16 +134,22 @@ export const renameTagWithPropsFixer: RenameTagWithPropsFixerType = ({
       // $FlowFixMe[incompatible-type] Flow is not detecting the method filter(Boolean)
       if (!node) return false;
 
-      const completeOpeningNode = `<${newComponentName} ${additionalPropsString}${
+      const finalNewComponentName = getLocalComponentImportName({
+        importNode: gestaltImportNode,
+        componentName: newComponentName,
+      });
+
+      const completeOpeningNode = `<${finalNewComponentName} ${fixedPropsString}${
         elementNode.closingElement ? '' : ' /'
       }>`;
+
       return index === 0
         ? fixer.replaceText(node, completeOpeningNode)
         : fixer.replaceText(
             node,
             getTextNodeFromSourceCode({ context, elementNode: node }).replace(
               tagName,
-              newComponentName,
+              finalNewComponentName,
             ),
           );
     })