fix: improve error handling for missing @payload-config path alias #9798
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.
Description
Currently, when the
@payload-configpath alias is missing from tsconfig.json, the package fails with a cryptic error when running commands such as generate:types or generate:importmap:This happens because configPath becomes undefined when the path alias is missing, which later causes a path resolution error. This PR improves error handling to provide clearer feedback.
Changes
Added explicit error handling when @payload-config path alias is missing
Added descriptive error message to guide users on how to fix the issue
Added fallback to default configuration path (./src/payload.config.ts)
Related Issue
Closes #9796