feat: move InitialOptions to JSON schema
#14776
Conversation
✅ Deploy Preview for jestjs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
| Type.Object({ | ||
| global: RawCoverageThresholdValue, | ||
| }), | ||
| // TODO: is there a better way of doing index type? |
There was a problem hiding this comment.
this is currently
type CoverageThreshold = {
[path: string]: CoverageThresholdValue;
global: CoverageThresholdValue;
};I don't think my current approach is the correct "translation" of that, but it seems to work in practice
There was a problem hiding this comment.
Hi @SimenB!
The above type would represent the TS data structure (both validation and inference). However the allOf representation could be a consideration if publishing (as it would require downstream tooling to be able to enumerate properties of the intersection)
There is another way to represent this type, which would ensure it remains an "object" type.
const RawCoverageThreshold = Type.Object({
global: RawCoverageThresholdValue, // global: RawCoverageThresholdValue
}, {
additionalProperties: RawCoverageThresholdValue // [path: string]: RawCoverageThresholdValue
})TypeBox does not support auto inference for additionalProperties of TSchema, But it is possible to wrap in Unsafe which allows you to specify the correct inference type.
const RawCoverageThresholdBase = Type.Object({
global: RawCoverageThresholdValue,
}, {
additionalProperties: RawCoverageThresholdValue
})
const RawCoverageThreshold = Type.Unsafe<{
global: Static<typeof RawCoverageThresholdValue>,
[path: string]: Static<typeof RawCoverageThresholdValue>
}>(RawCoverageThresholdBase)It's also possible to pass Unsafe arbitrary JSON Schema + Type if you need specific representations outside the ones provided by TypeBox.
Hope this helps! :)
| '\n\nThe default is `[]`, meaning all APIs are faked.', | ||
| default: [], | ||
| }), | ||
| now: Type.Union([Type.Integer({minimum: 0}), Type.Date()], { |
There was a problem hiding this comment.
Would recommend removing Type.Date() as this type is a JS extension type in TB (so would be unknown to Ajv). But could represent as the following.
Type.Object({
// ...
now: Type.Unsafe<number|Date>(Type.Integer({minimum: 0}))
})This would ensure that now be integer only, but with the type suggesting a potential for the property to converted into a Date object. Have a quick read over the TB Transform feature as this may be able to automatically transform values like this on value load, something that could potentially be run post successful Ajv validate.
There was a problem hiding this comment.
we already do work to make the type different from config input and usage at runtime:
jest/packages/jest-types/src/Config.ts
Lines 96 to 102 in e20a4be
And yeah, plugging the schema and its defaults with transformers into our normalize function is a long term plan 🙂
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Summary
Part of #11963. I think with this, we can look into writing the resulting schema to disk and somehow publish it. Maybe as part of the website?
@sinclairzx81 FYI 🙂 Any and all suggestions here very much welcome 👍
Test plan
Green CI