rsnext/packages/next-codemod/transforms/add-missing-react-import.ts
Zack Tanner e039cc72fc
enable verbatimModuleSyntax to make type imports/exports explicit (#56551)
This has come up in code review a few times, so enabling the tsconfig setting so it's more easily caught.
2023-10-07 15:09:54 +00:00

89 lines
2.1 KiB
TypeScript

import type {
API,
Collection,
FileInfo,
JSCodeshift,
Options,
} from 'jscodeshift'
function addReactImport(j: JSCodeshift, root: Collection) {
// We create an import specifier, this is the value of an import, eg:
// import React from 'react'
// The specifier would be `React`
const ReactDefaultSpecifier = j.importDefaultSpecifier(j.identifier('React'))
// Check if this file is already importing `react`
// so that we can attach `React` to the existing import instead of creating a new `import` node
const originalReactImport = root.find(j.ImportDeclaration, {
source: {
value: 'react',
},
})
if (originalReactImport.length > 0) {
// Check if `React` is already imported. In that case we don't have to do anything
if (originalReactImport.find(j.ImportDefaultSpecifier).length > 0) {
return
}
// Attach `React` to the existing `react` import node
originalReactImport.forEach((node) => {
node.value.specifiers.unshift(ReactDefaultSpecifier)
})
return
}
// Create import node
// import React from 'react'
const ReactImport = j.importDeclaration(
[ReactDefaultSpecifier],
j.stringLiteral('react')
)
// Find the Program, this is the top level AST node
const Program = root.find(j.Program)
// Attach the import at the top of the body
Program.forEach((node) => {
node.value.body.unshift(ReactImport)
})
}
export default function transformer(
file: FileInfo,
api: API,
options: Options
) {
const j = api.jscodeshift.withParser('tsx')
const root = j(file.source)
const hasReactImport = (r) => {
return (
r.find(j.ImportDefaultSpecifier, {
local: {
type: 'Identifier',
name: 'React',
},
}).length > 0
)
}
const hasReactVariableUsage = (r) => {
return (
r.find(j.MemberExpression, {
object: {
type: 'Identifier',
name: 'React',
},
}).length > 0
)
}
if (hasReactImport(root)) {
return
}
if (hasReactVariableUsage(root)) {
addReactImport(j, root)
}
return root.toSource(options)
}