|
| 1 | +'use strict' |
| 2 | +const url = require('../url') |
| 3 | +const {getJSXOpeningElementAttribute} = require('../utils/get-jsx-opening-element-attribute') |
| 4 | +const {getJSXOpeningElementName} = require('../utils/get-jsx-opening-element-name') |
| 5 | + |
| 6 | +module.exports = { |
| 7 | + meta: { |
| 8 | + type: 'suggestion', |
| 9 | + docs: { |
| 10 | + description: 'recommends the use of @primer/react Tooltip component', |
| 11 | + category: 'Best Practices', |
| 12 | + recommended: true, |
| 13 | + url: url(module), |
| 14 | + }, |
| 15 | + fixable: true, |
| 16 | + schema: [], |
| 17 | + messages: { |
| 18 | + useAccessibleTooltip: 'Please use @primer/react Tooltip component that has accessibility improvements', |
| 19 | + useTextProp: 'Please use the text prop instead of aria-label', |
| 20 | + noDelayRemoved: 'noDelay prop is removed. Tooltip now has no delay by default', |
| 21 | + wrapRemoved: 'wrap prop is removed. Tooltip now wraps by default', |
| 22 | + alignRemoved: 'align prop is removed. Please use the direction prop instead.', |
| 23 | + }, |
| 24 | + }, |
| 25 | + create(context) { |
| 26 | + return { |
| 27 | + ImportDeclaration(node) { |
| 28 | + if (node.source.value !== '@primer/react/deprecated') { |
| 29 | + return |
| 30 | + } |
| 31 | + const hasTooltip = node.specifiers.some( |
| 32 | + specifier => specifier.imported && specifier.imported.name === 'Tooltip', |
| 33 | + ) |
| 34 | + |
| 35 | + if (!hasTooltip) { |
| 36 | + return |
| 37 | + } |
| 38 | + |
| 39 | + const hasOtherImports = node.specifiers.length > 1 |
| 40 | + |
| 41 | + const sourceCode = context.getSourceCode() |
| 42 | + // Checking to see if there is an existing root (@primer/react) import |
| 43 | + const rootImport = sourceCode.ast.body.filter(statement => { |
| 44 | + return statement.type === 'ImportDeclaration' && statement.source.value === '@primer/react' |
| 45 | + }) |
| 46 | + |
| 47 | + const tooltipSpecifier = node.specifiers.find( |
| 48 | + specifier => specifier.imported && specifier.imported.name === 'Tooltip', |
| 49 | + ) |
| 50 | + |
| 51 | + const hasRootImport = rootImport.length >= 1 |
| 52 | + |
| 53 | + context.report({ |
| 54 | + node, |
| 55 | + messageId: 'useAccessibleTooltip', |
| 56 | + fix(fixer) { |
| 57 | + const fixes = [] |
| 58 | + // If Tooltip is the only import and no existing @primer/react import, replace the whole import statement |
| 59 | + if (!hasOtherImports && !hasRootImport) { |
| 60 | + fixes.push(fixer.replaceText(node.source, `'@primer/react'`)) |
| 61 | + } else if (hasOtherImports && !hasRootImport) { |
| 62 | + // 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. |
| 63 | + const previousToken = sourceCode.getTokenBefore(tooltipSpecifier) |
| 64 | + const nextToken = sourceCode.getTokenAfter(tooltipSpecifier) |
| 65 | + const hasTrailingComma = nextToken && nextToken.value === ',' |
| 66 | + const hasLeadingComma = previousToken && previousToken.value === ',' |
| 67 | + |
| 68 | + let rangeToRemove |
| 69 | + |
| 70 | + if (hasTrailingComma) { |
| 71 | + rangeToRemove = [tooltipSpecifier.range[0], nextToken.range[1] + 1] |
| 72 | + } else if (hasLeadingComma) { |
| 73 | + rangeToRemove = [previousToken.range[0], tooltipSpecifier.range[1]] |
| 74 | + } else { |
| 75 | + rangeToRemove = [tooltipSpecifier.range[0], tooltipSpecifier.range[1]] |
| 76 | + } |
| 77 | + |
| 78 | + fixes.push(fixer.removeRange(rangeToRemove)) |
| 79 | + fixes.push(fixer.insertTextAfter(node, `\nimport {Tooltip} from '@primer/react';`)) |
| 80 | + } else { |
| 81 | + if (!hasOtherImports) { |
| 82 | + // remove the entire import statement |
| 83 | + fixes.push(fixer.remove(node)) |
| 84 | + } else { |
| 85 | + const previousToken = sourceCode.getTokenBefore(tooltipSpecifier) |
| 86 | + const nextToken = sourceCode.getTokenAfter(tooltipSpecifier) |
| 87 | + const hasTrailingComma = nextToken && nextToken.value === ',' |
| 88 | + const hasLeadingComma = previousToken && previousToken.value === ',' |
| 89 | + |
| 90 | + let rangeToRemove |
| 91 | + |
| 92 | + if (hasTrailingComma) { |
| 93 | + rangeToRemove = [tooltipSpecifier.range[0], nextToken.range[1] + 1] |
| 94 | + } else if (hasLeadingComma) { |
| 95 | + rangeToRemove = [previousToken.range[0], tooltipSpecifier.range[1]] |
| 96 | + } else { |
| 97 | + rangeToRemove = [tooltipSpecifier.range[0], tooltipSpecifier.range[1]] |
| 98 | + } |
| 99 | + |
| 100 | + fixes.push(fixer.removeRange(rangeToRemove)) |
| 101 | + } |
| 102 | + // find the last specifier in the existing @primer/react import and insert Tooltip after that |
| 103 | + // const rootImport = sourceCode.ast.body.find(statement => { |
| 104 | + // return statement.type === 'ImportDeclaration' && statement.source.value === '@primer/react' |
| 105 | + // }) |
| 106 | + const lastSpecifier = rootImport.specifiers[rootImport.specifiers.length - 1] |
| 107 | + fixes.push(fixer.insertTextAfter(lastSpecifier, `, Tooltip`)) |
| 108 | + } |
| 109 | + |
| 110 | + return fixes |
| 111 | + }, |
| 112 | + }) |
| 113 | + }, |
| 114 | + JSXOpeningElement(node) { |
| 115 | + const openingElName = getJSXOpeningElementName(node) |
| 116 | + if (openingElName !== 'Tooltip') { |
| 117 | + return |
| 118 | + } |
| 119 | + const ariaLabel = getJSXOpeningElementAttribute(node, 'aria-label') |
| 120 | + if (ariaLabel !== undefined) { |
| 121 | + context.report({ |
| 122 | + node, |
| 123 | + messageId: 'useTextProp', |
| 124 | + fix(fixer) { |
| 125 | + return fixer.replaceText(ariaLabel.name, 'text') |
| 126 | + }, |
| 127 | + }) |
| 128 | + } |
| 129 | + const noDelay = getJSXOpeningElementAttribute(node, 'noDelay') |
| 130 | + if (noDelay !== undefined) { |
| 131 | + context.report({ |
| 132 | + node, |
| 133 | + messageId: 'noDelayRemoved', |
| 134 | + fix(fixer) { |
| 135 | + return fixer.remove(noDelay) |
| 136 | + }, |
| 137 | + }) |
| 138 | + } |
| 139 | + const wrap = getJSXOpeningElementAttribute(node, 'wrap') |
| 140 | + if (wrap !== undefined) { |
| 141 | + context.report({ |
| 142 | + node, |
| 143 | + messageId: 'wrapRemoved', |
| 144 | + fix(fixer) { |
| 145 | + return fixer.remove(wrap) |
| 146 | + }, |
| 147 | + }) |
| 148 | + } |
| 149 | + const align = getJSXOpeningElementAttribute(node, 'align') |
| 150 | + if (align !== undefined) { |
| 151 | + context.report({ |
| 152 | + node, |
| 153 | + messageId: 'alignRemoved', |
| 154 | + fix(fixer) { |
| 155 | + return fixer.remove(align) |
| 156 | + }, |
| 157 | + }) |
| 158 | + } |
| 159 | + }, |
| 160 | + } |
| 161 | + }, |
| 162 | +} |
0 commit comments