eslint-plugin-primer-react 6.2.0-rc.58af654 → 7.0.0-rc.0a66f81

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-primer-react",
-  "version": "6.2.0-rc.58af654",
+  "version": "7.0.0-rc.0a66f81",
   "description": "ESLint rules for Primer React",
   "main": "src/index.js",
   "scripts": {
@@ -34,7 +34,7 @@
     "eslint-traverse": "^1.0.0",
     "lodash": "^4.17.21",
     "styled-system": "^5.1.5",
-    "@typescript-eslint/utils": "7.16.0",
+    "@typescript-eslint/utils": "8.18.1",
     "typescript": "^5.5.3"
   },
   "devDependencies": {
@@ -45,7 +45,7 @@
     "eslint": "^8.42.0",
     "eslint-plugin-prettier": "^5.2.1",
     "jest": "^29.7.0",
-    "markdownlint-cli2": "^0.14.0",
+    "markdownlint-cli2": "^0.17.1",
     "markdownlint-cli2-formatter-pretty": "^0.0.7",
     "@typescript-eslint/rule-tester": "7.16.0",
     "@types/jest": "^29.5.13"

package/src/configs/recommended.js

@@ -17,7 +17,7 @@ module.exports = {
     'primer-react/a11y-explicit-heading': 'error',
     'primer-react/no-deprecated-props': 'warn',
     'primer-react/a11y-remove-disable-tooltip': 'error',
-    'primer-react/a11y-use-next-tooltip': 'error',
+    'primer-react/a11y-use-accessible-tooltip': 'error',
     'primer-react/no-unnecessary-components': 'error',
     'primer-react/prefer-action-list-item-onselect': 'error',
     'primer-react/enforce-css-module-identifier-casing': 'error',

package/src/index.js

@@ -9,7 +9,7 @@ module.exports = {
     'no-deprecated-props': require('./rules/no-deprecated-props'),
     'a11y-link-in-text-block': require('./rules/a11y-link-in-text-block'),
     'a11y-remove-disable-tooltip': require('./rules/a11y-remove-disable-tooltip'),
-    'a11y-use-next-tooltip': require('./rules/a11y-use-next-tooltip'),
+    'a11y-use-accessible-tooltip': require('./rules/a11y-use-accessible-tooltip'),
     'use-deprecated-from-deprecated': require('./rules/use-deprecated-from-deprecated'),
     'no-wildcard-imports': require('./rules/no-wildcard-imports'),
     'no-unnecessary-components': require('./rules/no-unnecessary-components'),

package/src/rules/__tests__/a11y-use-accessible-tooltip.test.js

@@ -0,0 +1,59 @@
+const rule = require('../a11y-use-accessible-tooltip')
+const {RuleTester} = require('eslint')
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+})
+
+ruleTester.run('a11y-use-accessible-tooltip', rule, {
+  valid: [`import {Tooltip} from '@primer/react';`],
+  invalid: [
+    // Single import from deprecated
+    {
+      code: `import {Tooltip} from '@primer/react/deprecated';`,
+      errors: [{messageId: 'useAccessibleTooltip'}],
+      output: `import {Tooltip} from '@primer/react';`,
+    },
+    // Multiple imports from deprecated
+    {
+      code: `import {Tooltip, Button} from '@primer/react/deprecated';`,
+      errors: [{messageId: 'useAccessibleTooltip'}],
+      output: `import {Button} from '@primer/react/deprecated';\nimport {Tooltip} from '@primer/react';`,
+    },
+    // Multiple imports from deprecated
+    {
+      code: `import {Button, Tooltip, Stack} from '@primer/react/deprecated';`,
+      errors: [{messageId: 'useAccessibleTooltip'}],
+      output: `import {Button, Stack} from '@primer/react/deprecated';\nimport {Tooltip} from '@primer/react';`,
+    },
+    // Single import from deprecated with an existing import from @primer/react
+    {
+      code: `import {Tooltip} from '@primer/react/deprecated';import {ActionList, ActionMenu} from '@primer/react';`,
+      errors: [{messageId: 'useAccessibleTooltip', line: 1}],
+      output: `import {ActionList, ActionMenu, Tooltip} from '@primer/react';`,
+    },
+    // Multiple imports from deprecated with an existing import from @primer/react
+    {
+      code: `import {Dialog, Tooltip} from '@primer/react/deprecated';import {ActionList, ActionMenu} from '@primer/react';`,
+      errors: [{messageId: 'useAccessibleTooltip', line: 1}],
+      output: `import {Dialog} from '@primer/react/deprecated';import {ActionList, ActionMenu, Tooltip} from '@primer/react';`,
+    },
+    {
+      code: `import {ActionList, ActionMenu, Tooltip, Button} from '@primer/react/deprecated';\n<Tooltip aria-label="tooltip text" noDelay={true} wrap={true} align="left"><Button>Button</Button></Tooltip>`,
+      errors: [
+        {messageId: 'useAccessibleTooltip', line: 1},
+        {messageId: 'useTextProp', line: 2},
+        {messageId: 'noDelayRemoved', line: 2},
+        {messageId: 'wrapRemoved', line: 2},
+        {messageId: 'alignRemoved', line: 2},
+      ],
+      output: `import {ActionList, ActionMenu, Button} from '@primer/react/deprecated';\nimport {Tooltip} from '@primer/react';\n<Tooltip text="tooltip text"   ><Button>Button</Button></Tooltip>`,
+    },
+  ],
+})

package/src/rules/a11y-use-accessible-tooltip.js

@@ -0,0 +1,148 @@
+'use strict'
+const url = require('../url')
+const {getJSXOpeningElementAttribute} = require('../utils/get-jsx-opening-element-attribute')
+const {getJSXOpeningElementName} = require('../utils/get-jsx-opening-element-name')
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'recommends the use of @primer/react Tooltip component',
+      category: 'Best Practices',
+      recommended: true,
+      url: url(module),
+    },
+    fixable: true,
+    schema: [],
+    messages: {
+      useAccessibleTooltip: 'Please use @primer/react Tooltip component that has accessibility improvements',
+      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.',
+    },
+  },
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value !== '@primer/react/deprecated') {
+          return
+        }
+        const hasTooltip = node.specifiers.some(
+          specifier => specifier.imported && specifier.imported.name === 'Tooltip',
+        )
+
+        if (!hasTooltip) {
+          return
+        }
+
+        const hasOtherImports = node.specifiers.length > 1
+
+        const sourceCode = context.getSourceCode()
+        // Checking to see if there is an existing root (@primer/react) import
+        // Assuming there is one root import per file
+        const rootImport = sourceCode.ast.body.find(statement => {
+          return statement.type === 'ImportDeclaration' && statement.source.value === '@primer/react'
+        })
+
+        const tooltipSpecifier = node.specifiers.find(
+          specifier => specifier.imported && specifier.imported.name === 'Tooltip',
+        )
+
+        const hasRootImport = rootImport !== undefined
+
+        context.report({
+          node,
+          messageId: 'useAccessibleTooltip',
+          fix(fixer) {
+            const fixes = []
+            if (!hasOtherImports) {
+              // If Tooltip is the only import and no existing @primer/react import, replace the whole import statement
+              if (!hasRootImport) fixes.push(fixer.replaceText(node.source, `'@primer/react'`))
+              if (hasRootImport) {
+                //  remove the entire import statement
+                fixes.push(fixer.remove(node))
+                // find the last specifier in the existing @primer/react import and insert Tooltip after that
+                const lastSpecifier = rootImport.specifiers[rootImport.specifiers.length - 1]
+                fixes.push(fixer.insertTextAfter(lastSpecifier, `, Tooltip`))
+              }
+            } else {
+              // There are other imports from the deprecated bundle but no existing @primer/react import, so remove the Tooltip import and add a new import statement with the correct path.
+              const previousToken = sourceCode.getTokenBefore(tooltipSpecifier)
+              const nextToken = sourceCode.getTokenAfter(tooltipSpecifier)
+              const hasTrailingComma = nextToken && nextToken.value === ','
+              const hasLeadingComma = previousToken && previousToken.value === ','
+
+              let rangeToRemove
+
+              if (hasTrailingComma) {
+                rangeToRemove = [tooltipSpecifier.range[0], nextToken.range[1] + 1]
+              } else if (hasLeadingComma) {
+                rangeToRemove = [previousToken.range[0], tooltipSpecifier.range[1]]
+              } else {
+                rangeToRemove = [tooltipSpecifier.range[0], tooltipSpecifier.range[1]]
+              }
+              // Remove Tooltip from the import statement
+              fixes.push(fixer.removeRange(rangeToRemove))
+
+              if (!hasRootImport) {
+                fixes.push(fixer.insertTextAfter(node, `\nimport {Tooltip} from '@primer/react';`))
+              } else {
+                // find the last specifier in the existing @primer/react import and insert Tooltip after that
+                const lastSpecifier = rootImport.specifiers[rootImport.specifiers.length - 1]
+                fixes.push(fixer.insertTextAfter(lastSpecifier, `, Tooltip`))
+              }
+            }
+            return fixes
+          },
+        })
+      },
+      JSXOpeningElement(node) {
+        const openingElName = getJSXOpeningElementName(node)
+        if (openingElName !== 'Tooltip') {
+          return
+        }
+        const ariaLabel = getJSXOpeningElementAttribute(node, 'aria-label')
+        if (ariaLabel !== undefined) {
+          context.report({
+            node,
+            messageId: 'useTextProp',
+            fix(fixer) {
+              return fixer.replaceText(ariaLabel.name, 'text')
+            },
+          })
+        }
+        const noDelay = getJSXOpeningElementAttribute(node, 'noDelay')
+        if (noDelay !== undefined) {
+          context.report({
+            node,
+            messageId: 'noDelayRemoved',
+            fix(fixer) {
+              return fixer.remove(noDelay)
+            },
+          })
+        }
+        const wrap = getJSXOpeningElementAttribute(node, 'wrap')
+        if (wrap !== undefined) {
+          context.report({
+            node,
+            messageId: 'wrapRemoved',
+            fix(fixer) {
+              return fixer.remove(wrap)
+            },
+          })
+        }
+        const align = getJSXOpeningElementAttribute(node, 'align')
+        if (align !== undefined) {
+          context.report({
+            node,
+            messageId: 'alignRemoved',
+            fix(fixer) {
+              return fixer.remove(align)
+            },
+          })
+        }
+      },
+    }
+  },
+}

package/docs/rules/a11y-use-next-tooltip.md

@@ -1,33 +0,0 @@
-# Recommends to use the `next` tooltip instead of the current stable one.
-
-## Rule details
-
-This rule recommends using the tooltip that is imported from `@primer/react/next` instead of the main entrypoint. The components that are exported from `@primer/react/next` are recommended over the main entrypoint ones because `next` components are reviewed and remediated for accessibility issues.
-👎 Examples of **incorrect** code for this rule:
-
-```tsx
-import {Tooltip} from '@primer/react'
-```
-
-👍 Examples of **correct** code for this rule:
-
-```tsx
-import {Tooltip} from '@primer/react/next'
-```
-
-## Icon buttons and tooltips
-
-Even though the below code is perfectly valid, since icon buttons now come with tooltips by default, it is not required to explicitly use the Tooltip component on icon buttons.
-
-```jsx
-import {IconButton} from '@primer/react'
-import {Tooltip} from '@primer/react/next'
-
-function ExampleComponent() {
-  return (
-    <Tooltip text="Search" direction="e">
-      <IconButton icon={SearchIcon} aria-label="Search" />
-    </Tooltip>
-  )
-}
-```

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

@@ -1,61 +0,0 @@
-const rule = require('../a11y-use-next-tooltip')
-const {RuleTester} = require('eslint')
-
-const ruleTester = new RuleTester({
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    ecmaFeatures: {
-      jsx: true,
-    },
-  },
-})
-
-ruleTester.run('a11y-use-next-tooltip', rule, {
-  valid: [
-    `import {Tooltip} from '@primer/react/next';`,
-    `import {UnderlineNav, Button} from '@primer/react';
-   import {Tooltip} from '@primer/react/next';`,
-    `import {UnderlineNav, Button} from '@primer/react';
-   import {Tooltip, SelectPanel} from '@primer/react/next';`,
-  ],
-  invalid: [
-    {
-      code: `import {Tooltip} from '@primer/react';`,
-      errors: [{messageId: 'useNextTooltip'}],
-      output: `import {Tooltip} from '@primer/react/next';`,
-    },
-    {
-      code: `import {Tooltip, Button} from '@primer/react';\n<Tooltip aria-label="tooltip text"><Button>Button</Button></Tooltip>`,
-      errors: [{messageId: 'useNextTooltip'}, {messageId: 'useTextProp'}],
-      output: `import {Button} from '@primer/react';\nimport {Tooltip} from '@primer/react/next';\n<Tooltip text="tooltip text"><Button>Button</Button></Tooltip>`,
-    },
-    {
-      code: `import {ActionList, ActionMenu, Tooltip, Button} from '@primer/react';\n<Tooltip aria-label="tooltip text"><Button>Button</Button></Tooltip>`,
-      errors: [
-        {messageId: 'useNextTooltip', line: 1},
-        {messageId: 'useTextProp', line: 2},
-      ],
-      output: `import {ActionList, ActionMenu, Button} from '@primer/react';\nimport {Tooltip} from '@primer/react/next';\n<Tooltip text="tooltip text"><Button>Button</Button></Tooltip>`,
-    },
-    {
-      code: `import {ActionList, ActionMenu, Button, Tooltip} from '@primer/react';\n<Tooltip aria-label="tooltip text"><Button aria-label="test">Button</Button></Tooltip>`,
-      errors: [
-        {messageId: 'useNextTooltip', line: 1},
-        {messageId: 'useTextProp', line: 2},
-      ],
-      output: `import {ActionList, ActionMenu, Button} from '@primer/react';\nimport {Tooltip} from '@primer/react/next';\n<Tooltip text="tooltip text"><Button aria-label="test">Button</Button></Tooltip>`,
-    },
-    {
-      code: `import {ActionList, ActionMenu, Tooltip, Button} from '@primer/react';\n<Tooltip aria-label="tooltip text" noDelay={true} wrap={true} align="left"><Button>Button</Button></Tooltip>`,
-      errors: [
-        {messageId: 'useNextTooltip', line: 1},
-        {messageId: 'useTextProp', line: 2},
-        {messageId: 'noDelayRemoved', line: 2},
-        {messageId: 'wrapRemoved', line: 2},
-        {messageId: 'alignRemoved', line: 2},
-      ],
-      output: `import {ActionList, ActionMenu, Button} from '@primer/react';\nimport {Tooltip} from '@primer/react/next';\n<Tooltip text="tooltip text"   ><Button>Button</Button></Tooltip>`,
-    },
-  ],
-})

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

@@ -1,128 +0,0 @@
-'use strict'
-const url = require('../url')
-const {getJSXOpeningElementAttribute} = require('../utils/get-jsx-opening-element-attribute')
-const {getJSXOpeningElementName} = require('../utils/get-jsx-opening-element-name')
-
-module.exports = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'recommends the use of @primer/react/next Tooltip component',
-      category: 'Best Practices',
-      recommended: true,
-      url: url(module),
-    },
-    fixable: true,
-    schema: [],
-    messages: {
-      useNextTooltip: 'Please use @primer/react/next Tooltip component that has accessibility improvements',
-      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.',
-    },
-  },
-  create(context) {
-    return {
-      ImportDeclaration(node) {
-        if (node.source.value !== '@primer/react') {
-          return
-        }
-        const hasTooltip = node.specifiers.some(
-          specifier => specifier.imported && specifier.imported.name === 'Tooltip',
-        )
-
-        const hasOtherImports = node.specifiers.length > 1
-        if (!hasTooltip) {
-          return
-        }
-        context.report({
-          node,
-          messageId: 'useNextTooltip',
-          fix(fixer) {
-            // If Tooltip is the only import, replace the whole import statement
-            if (!hasOtherImports) {
-              return fixer.replaceText(node.source, `'@primer/react/next'`)
-            } else {
-              // Otherwise, remove Tooltip from the import statement and add a new import statement with the correct path
-              const tooltipSpecifier = node.specifiers.find(
-                specifier => specifier.imported && specifier.imported.name === 'Tooltip',
-              )
-
-              const tokensToRemove = [' ', ',']
-              const tooltipIsFirstImport = tooltipSpecifier === node.specifiers[0]
-              const tooltipIsLastImport = tooltipSpecifier === node.specifiers[node.specifiers.length - 1]
-              const tooltipIsNotFirstOrLastImport = !tooltipIsFirstImport && !tooltipIsLastImport
-
-              const sourceCode = context.getSourceCode()
-              const canRemoveBefore = tooltipIsNotFirstOrLastImport
-                ? false
-                : tokensToRemove.includes(sourceCode.getTokenBefore(tooltipSpecifier).value)
-              const canRemoveAfter = tokensToRemove.includes(sourceCode.getTokenAfter(tooltipSpecifier).value)
-              const start = canRemoveBefore
-                ? sourceCode.getTokenBefore(tooltipSpecifier).range[0]
-                : tooltipSpecifier.range[0]
-              const end = canRemoveAfter
-                ? sourceCode.getTokenAfter(tooltipSpecifier).range[1] + 1
-                : tooltipSpecifier.range[1]
-              return [
-                // remove tooltip specifier and the space and comma after it
-                fixer.removeRange([start, end]),
-                fixer.insertTextAfterRange(
-                  [node.range[1], node.range[1]],
-                  `\nimport {Tooltip} from '@primer/react/next';`,
-                ),
-              ]
-            }
-          },
-        })
-      },
-      JSXOpeningElement(node) {
-        const openingElName = getJSXOpeningElementName(node)
-        if (openingElName !== 'Tooltip') {
-          return
-        }
-        const ariaLabel = getJSXOpeningElementAttribute(node, 'aria-label')
-        if (ariaLabel !== undefined) {
-          context.report({
-            node,
-            messageId: 'useTextProp',
-            fix(fixer) {
-              return fixer.replaceText(ariaLabel.name, 'text')
-            },
-          })
-        }
-        const noDelay = getJSXOpeningElementAttribute(node, 'noDelay')
-        if (noDelay !== undefined) {
-          context.report({
-            node,
-            messageId: 'noDelayRemoved',
-            fix(fixer) {
-              return fixer.remove(noDelay)
-            },
-          })
-        }
-        const wrap = getJSXOpeningElementAttribute(node, 'wrap')
-        if (wrap !== undefined) {
-          context.report({
-            node,
-            messageId: 'wrapRemoved',
-            fix(fixer) {
-              return fixer.remove(wrap)
-            },
-          })
-        }
-        const align = getJSXOpeningElementAttribute(node, 'align')
-        if (align !== undefined) {
-          context.report({
-            node,
-            messageId: 'alignRemoved',
-            fix(fixer) {
-              return fixer.remove(align)
-            },
-          })
-        }
-      },
-    }
-  },
-}