"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); const utils_1 = require("@typescript-eslint/utils"); const util = __importStar(require("../util")); function isImportToken(token) { return token.type === utils_1.AST_TOKEN_TYPES.Keyword && token.value === 'import'; } function isTypeToken(token) { return token.type === utils_1.AST_TOKEN_TYPES.Identifier && token.value === 'type'; } exports.default = util.createRule({ name: 'consistent-type-imports', meta: { type: 'suggestion', docs: { description: 'Enforce consistent usage of type imports', recommended: false, }, messages: { typeOverValue: 'All imports in the declaration are only used as types. Use `import type`.', someImportsAreOnlyTypes: 'Imports {{typeImports}} are only used as types.', aImportIsOnlyTypes: 'Import {{typeImports}} is only used as types.', someImportsInDecoMeta: 'Type imports {{typeImports}} are used by decorator metadata.', aImportInDecoMeta: 'Type import {{typeImports}} is used by decorator metadata.', valueOverType: 'Use an `import` instead of an `import type`.', noImportTypeAnnotations: '`import()` type annotations are forbidden.', }, schema: [ { type: 'object', properties: { prefer: { enum: ['type-imports', 'no-type-imports'], }, disallowTypeAnnotations: { type: 'boolean', }, }, additionalProperties: false, }, ], fixable: 'code', }, defaultOptions: [ { prefer: 'type-imports', disallowTypeAnnotations: true, }, ], create(context, [option]) { var _a; const prefer = (_a = option.prefer) !== null && _a !== void 0 ? _a : 'type-imports'; const disallowTypeAnnotations = option.disallowTypeAnnotations !== false; const sourceCode = context.getSourceCode(); const sourceImportsMap = {}; return Object.assign(Object.assign({}, (prefer === 'type-imports' ? { // prefer type imports ImportDeclaration(node) { var _a; const source = node.source.value; const sourceImports = (_a = sourceImportsMap[source]) !== null && _a !== void 0 ? _a : (sourceImportsMap[source] = { source, reportValueImports: [], typeOnlyNamedImport: null, valueOnlyNamedImport: null, }); if (node.importKind === 'type') { if (!sourceImports.typeOnlyNamedImport && node.specifiers.every(specifier => specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier)) { sourceImports.typeOnlyNamedImport = node; } } else { if (!sourceImports.valueOnlyNamedImport && node.specifiers.every(specifier => specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier)) { sourceImports.valueOnlyNamedImport = node; } } const typeSpecifiers = []; const inlineTypeSpecifiers = []; const valueSpecifiers = []; const unusedSpecifiers = []; for (const specifier of node.specifiers) { if (specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type') { inlineTypeSpecifiers.push(specifier); continue; } const [variable] = context.getDeclaredVariables(specifier); if (variable.references.length === 0) { unusedSpecifiers.push(specifier); } else { const onlyHasTypeReferences = variable.references.every(ref => { var _a, _b; /** * keep origin import kind when export * export { Type } * export default Type; */ if (((_a = ref.identifier.parent) === null || _a === void 0 ? void 0 : _a.type) === utils_1.AST_NODE_TYPES.ExportSpecifier || ((_b = ref.identifier.parent) === null || _b === void 0 ? void 0 : _b.type) === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration) { if (ref.isValueReference && ref.isTypeReference) { return node.importKind === 'type'; } } if (ref.isValueReference) { let parent = ref.identifier.parent; let child = ref.identifier; while (parent) { switch (parent.type) { // CASE 1: // `type T = typeof foo` will create a value reference because "foo" must be a value type // however this value reference is safe to use with type-only imports case utils_1.AST_NODE_TYPES.TSTypeQuery: return true; case utils_1.AST_NODE_TYPES.TSQualifiedName: // TSTypeQuery must have a TSESTree.EntityName as its child, so we can filter here and break early if (parent.left !== child) { return false; } child = parent; parent = parent.parent; continue; // END CASE 1 ////////////// // CASE 2: // `type T = { [foo]: string }` will create a value reference because "foo" must be a value type // however this value reference is safe to use with type-only imports. // Also this is represented as a non-type AST - hence it uses MemberExpression case utils_1.AST_NODE_TYPES.TSPropertySignature: return parent.key === child; case utils_1.AST_NODE_TYPES.MemberExpression: if (parent.object !== child) { return false; } child = parent; parent = parent.parent; continue; // END CASE 2 default: return false; } } } return ref.isTypeReference; }); if (onlyHasTypeReferences) { typeSpecifiers.push(specifier); } else { valueSpecifiers.push(specifier); } } } if ((node.importKind === 'value' && typeSpecifiers.length) || (node.importKind === 'type' && valueSpecifiers.length)) { sourceImports.reportValueImports.push({ node, typeSpecifiers, valueSpecifiers, unusedSpecifiers, inlineTypeSpecifiers, }); } }, 'Program:exit'() { for (const sourceImports of Object.values(sourceImportsMap)) { if (sourceImports.reportValueImports.length === 0) { continue; } for (const report of sourceImports.reportValueImports) { if (report.valueSpecifiers.length === 0 && report.unusedSpecifiers.length === 0) { // import is all type-only, convert the entire import to `import type` context.report({ node: report.node, messageId: 'typeOverValue', *fix(fixer) { yield* fixToTypeImportDeclaration(fixer, report, sourceImports); }, }); } else { const isTypeImport = report.node.importKind === 'type'; // we have a mixed type/value import, so we need to split them out into multiple exports const importNames = (isTypeImport ? report.valueSpecifiers : report.typeSpecifiers).map(specifier => `"${specifier.local.name}"`); const message = (() => { const typeImports = util.formatWordList(importNames); if (importNames.length === 1) { if (isTypeImport) { return { messageId: 'aImportInDecoMeta', data: { typeImports }, }; } else { return { messageId: 'aImportIsOnlyTypes', data: { typeImports }, }; } } else { if (isTypeImport) { return { messageId: 'someImportsInDecoMeta', data: { typeImports }, }; } else { return { messageId: 'someImportsAreOnlyTypes', data: { typeImports }, }; } } })(); context.report(Object.assign(Object.assign({ node: report.node }, message), { *fix(fixer) { if (isTypeImport) { yield* fixToValueImportDeclaration(fixer, report, sourceImports); } else { yield* fixToTypeImportDeclaration(fixer, report, sourceImports); } } })); } } } }, } : { // prefer no type imports 'ImportDeclaration[importKind = "type"]'(node) { context.report({ node, messageId: 'valueOverType', fix(fixer) { return fixRemoveTypeSpecifierFromImportDeclaration(fixer, node); }, }); }, 'ImportSpecifier[importKind = "type"]'(node) { context.report({ node, messageId: 'valueOverType', fix(fixer) { return fixRemoveTypeSpecifierFromImportSpecifier(fixer, node); }, }); }, })), (disallowTypeAnnotations ? { // disallow `import()` type TSImportType(node) { context.report({ node, messageId: 'noImportTypeAnnotations', }); }, } : {})); function classifySpecifier(node) { var _a; const defaultSpecifier = node.specifiers[0].type === utils_1.AST_NODE_TYPES.ImportDefaultSpecifier ? node.specifiers[0] : null; const namespaceSpecifier = (_a = node.specifiers.find((specifier) => specifier.type === utils_1.AST_NODE_TYPES.ImportNamespaceSpecifier)) !== null && _a !== void 0 ? _a : null; const namedSpecifiers = node.specifiers.filter((specifier) => specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier); return { defaultSpecifier, namespaceSpecifier, namedSpecifiers, }; } /** * Returns information for fixing named specifiers. */ function getFixesNamedSpecifiers(fixer, node, typeNamedSpecifiers, allNamedSpecifiers) { if (allNamedSpecifiers.length === 0) { return { typeNamedSpecifiersText: '', removeTypeNamedSpecifiers: [], }; } const typeNamedSpecifiersTexts = []; const removeTypeNamedSpecifiers = []; if (typeNamedSpecifiers.length === allNamedSpecifiers.length) { // import Foo, {Type1, Type2} from 'foo' // import DefType, {Type1, Type2} from 'foo' const openingBraceToken = util.nullThrows(sourceCode.getTokenBefore(typeNamedSpecifiers[0], util.isOpeningBraceToken), util.NullThrowsReasons.MissingToken('{', node.type)); const commaToken = util.nullThrows(sourceCode.getTokenBefore(openingBraceToken, util.isCommaToken), util.NullThrowsReasons.MissingToken(',', node.type)); const closingBraceToken = util.nullThrows(sourceCode.getFirstTokenBetween(openingBraceToken, node.source, util.isClosingBraceToken), util.NullThrowsReasons.MissingToken('}', node.type)); // import DefType, {...} from 'foo' // ^^^^^^^ remove removeTypeNamedSpecifiers.push(fixer.removeRange([commaToken.range[0], closingBraceToken.range[1]])); typeNamedSpecifiersTexts.push(sourceCode.text.slice(openingBraceToken.range[1], closingBraceToken.range[0])); } else { const typeNamedSpecifierGroups = []; let group = []; for (const namedSpecifier of allNamedSpecifiers) { if (typeNamedSpecifiers.includes(namedSpecifier)) { group.push(namedSpecifier); } else if (group.length) { typeNamedSpecifierGroups.push(group); group = []; } } if (group.length) { typeNamedSpecifierGroups.push(group); } for (const namedSpecifiers of typeNamedSpecifierGroups) { const { removeRange, textRange } = getNamedSpecifierRanges(namedSpecifiers, allNamedSpecifiers); removeTypeNamedSpecifiers.push(fixer.removeRange(removeRange)); typeNamedSpecifiersTexts.push(sourceCode.text.slice(...textRange)); } } return { typeNamedSpecifiersText: typeNamedSpecifiersTexts.join(','), removeTypeNamedSpecifiers, }; } /** * Returns ranges for fixing named specifier. */ function getNamedSpecifierRanges(namedSpecifierGroup, allNamedSpecifiers) { const first = namedSpecifierGroup[0]; const last = namedSpecifierGroup[namedSpecifierGroup.length - 1]; const removeRange = [first.range[0], last.range[1]]; const textRange = [...removeRange]; const before = sourceCode.getTokenBefore(first); textRange[0] = before.range[1]; if (util.isCommaToken(before)) { removeRange[0] = before.range[0]; } else { removeRange[0] = before.range[1]; } const isFirst = allNamedSpecifiers[0] === first; const isLast = allNamedSpecifiers[allNamedSpecifiers.length - 1] === last; const after = sourceCode.getTokenAfter(last); textRange[1] = after.range[0]; if (isFirst || isLast) { if (util.isCommaToken(after)) { removeRange[1] = after.range[1]; } } return { textRange, removeRange, }; } /** * insert specifiers to named import node. * e.g. * import type { Already, Type1, Type2 } from 'foo' * ^^^^^^^^^^^^^ insert */ function fixInsertNamedSpecifiersInNamedSpecifierList(fixer, target, insertText) { const closingBraceToken = util.nullThrows(sourceCode.getFirstTokenBetween(sourceCode.getFirstToken(target), target.source, util.isClosingBraceToken), util.NullThrowsReasons.MissingToken('}', target.type)); const before = sourceCode.getTokenBefore(closingBraceToken); if (!util.isCommaToken(before) && !util.isOpeningBraceToken(before)) { insertText = `,${insertText}`; } return fixer.insertTextBefore(closingBraceToken, `${insertText}`); } function* fixToTypeImportDeclaration(fixer, report, sourceImports) { const { node } = report; const { defaultSpecifier, namespaceSpecifier, namedSpecifiers } = classifySpecifier(node); if (namespaceSpecifier && !defaultSpecifier) { // import * as types from 'foo' yield* fixInsertTypeSpecifierForImportDeclaration(fixer, node, false); return; } else if (defaultSpecifier) { if (report.typeSpecifiers.includes(defaultSpecifier) && namedSpecifiers.length === 0 && !namespaceSpecifier) { // import Type from 'foo' yield* fixInsertTypeSpecifierForImportDeclaration(fixer, node, true); return; } } else { if (namedSpecifiers.every(specifier => report.typeSpecifiers.includes(specifier)) && !namespaceSpecifier) { // import {Type1, Type2} from 'foo' yield* fixInsertTypeSpecifierForImportDeclaration(fixer, node, false); return; } } const typeNamedSpecifiers = namedSpecifiers.filter(specifier => report.typeSpecifiers.includes(specifier)); const fixesNamedSpecifiers = getFixesNamedSpecifiers(fixer, node, typeNamedSpecifiers, namedSpecifiers); const afterFixes = []; if (typeNamedSpecifiers.length) { if (sourceImports.typeOnlyNamedImport) { const insertTypeNamedSpecifiers = fixInsertNamedSpecifiersInNamedSpecifierList(fixer, sourceImports.typeOnlyNamedImport, fixesNamedSpecifiers.typeNamedSpecifiersText); if (sourceImports.typeOnlyNamedImport.range[1] <= node.range[0]) { yield insertTypeNamedSpecifiers; } else { afterFixes.push(insertTypeNamedSpecifiers); } } else { yield fixer.insertTextBefore(node, `import type {${fixesNamedSpecifiers.typeNamedSpecifiersText}} from ${sourceCode.getText(node.source)};\n`); } } const fixesRemoveTypeNamespaceSpecifier = []; if (namespaceSpecifier && report.typeSpecifiers.includes(namespaceSpecifier)) { // import Foo, * as Type from 'foo' // import DefType, * as Type from 'foo' // import DefType, * as Type from 'foo' const commaToken = util.nullThrows(sourceCode.getTokenBefore(namespaceSpecifier, util.isCommaToken), util.NullThrowsReasons.MissingToken(',', node.type)); // import Def, * as Ns from 'foo' // ^^^^^^^^^ remove fixesRemoveTypeNamespaceSpecifier.push(fixer.removeRange([commaToken.range[0], namespaceSpecifier.range[1]])); // import type * as Ns from 'foo' // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ insert yield fixer.insertTextBefore(node, `import type ${sourceCode.getText(namespaceSpecifier)} from ${sourceCode.getText(node.source)};\n`); } if (defaultSpecifier && report.typeSpecifiers.includes(defaultSpecifier)) { if (report.typeSpecifiers.length === node.specifiers.length) { const importToken = util.nullThrows(sourceCode.getFirstToken(node, isImportToken), util.NullThrowsReasons.MissingToken('import', node.type)); // import type Type from 'foo' // ^^^^ insert yield fixer.insertTextAfter(importToken, ' type'); } else { const commaToken = util.nullThrows(sourceCode.getTokenAfter(defaultSpecifier, util.isCommaToken), util.NullThrowsReasons.MissingToken(',', defaultSpecifier.type)); // import Type , {...} from 'foo' // ^^^^^ pick const defaultText = sourceCode.text .slice(defaultSpecifier.range[0], commaToken.range[0]) .trim(); yield fixer.insertTextBefore(node, `import type ${defaultText} from ${sourceCode.getText(node.source)};\n`); const afterToken = util.nullThrows(sourceCode.getTokenAfter(commaToken, { includeComments: true }), util.NullThrowsReasons.MissingToken('any token', node.type)); // import Type , {...} from 'foo' // ^^^^^^^ remove yield fixer.removeRange([ defaultSpecifier.range[0], afterToken.range[0], ]); } } yield* fixesNamedSpecifiers.removeTypeNamedSpecifiers; yield* fixesRemoveTypeNamespaceSpecifier; yield* afterFixes; } function* fixInsertTypeSpecifierForImportDeclaration(fixer, node, isDefaultImport) { // import type Foo from 'foo' // ^^^^^ insert const importToken = util.nullThrows(sourceCode.getFirstToken(node, isImportToken), util.NullThrowsReasons.MissingToken('import', node.type)); yield fixer.insertTextAfter(importToken, ' type'); if (isDefaultImport) { // Has default import const openingBraceToken = sourceCode.getFirstTokenBetween(importToken, node.source, util.isOpeningBraceToken); if (openingBraceToken) { // Only braces. e.g. import Foo, {} from 'foo' const commaToken = util.nullThrows(sourceCode.getTokenBefore(openingBraceToken, util.isCommaToken), util.NullThrowsReasons.MissingToken(',', node.type)); const closingBraceToken = util.nullThrows(sourceCode.getFirstTokenBetween(openingBraceToken, node.source, util.isClosingBraceToken), util.NullThrowsReasons.MissingToken('}', node.type)); // import type Foo, {} from 'foo' // ^^ remove yield fixer.removeRange([ commaToken.range[0], closingBraceToken.range[1], ]); const specifiersText = sourceCode.text.slice(commaToken.range[1], closingBraceToken.range[1]); if (node.specifiers.length > 1) { // import type Foo from 'foo' // import type {...} from 'foo' // <- insert yield fixer.insertTextAfter(node, `\nimport type${specifiersText} from ${sourceCode.getText(node.source)};`); } } } // make sure we don't do anything like `import type {type T} from 'foo';` for (const specifier of node.specifiers) { if (specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type') { yield* fixRemoveTypeSpecifierFromImportSpecifier(fixer, specifier); } } } function* fixToValueImportDeclaration(fixer, report, sourceImports) { const { node } = report; const { defaultSpecifier, namespaceSpecifier, namedSpecifiers } = classifySpecifier(node); if (namespaceSpecifier) { // import type * as types from 'foo' yield* fixRemoveTypeSpecifierFromImportDeclaration(fixer, node); return; } else if (defaultSpecifier) { if (report.valueSpecifiers.includes(defaultSpecifier) && namedSpecifiers.length === 0) { // import type Type from 'foo' yield* fixRemoveTypeSpecifierFromImportDeclaration(fixer, node); return; } } else { if (namedSpecifiers.every(specifier => report.valueSpecifiers.includes(specifier))) { // import type {Type1, Type2} from 'foo' yield* fixRemoveTypeSpecifierFromImportDeclaration(fixer, node); return; } } const valueNamedSpecifiers = namedSpecifiers.filter(specifier => report.valueSpecifiers.includes(specifier)); const fixesNamedSpecifiers = getFixesNamedSpecifiers(fixer, node, valueNamedSpecifiers, namedSpecifiers); const afterFixes = []; if (valueNamedSpecifiers.length) { if (sourceImports.valueOnlyNamedImport) { const insertTypeNamedSpecifiers = fixInsertNamedSpecifiersInNamedSpecifierList(fixer, sourceImports.valueOnlyNamedImport, fixesNamedSpecifiers.typeNamedSpecifiersText); if (sourceImports.valueOnlyNamedImport.range[1] <= node.range[0]) { yield insertTypeNamedSpecifiers; } else { afterFixes.push(insertTypeNamedSpecifiers); } } else { yield fixer.insertTextBefore(node, `import {${fixesNamedSpecifiers.typeNamedSpecifiersText}} from ${sourceCode.getText(node.source)};\n`); } } yield* fixesNamedSpecifiers.removeTypeNamedSpecifiers; yield* afterFixes; } function* fixRemoveTypeSpecifierFromImportDeclaration(fixer, node) { var _a, _b; // import type Foo from 'foo' // ^^^^ remove const importToken = util.nullThrows(sourceCode.getFirstToken(node, isImportToken), util.NullThrowsReasons.MissingToken('import', node.type)); const typeToken = util.nullThrows(sourceCode.getFirstTokenBetween(importToken, (_b = (_a = node.specifiers[0]) === null || _a === void 0 ? void 0 : _a.local) !== null && _b !== void 0 ? _b : node.source, isTypeToken), util.NullThrowsReasons.MissingToken('type', node.type)); const afterToken = util.nullThrows(sourceCode.getTokenAfter(typeToken, { includeComments: true }), util.NullThrowsReasons.MissingToken('any token', node.type)); yield fixer.removeRange([typeToken.range[0], afterToken.range[0]]); } function* fixRemoveTypeSpecifierFromImportSpecifier(fixer, node) { const typeToken = util.nullThrows(sourceCode.getFirstToken(node, isTypeToken), util.NullThrowsReasons.MissingToken('type', node.type)); const afterToken = util.nullThrows(sourceCode.getTokenAfter(typeToken, { includeComments: true }), util.NullThrowsReasons.MissingToken('any token', node.type)); yield fixer.removeRange([typeToken.range[0], afterToken.range[0]]); } }, }); //# sourceMappingURL=consistent-type-imports.js.map