Warn when getStaticPaths exists without a prerender statement
#7713
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 13fa4f4 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
natemoo-re
commented
Jul 18, 2023
Comment on lines
-35
to
-41
| if (ssr && mod.getStaticPaths && !route.prerender) { | ||
| warn( | ||
| logging, | ||
| 'getStaticPaths', | ||
| `getStaticPaths() in ${bold(route.component)} is ignored when "output: server" is set.` | ||
| ); | ||
| } |
There was a problem hiding this comment.
Instead of checking this at runtime like we do here...
Comment on lines
43
to
47
|
|
||
| // `getStaticPaths` warning is just a string check, should be good enough for most cases | ||
| if (!pageOptions.prerender && isServerLikeOutput(settings.config) && code.includes('getStaticPaths')) { | ||
| warn(logging, "getStaticPaths", `The getStaticPaths() statement in ${bold(rootRelativePath(settings.config.root, fileURL, true))} has been ignored.\n\nAdd \`export const prerender = true;\` to prerender this page.`); | ||
| } |
There was a problem hiding this comment.
This check has been moved to compile time (in our astroScannerPlugin).
There was a problem hiding this comment.
Updated this one per @sarah11918's feedback that mentioning output: "${mode}" would be helpful.
bluwy
approved these changes
Jul 19, 2023
delucis
approved these changes
Jul 19, 2023
matthewp
approved these changes
Jul 19, 2023
Merged
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.
Changes
getStaticPathsexisting withoutprerender.dev. Now the warning happens atcompiletime duringdevandbuild.server | hybridoutputs.Testing
We don't have (reliable) tests for CLI logs, unfortunately
Tested manually
Docs
cc @withastro/maintainers-docs for feedback on the warning message. These warnings aren't something we document like our errors, but they are user-facing!
Before
After