Skip to content

Commit

Permalink
codemod: leave comment on spread props (#70979)
Browse files Browse the repository at this point in the history
  • Loading branch information
huozhi authored and kdy1 committed Oct 10, 2024
1 parent f81e860 commit 836125b
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
interface Props {
params: {
slug: string;
}
}

export function generateMetadata(props: Props, parent: any) {
console.log({ ...parent })
}

export default async function Page(props: Props) {
const config = { ...props }
return (
<Child {...props} {...config} />
)
}

export function GET(req, ctx) {
console.log(
{ ...ctx }
)
}

export function POST(req, ctx) {
console.log(
{ ...req }
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
interface Props {
params: Promise<{
slug: string;
}>
}

export function generateMetadata(props: Props, parent: any) {
console.log({ ...parent })
}

export default async function Page(props: Props) {
const config = { /* Next.js Dynamic Async API Codemod: 'props' is used with spread syntax (...). Any asynchronous properties of 'props' must be awaited when accessed. */
...props }
return (
(<Child /* Next.js Dynamic Async API Codemod: 'props' is used with spread syntax (...). Any asynchronous properties of 'props' must be awaited when accessed. */
{...props} {...config} />)
);
}

export function GET(req, ctx) {
console.log(
{ /* Next.js Dynamic Async API Codemod: 'ctx' is used with spread syntax (...). Any asynchronous properties of 'ctx' must be awaited when accessed. */
...ctx }
)
}

export function POST(req, ctx) {
console.log(
{ ...req }
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,13 @@ export function transformDynamicProps(
// Override the first param to `props`
params[propsArgumentIndex] = propsIdentifier

modified = true
}
} else {
// When the prop argument is not destructured, we need to add comments to the spread properties
if (j.Identifier.check(currentParam)) {
commentSpreadProps(path, currentParam.name, j)
modifyTypes(currentParam.typeAnnotation, propsIdentifier, root, j)
modified = true
}
}
Expand Down Expand Up @@ -812,3 +819,30 @@ function findAllTypes(

return types
}

function commentSpreadProps(
path: ASTPath<FunctionScope>,
propsIdentifierName: string,
j: API['jscodeshift']
) {
const functionBody = findFunctionBody(path)
const functionBodyCollection = j(functionBody)
// Find all the usage of spreading properties of `props`
const jsxSpreadProperties = functionBodyCollection.find(
j.JSXSpreadAttribute,
{ argument: { name: propsIdentifierName } }
)
const objSpreadProperties = functionBodyCollection.find(j.SpreadElement, {
argument: { name: propsIdentifierName },
})
const comment = ` Next.js Dynamic Async API Codemod: '${propsIdentifierName}' is used with spread syntax (...). Any asynchronous properties of '${propsIdentifierName}' must be awaited when accessed. `

// Add comment before it
jsxSpreadProperties.forEach((spread) => {
insertCommentOnce(spread.value, j, comment)
})

objSpreadProperties.forEach((spread) => {
insertCommentOnce(spread.value, j, comment)
})
}

0 comments on commit 836125b

Please sign in to comment.