|
| 1 | +'use strict'; |
| 2 | + |
| 3 | +//------------------------------------------------------------------------------ |
| 4 | +// Mapping from tracked-built-ins exports to @ember/reactive exports |
| 5 | +//------------------------------------------------------------------------------ |
| 6 | + |
| 7 | +const TRACKED_BUILT_INS_MAPPING = { |
| 8 | + TrackedArray: 'trackedArray', |
| 9 | + TrackedObject: 'trackedObject', |
| 10 | + TrackedMap: 'trackedMap', |
| 11 | + TrackedWeakMap: 'trackedWeakMap', |
| 12 | + TrackedSet: 'trackedSet', |
| 13 | + TrackedWeakSet: 'trackedWeakSet', |
| 14 | +}; |
| 15 | + |
| 16 | +const TRACKED_BUILT_INS_MODULE = 'tracked-built-ins'; |
| 17 | +const EMBER_REACTIVE_MODULE = '@ember/reactive'; |
| 18 | + |
| 19 | +const ERROR_MESSAGE_IMPORT = |
| 20 | + 'Use imports from `@ember/reactive` instead of `tracked-built-ins`.'; |
| 21 | + |
| 22 | +//------------------------------------------------------------------------------ |
| 23 | +// Rule Definition |
| 24 | +//------------------------------------------------------------------------------ |
| 25 | + |
| 26 | +/** @type {import('eslint').Rule.RuleModule} */ |
| 27 | +module.exports = { |
| 28 | + meta: { |
| 29 | + type: 'suggestion', |
| 30 | + docs: { |
| 31 | + description: |
| 32 | + 'enforce usage of `@ember/reactive` imports instead of `tracked-built-ins`', |
| 33 | + category: 'Ember Octane', |
| 34 | + recommended: false, |
| 35 | + url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-tracked-built-ins.md', |
| 36 | + }, |
| 37 | + fixable: 'code', |
| 38 | + schema: [], |
| 39 | + messages: { |
| 40 | + import: ERROR_MESSAGE_IMPORT, |
| 41 | + newExpression: |
| 42 | + 'Use `{{newName}}(...)` instead of `new {{oldName}}(...)`. The `@ember/reactive` utilities do not use `new`.', |
| 43 | + }, |
| 44 | + }, |
| 45 | + |
| 46 | + ERROR_MESSAGE_IMPORT, |
| 47 | + |
| 48 | + create(context) { |
| 49 | + // Track which imported identifiers map to tracked-built-ins classes |
| 50 | + // so we can fix `new TrackedArray(...)` → `trackedArray(...)` |
| 51 | + const trackedIdentifiers = new Map(); |
| 52 | + |
| 53 | + return { |
| 54 | + ImportDeclaration(node) { |
| 55 | + if (node.source.value !== TRACKED_BUILT_INS_MODULE) { |
| 56 | + return; |
| 57 | + } |
| 58 | + |
| 59 | + context.report({ |
| 60 | + node, |
| 61 | + messageId: 'import', |
| 62 | + fix(fixer) { |
| 63 | + const specifiers = node.specifiers; |
| 64 | + |
| 65 | + // Only autofix named imports we know how to map |
| 66 | + const namedSpecifiers = specifiers.filter( |
| 67 | + (s) => |
| 68 | + s.type === 'ImportSpecifier' && |
| 69 | + s.imported.name in TRACKED_BUILT_INS_MAPPING |
| 70 | + ); |
| 71 | + |
| 72 | + // If there's a default import or unknown named imports, we can't fully autofix |
| 73 | + const hasDefault = specifiers.some( |
| 74 | + (s) => s.type === 'ImportDefaultSpecifier' |
| 75 | + ); |
| 76 | + const unknownNamed = specifiers.filter( |
| 77 | + (s) => |
| 78 | + s.type === 'ImportSpecifier' && |
| 79 | + !(s.imported.name in TRACKED_BUILT_INS_MAPPING) |
| 80 | + ); |
| 81 | + |
| 82 | + if (hasDefault || unknownNamed.length > 0 || namedSpecifiers.length === 0) { |
| 83 | + return null; |
| 84 | + } |
| 85 | + |
| 86 | + const newSpecifiers = namedSpecifiers.map((s) => { |
| 87 | + const newName = TRACKED_BUILT_INS_MAPPING[s.imported.name]; |
| 88 | + if (s.local.name !== s.imported.name) { |
| 89 | + // Has alias: `import { TrackedArray as TA }` → `import { trackedArray as TA }` |
| 90 | + return `${newName} as ${s.local.name}`; |
| 91 | + } |
| 92 | + return newName; |
| 93 | + }); |
| 94 | + |
| 95 | + const newImport = `import { ${newSpecifiers.join(', ')} } from '${EMBER_REACTIVE_MODULE}';`; |
| 96 | + return fixer.replaceText(node, newImport); |
| 97 | + }, |
| 98 | + }); |
| 99 | + |
| 100 | + // Register the local names for NewExpression tracking |
| 101 | + for (const specifier of node.specifiers) { |
| 102 | + if ( |
| 103 | + specifier.type === 'ImportSpecifier' && |
| 104 | + specifier.imported.name in TRACKED_BUILT_INS_MAPPING |
| 105 | + ) { |
| 106 | + const isAliased = specifier.local.name !== specifier.imported.name; |
| 107 | + trackedIdentifiers.set(specifier.local.name, { |
| 108 | + newName: TRACKED_BUILT_INS_MAPPING[specifier.imported.name], |
| 109 | + isAliased, |
| 110 | + }); |
| 111 | + } |
| 112 | + } |
| 113 | + }, |
| 114 | + |
| 115 | + NewExpression(node) { |
| 116 | + if ( |
| 117 | + node.callee.type === 'Identifier' && |
| 118 | + trackedIdentifiers.has(node.callee.name) |
| 119 | + ) { |
| 120 | + const oldName = node.callee.name; |
| 121 | + const { newName, isAliased } = trackedIdentifiers.get(oldName); |
| 122 | + |
| 123 | + context.report({ |
| 124 | + node, |
| 125 | + messageId: 'newExpression', |
| 126 | + data: { oldName, newName }, |
| 127 | + fix(fixer) { |
| 128 | + const sourceCode = context.getSourceCode(); |
| 129 | + const newKeyword = sourceCode.getFirstToken(node); |
| 130 | + const fixes = [ |
| 131 | + // Remove the `new` keyword and the space after it |
| 132 | + fixer.removeRange([newKeyword.range[0], newKeyword.range[1] + 1]), |
| 133 | + ]; |
| 134 | + // Only rename the callee if it's not aliased |
| 135 | + if (!isAliased) { |
| 136 | + fixes.push(fixer.replaceText(node.callee, newName)); |
| 137 | + } |
| 138 | + return fixes; |
| 139 | + }, |
| 140 | + }); |
| 141 | + } |
| 142 | + }, |
| 143 | + }; |
| 144 | + }, |
| 145 | +}; |
0 commit comments