fix(gatsby-plugin-sitemap): add meaningful error when siteUrl is missing #13123
Conversation
sbardian
changed the title
| if (!r.data.site.siteMetadata.siteUrl) { | ||
| throw new Error(`SiteMetaData 'siteUrl' property is required`) | ||
| } | ||
|
|
||
| if (r.data.site.siteMetadata.siteUrl) { |
There was a problem hiding this comment.
I guess we could remove this if around r.data.site.siteMetadata.siteUrl for removing trailing slashes as well? Happy to do it if you would like?
There was a problem hiding this comment.
it makes sense if we do throw earlier
| @@ -29,6 +29,10 @@ export const runQuery = (handler, query, excludes, pathPrefix) => | |||
| return page | |||
| }) | |||
|
|
|||
| if (!r.data.site.siteMetadata.siteUrl) { | |||
| throw new Error(`SiteMetaData 'siteUrl' property is required`) | |||
There was a problem hiding this comment.
What do you think about linking to https://www.gatsbyjs.org/packages/gatsby-plugin-sitemap/#how-to-use to see example configuration (to provide more context to error)
There was a problem hiding this comment.
Looked around for errors that reference links to docs, but didn't see any (swear I have before though)? If there is a standard format for this please let me know and I'll update it.
sbardian
force-pushed
the
topics/sitemap-siteUrl-missing
branch
from
3203019 to
06fb672
Compare
LekoArts
added
the
status: awaiting author response
wardpeet
changed the title
wardpeet
added
the
bot: merge on green
wardpeet
force-pushed
the
topics/sitemap-siteUrl-missing
branch
from
95af05a to
9f79efa
Compare
wardpeet
removed
the
status: awaiting author response
|
Ha! Was going to push a test for this this morning, thanks @wardpeet ! |
|
Published in |
Description
Throw a more descriptive error when users do not supply a
siteUrlproperty when usinggatsby-plugin-sitemapRelated Issues
Fixes #12912