Add a new error code for icon buttons that are wrapped with tooltip

Author: broccolinisoup

src/rules/__tests__/a11y-use-next-tooltip.test.js

@@ -25,6 +25,15 @@ ruleTester.run('a11y-use-next-tooltip', rule, {
       errors: [{messageId: 'useNextTooltip'}],
       output: `import {Tooltip} from '@primer/react/next';`,
     },
+    {
+      code: `import {Tooltip, IconButton} from '@primer/react';\n<Tooltip aria-label="some text"><IconButton aria-label="some-text" /></Tooltip>`,
+      errors: [
+        {messageId: 'useNextTooltip', line: 1},
+        {messageId: 'iconButtonsHaveDefaultTooltip', line: 2},
+        {messageId: 'useTextProp', line: 2},
+      ],
+      output: `import {IconButton} from '@primer/react';\nimport {Tooltip} from '@primer/react/next';\n<Tooltip text="some text"><IconButton aria-label="some-text" /></Tooltip>`,
+    },
     {
       code: `import {Tooltip, Button} from '@primer/react';\n<Tooltip aria-label="tooltip text"><Button>Button</Button></Tooltip>`,
       errors: [{messageId: 'useNextTooltip'}, {messageId: 'useTextProp'}],

src/rules/a11y-use-next-tooltip.js

@@ -13,11 +13,14 @@ module.exports = {
     fixable: true,
     schema: [],
     messages: {
-      useNextTooltip: 'Please use @primer/react/next Tooltip component that has accessibility improvements',
+      useNextTooltip:
+        'Please use @primer/react/next Tooltip component that has accessibility improvements. Please refer to the migration documentation for more information.',
       useTextProp: 'Please use the text prop instead of aria-label',
       noDelayRemoved: 'noDelay prop is removed. Tooltip now has no delay by default',
       wrapRemoved: 'wrap prop is removed. Tooltip now wraps by default',
       alignRemoved: 'align prop is removed. Please use the direction prop instead.',
+      iconButtonsHaveDefaultTooltip:
+        'IconButton components come with a default tooltip. You may be able to remove the wrapper Tooltip component completely. Please refer to the documentation for more information.',
     },
   },
   create(context) {
@@ -121,6 +124,24 @@ module.exports = {
           })
         }
       },
+      ExpressionStatement(node) {
+        if (!Array.isArray(node.expression.children)) {
+          return
+        }
+
+        const hasIconbutton = node.expression.children.some(
+          child => child.type === 'JSXElement' && child.openingElement.name.name === 'IconButton',
+        )
+
+        if (!hasIconbutton) {
+          return
+        }
+
+        context.report({
+          node,
+          messageId: 'iconButtonsHaveDefaultTooltip',
+        })
+      },
     }
   },
 }