|
| 1 | +'use strict'; |
| 2 | +const getDocumentationUrl = require('./utils/get-documentation-url'); |
| 3 | + |
| 4 | +const getArgumentNameForReplaceChildOrInsertBefore = nodeArguments => { |
| 5 | + if (nodeArguments.type === 'Identifier') { |
| 6 | + return nodeArguments.name; |
| 7 | + } |
| 8 | +}; |
| 9 | + |
| 10 | +const forbiddenIdentifierNames = new Map([ |
| 11 | + ['replaceChild', 'replaceWith'], |
| 12 | + ['insertBefore', 'before'] |
| 13 | +]); |
| 14 | + |
| 15 | +const isPartOfVariableAssignment = nodeParentType => { |
| 16 | + if (nodeParentType === 'VariableDeclarator' || nodeParentType === 'AssignmentExpression') { |
| 17 | + return true; |
| 18 | + } |
| 19 | + |
| 20 | + return false; |
| 21 | +}; |
| 22 | + |
| 23 | +const checkForReplaceChildOrInsertBefore = (context, node) => { |
| 24 | + const identifierName = node.callee.property.name; |
| 25 | + |
| 26 | + // Return early when specified methods don't exist in forbiddenIdentifierNames |
| 27 | + if (!forbiddenIdentifierNames.has(identifierName)) { |
| 28 | + return; |
| 29 | + } |
| 30 | + |
| 31 | + const nodeArguments = node.arguments; |
| 32 | + const newChildNodeArgument = getArgumentNameForReplaceChildOrInsertBefore( |
| 33 | + nodeArguments[0] |
| 34 | + ); |
| 35 | + const oldChildNodeArgument = getArgumentNameForReplaceChildOrInsertBefore( |
| 36 | + nodeArguments[1] |
| 37 | + ); |
| 38 | + |
| 39 | + // Return early in case that one of the provided arguments is not a node |
| 40 | + if (!newChildNodeArgument || !oldChildNodeArgument) { |
| 41 | + return; |
| 42 | + } |
| 43 | + |
| 44 | + const parentNode = node.callee.object.name; |
| 45 | + // This check makes sure that only the first method of chained methods with same identifier name e.g: parentNode.insertBefore(alfa, beta).insertBefore(charlie, delta); gets transformed |
| 46 | + if (!parentNode) { |
| 47 | + return; |
| 48 | + } |
| 49 | + |
| 50 | + const preferredSelector = forbiddenIdentifierNames.get(identifierName); |
| 51 | + |
| 52 | + let fix = fixer => fixer.replaceText( |
| 53 | + node, |
| 54 | + `${oldChildNodeArgument}.${preferredSelector}(${newChildNodeArgument})` |
| 55 | + ); |
| 56 | + |
| 57 | + // Report error when the method is part of a variable assignment |
| 58 | + // but don't offer to autofix `.replaceWith()` and `.before()` |
| 59 | + // which don't have a return value. |
| 60 | + if (isPartOfVariableAssignment(node.parent.type)) { |
| 61 | + fix = undefined; |
| 62 | + } |
| 63 | + |
| 64 | + return context.report({ |
| 65 | + node, |
| 66 | + message: `Prefer \`${oldChildNodeArgument}.${preferredSelector}(${newChildNodeArgument})\` over \`${parentNode}.${identifierName}(${newChildNodeArgument}, ${oldChildNodeArgument})\`.`, |
| 67 | + fix |
| 68 | + }); |
| 69 | +}; |
| 70 | + |
| 71 | +// Handle both `Identifier` and `Literal` because the preferred selectors support nodes and DOMString. |
| 72 | +const getArgumentNameForInsertAdjacentMethods = nodeArguments => { |
| 73 | + if (nodeArguments.type === 'Identifier') { |
| 74 | + return nodeArguments.name; |
| 75 | + } |
| 76 | + |
| 77 | + if (nodeArguments.type === 'Literal') { |
| 78 | + return nodeArguments.raw; |
| 79 | + } |
| 80 | +}; |
| 81 | + |
| 82 | +const positionReplacers = new Map([ |
| 83 | + ['beforebegin', 'before'], |
| 84 | + ['afterbegin', 'prepend'], |
| 85 | + ['beforeend', 'append'], |
| 86 | + ['afterend', 'after'] |
| 87 | +]); |
| 88 | + |
| 89 | +const checkForInsertAdjacentTextOrInsertAdjacentElement = (context, node) => { |
| 90 | + const identifierName = node.callee.property.name; |
| 91 | + |
| 92 | + // Return early when method name is not one of the targeted ones. |
| 93 | + if ( |
| 94 | + identifierName !== 'insertAdjacentText' && |
| 95 | + identifierName !== 'insertAdjacentElement' |
| 96 | + ) { |
| 97 | + return; |
| 98 | + } |
| 99 | + |
| 100 | + const nodeArguments = node.arguments; |
| 101 | + const positionArgument = getArgumentNameForInsertAdjacentMethods(nodeArguments[0]); |
| 102 | + const positionAsValue = nodeArguments[0].value; |
| 103 | + |
| 104 | + // Return early when specified position value of first argument is not a recognized value. |
| 105 | + if (!positionReplacers.has(positionAsValue)) { |
| 106 | + return; |
| 107 | + } |
| 108 | + |
| 109 | + const referenceNode = node.callee.object.name; |
| 110 | + const preferredSelector = positionReplacers.get(positionAsValue); |
| 111 | + const insertedTextArgument = getArgumentNameForInsertAdjacentMethods( |
| 112 | + nodeArguments[1] |
| 113 | + ); |
| 114 | + |
| 115 | + let fix = fixer => |
| 116 | + fixer.replaceText( |
| 117 | + node, |
| 118 | + `${referenceNode}.${preferredSelector}(${insertedTextArgument})` |
| 119 | + ); |
| 120 | + |
| 121 | + // Report error when the method is part of a variable assignment |
| 122 | + // but don't offer to autofix `.insertAdjacentElement()` |
| 123 | + // which don't have a return value. |
| 124 | + if (identifierName === 'insertAdjacentElement' && isPartOfVariableAssignment(node.parent.type)) { |
| 125 | + fix = undefined; |
| 126 | + } |
| 127 | + |
| 128 | + return context.report({ |
| 129 | + node, |
| 130 | + message: `Prefer \`${referenceNode}.${preferredSelector}(${insertedTextArgument})\` over \`${referenceNode}.${identifierName}(${positionArgument}, ${insertedTextArgument})\`.`, |
| 131 | + fix |
| 132 | + }); |
| 133 | +}; |
| 134 | + |
| 135 | +const create = context => { |
| 136 | + return { |
| 137 | + CallExpression(node) { |
| 138 | + if ( |
| 139 | + node.callee.type === 'MemberExpression' && |
| 140 | + node.arguments.length === 2 |
| 141 | + ) { |
| 142 | + checkForReplaceChildOrInsertBefore(context, node); |
| 143 | + checkForInsertAdjacentTextOrInsertAdjacentElement(context, node); |
| 144 | + } |
| 145 | + } |
| 146 | + }; |
| 147 | +}; |
| 148 | + |
| 149 | +module.exports = { |
| 150 | + create, |
| 151 | + meta: { |
| 152 | + type: 'suggestion', |
| 153 | + docs: { |
| 154 | + url: getDocumentationUrl(__filename) |
| 155 | + }, |
| 156 | + fixable: 'code' |
| 157 | + } |
| 158 | +}; |
0 commit comments