docs: clarify "type": "module" requirement for type generation in Next.js projects #13282
+14
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t.js projects This update adds a dedicated section under the "Types generation script" heading to explain an issue commonly encountered by users working with Payload in a default Next.js setup. When running `payload generate:types`, users may face an error due to the absence of the "type": "module" field in their package.json file. This is because the type generation script relies on ECMAScript Module (ESM) resolution, which is not enabled by default in most Next.js configurations. The new documentation helps users identify and resolve this issue by explicitly instructing them to add `"type": "module"` to their package.json. This change aims to prevent developer frustration and reduce support questions around broken type generation workflows. Also ensures the documentation aligns better with the expectations of modern TypeScript + Next.js users integrating Payload CMS in their stacks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This update adds a dedicated section under the "Types generation script" heading to explain an issue commonly encountered by users working with Payload in a default Next.js setup.
Problem
When running:
users may face an error due to the absence of the
"type": "module"field in theirpackage.jsonfile. This happens because the type generation script relies on ECMAScript Module (ESM) resolution, which is not enabled by default in most Next.js configurations.Solution
The documentation now explicitly instructs users to add
"type": "module"to theirpackage.jsonfile. This:Why it matters
This small clarification ensures that new users integrating Payload CMS into Next.js projects have a smoother experience when generating types, without hitting unnecessary roadblocks.