|
| 1 | +import docsUrl from '../docsUrl'; |
| 2 | + |
| 3 | +function isComma(token) { |
| 4 | + return token.type === 'Punctuator' && token.value === ','; |
| 5 | +} |
| 6 | + |
| 7 | +function removeSpecifiers(fixes, fixer, sourceCode, specifiers) { |
| 8 | + for (const specifier of specifiers) { |
| 9 | + // remove the trailing comma |
| 10 | + const comma = sourceCode.getTokenAfter(specifier, isComma); |
| 11 | + if (comma) { |
| 12 | + fixes.push(fixer.remove(comma)); |
| 13 | + } |
| 14 | + fixes.push(fixer.remove(specifier)); |
| 15 | + } |
| 16 | +} |
| 17 | + |
| 18 | +module.exports = { |
| 19 | + meta: { |
| 20 | + type: 'suggestion', |
| 21 | + docs: { |
| 22 | + description: 'Enforce or ban the use of inline type-only markers for named imports', |
| 23 | + url: docsUrl('consistent-type-specifier-style'), |
| 24 | + }, |
| 25 | + fixable: 'code', |
| 26 | + schema: [ |
| 27 | + { |
| 28 | + type: 'string', |
| 29 | + enum: ['prefer-inline', 'prefer-top-level'], |
| 30 | + default: 'prefer-inline', |
| 31 | + }, |
| 32 | + ], |
| 33 | + }, |
| 34 | + |
| 35 | + create(context) { |
| 36 | + const sourceCode = context.getSourceCode(); |
| 37 | + |
| 38 | + if (context.options[0] === 'prefer-inline') { |
| 39 | + return { |
| 40 | + ImportDeclaration(node) { |
| 41 | + if (node.importKind === 'value' || node.importKind == null) { |
| 42 | + // top-level value / unknown is valid |
| 43 | + return; |
| 44 | + } |
| 45 | + |
| 46 | + if ( |
| 47 | + // no specifiers (import type {} from '') have no specifiers to mark as inline |
| 48 | + node.specifiers.length === 0 || |
| 49 | + (node.specifiers.length === 1 && |
| 50 | + // default imports are both "inline" and "top-level" |
| 51 | + (node.specifiers[0].type === 'ImportDefaultSpecifier' || |
| 52 | + // namespace imports are both "inline" and "top-level" |
| 53 | + node.specifiers[0].type === 'ImportNamespaceSpecifier')) |
| 54 | + ) { |
| 55 | + return; |
| 56 | + } |
| 57 | + |
| 58 | + context.report({ |
| 59 | + node, |
| 60 | + message: 'Prefer using inline {{kind}} specifiers instead of a top-level {{kind}}-only import.', |
| 61 | + data: { |
| 62 | + kind: node.importKind, |
| 63 | + }, |
| 64 | + fix(fixer) { |
| 65 | + const kindToken = sourceCode.getFirstToken(node, { skip: 1 }); |
| 66 | + |
| 67 | + return [].concat( |
| 68 | + kindToken ? fixer.remove(kindToken) : [], |
| 69 | + node.specifiers.map((specifier) => fixer.insertTextBefore(specifier, `${node.importKind} `)), |
| 70 | + ); |
| 71 | + }, |
| 72 | + }); |
| 73 | + }, |
| 74 | + }; |
| 75 | + } |
| 76 | + |
| 77 | + // prefer-top-level |
| 78 | + return { |
| 79 | + ImportDeclaration(node) { |
| 80 | + if ( |
| 81 | + // already top-level is valid |
| 82 | + node.importKind === 'type' || |
| 83 | + node.importKind === 'typeof' || |
| 84 | + // no specifiers (import {} from '') cannot have inline - so is valid |
| 85 | + node.specifiers.length === 0 || |
| 86 | + (node.specifiers.length === 1 && |
| 87 | + // default imports are both "inline" and "top-level" |
| 88 | + (node.specifiers[0].type === 'ImportDefaultSpecifier' || |
| 89 | + // namespace imports are both "inline" and "top-level" |
| 90 | + node.specifiers[0].type === 'ImportNamespaceSpecifier')) |
| 91 | + ) { |
| 92 | + return; |
| 93 | + } |
| 94 | + |
| 95 | + const typeSpecifiers = []; |
| 96 | + const typeofSpecifiers = []; |
| 97 | + const valueSpecifiers = []; |
| 98 | + let defaultSpecifier = null; |
| 99 | + for (const specifier of node.specifiers) { |
| 100 | + if (specifier.type === 'ImportDefaultSpecifier') { |
| 101 | + defaultSpecifier = specifier; |
| 102 | + continue; |
| 103 | + } else if (specifier.type !== 'ImportSpecifier') { |
| 104 | + continue; |
| 105 | + } |
| 106 | + |
| 107 | + if (specifier.importKind === 'type') { |
| 108 | + typeSpecifiers.push(specifier); |
| 109 | + } else if (specifier.importKind === 'typeof') { |
| 110 | + typeofSpecifiers.push(specifier); |
| 111 | + } else if (specifier.importKind === 'value' || specifier.importKind == null) { |
| 112 | + valueSpecifiers.push(specifier); |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + const typeImport = getImportText(typeSpecifiers, 'type'); |
| 117 | + const typeofImport = getImportText(typeofSpecifiers, 'typeof'); |
| 118 | + const newImports = `${typeImport}\n${typeofImport}`.trim(); |
| 119 | + |
| 120 | + if (typeSpecifiers.length + typeofSpecifiers.length === node.specifiers.length) { |
| 121 | + // all specifiers have inline specifiers - so we replace the entire import |
| 122 | + const kind = [].concat( |
| 123 | + typeSpecifiers.length > 0 ? 'type' : [], |
| 124 | + typeofSpecifiers.length > 0 ? 'typeof' : [], |
| 125 | + ); |
| 126 | + |
| 127 | + context.report({ |
| 128 | + node, |
| 129 | + message: 'Prefer using a top-level {{kind}}-only import instead of inline {{kind}} specifiers.', |
| 130 | + data: { |
| 131 | + kind: kind.join('/'), |
| 132 | + }, |
| 133 | + fix(fixer) { |
| 134 | + return fixer.replaceText(node, newImports); |
| 135 | + }, |
| 136 | + }); |
| 137 | + } else { |
| 138 | + // remove specific specifiers and insert new imports for them |
| 139 | + for (const specifier of typeSpecifiers.concat(typeofSpecifiers)) { |
| 140 | + context.report({ |
| 141 | + node: specifier, |
| 142 | + message: 'Prefer using a top-level {{kind}}-only import instead of inline {{kind}} specifiers.', |
| 143 | + data: { |
| 144 | + kind: specifier.importKind, |
| 145 | + }, |
| 146 | + fix(fixer) { |
| 147 | + const fixes = []; |
| 148 | + |
| 149 | + // if there are no value specifiers, then the other report fixer will be called, not this one |
| 150 | + |
| 151 | + if (valueSpecifiers.length > 0) { |
| 152 | + // import { Value, type Type } from 'mod'; |
| 153 | + |
| 154 | + // we can just remove the type specifiers |
| 155 | + removeSpecifiers(fixes, fixer, sourceCode, typeSpecifiers); |
| 156 | + removeSpecifiers(fixes, fixer, sourceCode, typeofSpecifiers); |
| 157 | + |
| 158 | + // make the import nicely formatted by also removing the trailing comma after the last value import |
| 159 | + // eg |
| 160 | + // import { Value, type Type } from 'mod'; |
| 161 | + // to |
| 162 | + // import { Value } from 'mod'; |
| 163 | + // not |
| 164 | + // import { Value, } from 'mod'; |
| 165 | + const maybeComma = sourceCode.getTokenAfter(valueSpecifiers[valueSpecifiers.length - 1]); |
| 166 | + if (isComma(maybeComma)) { |
| 167 | + fixes.push(fixer.remove(maybeComma)); |
| 168 | + } |
| 169 | + } else if (defaultSpecifier) { |
| 170 | + // import Default, { type Type } from 'mod'; |
| 171 | + |
| 172 | + // remove the entire curly block so we don't leave an empty one behind |
| 173 | + // NOTE - the default specifier *must* be the first specifier always! |
| 174 | + // so a comma exists that we also have to clean up or else it's bad syntax |
| 175 | + const comma = sourceCode.getTokenAfter(defaultSpecifier, isComma); |
| 176 | + const closingBrace = sourceCode.getTokenAfter( |
| 177 | + node.specifiers[node.specifiers.length - 1], |
| 178 | + token => token.type === 'Punctuator' && token.value === '}', |
| 179 | + ); |
| 180 | + fixes.push(fixer.removeRange([ |
| 181 | + comma.range[0], |
| 182 | + closingBrace.range[1], |
| 183 | + ])); |
| 184 | + } |
| 185 | + |
| 186 | + return fixes.concat( |
| 187 | + // insert the new imports after the old declaration |
| 188 | + fixer.insertTextAfter(node, `\n${newImports}`), |
| 189 | + ); |
| 190 | + }, |
| 191 | + }); |
| 192 | + } |
| 193 | + } |
| 194 | + |
| 195 | + function getImportText( |
| 196 | + specifiers, |
| 197 | + kind, |
| 198 | + ) { |
| 199 | + const sourceString = sourceCode.getText(node.source); |
| 200 | + if (specifiers.length === 0) { |
| 201 | + return ''; |
| 202 | + } |
| 203 | + |
| 204 | + const names = specifiers.map(s => { |
| 205 | + if (s.imported.name === s.local.name) { |
| 206 | + return s.imported.name; |
| 207 | + } |
| 208 | + return `${s.imported.name} as ${s.local.name}`; |
| 209 | + }); |
| 210 | + // insert a fresh top-level import |
| 211 | + return `import ${kind} {${names.join(', ')}} from ${sourceString};`; |
| 212 | + } |
| 213 | + }, |
| 214 | + }; |
| 215 | + }, |
| 216 | +}; |
0 commit comments