|
| 1 | +// `shims-vue.d.ts` for Vue 3, generated by CLI 4.5.0-4.5.6, uses the following declaration: |
| 2 | +// `component: ReturnType<typeof defineComponent>` |
| 3 | + |
| 4 | +// So needs to update to: |
| 5 | +// `component: DefineComponent` |
| 6 | + |
| 7 | +module.exports = function migrateComponentType (file, api) { |
| 8 | + const j = api.jscodeshift |
| 9 | + const root = j(file.source) |
| 10 | + |
| 11 | + const tsmodule = root.find(j.TSModuleDeclaration, { |
| 12 | + id: { |
| 13 | + value: '*.vue' |
| 14 | + } |
| 15 | + }) |
| 16 | + |
| 17 | + const componentDecl = tsmodule.find(j.VariableDeclarator, { |
| 18 | + id: { |
| 19 | + name: 'component', |
| 20 | + typeAnnotation: { |
| 21 | + typeAnnotation: { |
| 22 | + typeName: { |
| 23 | + name: 'ReturnType' |
| 24 | + }, |
| 25 | + typeParameters: { |
| 26 | + params: { |
| 27 | + 0: { |
| 28 | + exprName: { |
| 29 | + name: 'defineComponent' |
| 30 | + } |
| 31 | + } |
| 32 | + } |
| 33 | + } |
| 34 | + } |
| 35 | + } |
| 36 | + } |
| 37 | + }) |
| 38 | + |
| 39 | + if (componentDecl.length !== 1) { |
| 40 | + return file.source |
| 41 | + } |
| 42 | + |
| 43 | + // update the component type |
| 44 | + componentDecl.forEach(({ node }) => { |
| 45 | + node.id.typeAnnotation = j.tsTypeAnnotation( |
| 46 | + j.tsTypeReference(j.identifier('DefineComponent')) |
| 47 | + ) |
| 48 | + }) |
| 49 | + |
| 50 | + // insert DefineComponent type import |
| 51 | + const importDeclFromVue = tsmodule.find(j.ImportDeclaration, { |
| 52 | + source: { |
| 53 | + value: 'vue' |
| 54 | + } |
| 55 | + }) |
| 56 | + importDeclFromVue |
| 57 | + .get(0) |
| 58 | + .node.specifiers.push(j.importSpecifier(j.identifier('DefineComponent'))) |
| 59 | + |
| 60 | + // remove defineComponent import if unused |
| 61 | + const defineComponentUsages = tsmodule |
| 62 | + .find(j.Identifier, { name: 'defineComponent' }) |
| 63 | + .filter((identifierPath) => { |
| 64 | + const parent = identifierPath.parent.node |
| 65 | + |
| 66 | + // Ignore the import specifier |
| 67 | + if ( |
| 68 | + j.ImportDefaultSpecifier.check(parent) || |
| 69 | + j.ImportSpecifier.check(parent) || |
| 70 | + j.ImportNamespaceSpecifier.check(parent) |
| 71 | + ) { |
| 72 | + return false |
| 73 | + } |
| 74 | + }) |
| 75 | + if (defineComponentUsages.length === 0) { |
| 76 | + tsmodule |
| 77 | + .find(j.ImportSpecifier, { |
| 78 | + local: { |
| 79 | + name: 'defineComponent' |
| 80 | + } |
| 81 | + }) |
| 82 | + .remove() |
| 83 | + } |
| 84 | + |
| 85 | + return root.toSource() |
| 86 | +} |
| 87 | + |
| 88 | +module.exports.parser = 'ts' |
0 commit comments