core(tsc): type check config files #5858
Conversation
| @@ -19,6 +20,7 @@ module.exports = { | |||
| audits: [ | |||
| 'byte-efficiency/unused-javascript', | |||
| ], | |||
| // @ts-ignore TODO(bckenny): type extended Config where e.g. category.title isn't required | |||
There was a problem hiding this comment.
If a config is extending another one, there's no reason for it to have anything in particular defined, so maybe these could be RecursivePartial<LH.Config.Json>, but we don't want to apply that to e.g. defaultConfig. So we'll have to figure out a good way to conditionally apply it another day.
There was a problem hiding this comment.
Maybe we have to split the full config typedef from the valid config typedef?
There was a problem hiding this comment.
Maybe we have to split the full config typedef from the valid config typedef?
yeah, that seems like that might be the only decent way to do it without making the full config typedef useless
| @@ -19,6 +20,7 @@ module.exports = { | |||
| audits: [ | |||
| 'byte-efficiency/unused-javascript', | |||
| ], | |||
| // @ts-ignore TODO(bckenny): type extended Config where e.g. category.title isn't required | |||
There was a problem hiding this comment.
Maybe we have to split the full config typedef from the valid config typedef?
This was flagged testing the typescript nightly against the current code base.
LH.Config.Category.descriptionandLH.Config.Group.descriptionshould both be optional as they are in the LHR, andLH.Config.Category.manualDescriptionshould also exist.Also adds type annotations to the files themselves so that they're checked directly, rather than indirectly through their use in
config.js.