fix(gatsby): log config validation errors #23620
Conversation
| linkPrefix: Joi.forbidden().error( | ||
| new Error(`"linkPrefix" should be changed to "pathPrefix"`) | ||
| ), |
There was a problem hiding this comment.
moved from
gatsby/packages/gatsby/src/redux/reducers/config.js
Lines 21 to 23 in 874088c
| const action = setSiteConfig({}) | ||
| expect(action.payload.pathPrefix).toBe(``) | ||
| }) | ||
| }) |
There was a problem hiding this comment.
Those are tests that previously were reducer tests adjusted to be action creator test (same scenarios)
| @@ -47,6 +47,9 @@ export interface IGatsbyConfig { | |||
| title?: string | |||
| author?: string | |||
| description?: string | |||
| sireUrl?: string | |||
| // siteMetadata is free form | |||
| [key: string]: unknown | |||
There was a problem hiding this comment.
I mean - in context of gatsby core it doesn't matter much, because core doesn't make use of those fields really
There was a problem hiding this comment.
But it might matter when we use those types for public index.d.ts declaration instead of hand written one like we do right now
There was a problem hiding this comment.
Yeah, doesn't matter at all
Just weird to see those
There was a problem hiding this comment.
I needed it here I think for tests in particular which were setting random thing (really random):
setSiteConfig({
someRandomThing: `hi people`,
plugins: [],
})
---edit - that was wrong example - see comment below
There was a problem hiding this comment.
above was wrong one - that one was failing - it was for this one:
const action = setSiteConfig({
siteMetadata: {
hi: true,
},
})
There was a problem hiding this comment.
someRandomThing: `hi people`
This is almost as good as your house is on fire
sidharthachatterjee
added
the
bot: merge on green
| @@ -47,6 +47,9 @@ export interface IGatsbyConfig { | |||
| title?: string | |||
| author?: string | |||
| description?: string | |||
| sireUrl?: string | |||
There was a problem hiding this comment.
typo here... siteUrl
--> #24488
Description
This fixes error that hides actual gatsby-config validation error.
It also converts config reducer to TS, adds typed action creator and converts validation error to structured one.
Before (
yarn build- this one was hiding actual error):Before (
gatsby build- this was "fine" - bit weirdly formatted - for the most part this PR just changes it to structured error in this case)After (both
yarn buildandgatsby build):Related Issues
Fixes: #22812
Helps with #23468 (doesn't fix it, but makes it easier to see actual error)