Add extended JSON file build output #1407
Conversation
scripts/build.ts
Outdated
| @@ -39,3 +45,25 @@ function buildPackage() { | |||
| encoding: "utf-8", | |||
| }); | |||
| } | |||
|
|
|||
| function buildExtendedJSON() { | |||
| // TODO: Validate the resulting JSON against a schema. | |||
There was a problem hiding this comment.
Can you do this locally? I suspect that it doesn't match the schema. See below.
scripts/build.ts
Outdated
| const by_compat_key = {}; | ||
|
|
||
| for (const key of featureData.compat_features) { | ||
| by_compat_key[key] = { status: getStatus(id, key) }; |
There was a problem hiding this comment.
I think this has to be unwrapped to match the schema:
| by_compat_key[key] = { status: getStatus(id, key) }; | |
| by_compat_key[key] = getStatus(id, key); |
| "build": "tsx scripts/build.ts package", | ||
| "dist": "tsx scripts/dist.ts", | ||
| "feature-init": "tsx scripts/feature-init.ts", | ||
| "format": "npx prettier --write .", | ||
| "schema:write": "npm run schema -- --out ./schemas/data.schema.json", | ||
| "schema": "ts-json-schema-generator --tsconfig ./tsconfig.json --path ./types.ts", | ||
| "schema": "ts-json-schema-generator --tsconfig ./tsconfig.json --path ./types.ts --type=WebFeaturesData", |
There was a problem hiding this comment.
This bit is pretty serious:
I figured out what that top-level $ref was for. Without it, it was just a list of definitions without asserting anything using those definitions. Without this option, any object will pass validation against our schema. 🙄
| if (!valid(data)) { | ||
| logger.error("Data failed schema validation. No package built."); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| const json = stringify(data); | ||
| // TODO: Validate the resulting JSON against a schema. |
There was a problem hiding this comment.
Since I had to figure out how to validate the built JSON against the schema for the extended JSON, I did the same for the packaged one.
| if (!valid) { | ||
| // TODO: turn on strictNullChecks, fix all the errors, and replace this with: | ||
| // const errors = validate.errors; | ||
| const errors = (valid as any).errors as DefinedError[]; |
There was a problem hiding this comment.
This is a bit ugly because ajv can't produce (useful) types without strictNullChecks set to true in tsconfig.json. Fixable, but it requires touching a dozen files not germane to this PR.
| export function validate(data: any) { | ||
| const ajv = new Ajv({ allErrors: true, allowUnionTypes: true }); |
There was a problem hiding this comment.
I consolidated compiling the schema here, so that we can have one place with settings (and to check that we don't do something foolish like validate nothing at all).
This is a step toward #685 and #1316.
Unlike the regular npm package, this artifact includes computed statuses for each compat key, if a feature has a
statusandcompat_features. This has also been known casually as the "fat" JSON artifact. This is intended for consumers that cannot or do not wish to usecompute-baseline.To make this artifact, use
npm run build:extended.