Merge data.extended.json into data.json (#3341)

Author: rviscomi

.github/workflows/publish_next_web-features.yml

@@ -51,7 +51,6 @@ jobs:
       - run: npm ci
 
       - run: npm run build
-      - run: npm run build:extended
 
       - name: Get package.json version
         id: version
@@ -108,4 +107,3 @@ jobs:
           ARTIFACTS: >
             schemas/data.schema.json
             ${{ env.package_dir }}/data.json
-            data.extended.json

.github/workflows/publish_web-features.yml

@@ -33,8 +33,7 @@ jobs:
           registry-url: "https://registry.npmjs.org"
       - run: npm ci
       - run: npm run build
-      - run: npm run build:extended
-      - run: gh release upload ${{ github.ref_name }} packages/web-features/data.json schemas/data.schema.json data.extended.json
+      - run: gh release upload ${{ github.ref_name }} packages/web-features/data.json data.extended.json schemas/data.schema.json
         env:
           GH_TOKEN: ${{ github.token }}
   publish:

index.ts

@@ -7,7 +7,7 @@ import YAML from 'yaml';
 import { convertMarkdown } from "./text";
 import { GroupData, SnapshotData, WebFeaturesData } from './types';
 
-import { BASELINE_LOW_TO_HIGH_DURATION, coreBrowserSet, parseRangedDateString } from 'compute-baseline';
+import { BASELINE_LOW_TO_HIGH_DURATION, coreBrowserSet, parseRangedDateString, getStatus } from 'compute-baseline';
 import { Compat } from 'compute-baseline/browser-compat-data';
 import { assertValidFeatureReference } from './assertions';
 import { isMoved, isSplit } from './type-guards';
@@ -209,6 +209,14 @@ for (const [key, data] of yamlEntries('features')) {
                 bcdToFeatureId.set(bcdKey, key);
             }
         }
+
+        // Generate by_compat_key data.
+        if (data.status) {
+            data.status.by_compat_key = {};
+            for (const bcdKey of data.compat_features) {
+                data.status.by_compat_key[bcdKey] = getStatus(key, bcdKey);
+            }
+        }
     }
 
     features[key] = data;

package.json

@@ -17,7 +17,6 @@
   },
   "scripts": {
     "audit-consumers": "tsx scripts/audit-consumers.ts",
-    "build:extended": "tsx scripts/build.ts extended-json",
     "build": "tsx scripts/build.ts package",
     "dist": "tsx scripts/dist.ts",
     "undist": "tsx scripts/undist.ts",

packages/web-features/README.md

@@ -66,9 +66,9 @@ Most values are ordinary feature objects with names, descriptions, and other dat
 Some features contain redirects to other features.
 You can distinguish between ordinary feature objects and redirects by using the `kind` property:
 
-* `"feature"` — ordinary features  
-* `"moved"` — the feature has a redirect to a new key
-* `"split"` — the feature has a redirect to two or more keys
+- `"feature"` — ordinary features
+- `"moved"` — the feature has a redirect to a new key
+- `"split"` — the feature has a redirect to two or more keys
 
 ### Feature objects
 
@@ -82,14 +82,16 @@ It has the following properties:
 - `spec` (type: `string[]`): A specification URL or an array of them
 - `status`: Support status data.
   It has the following properties:
-
   - `baseline` (type: `"high" | "low" | false`): Whether the feature Baseline widely available, Baseline newly available, or not Baseline
   - `baseline_low_date` (optional, type: `string`): When the feature reached Baseline newly available status
   - `baseline_high_date` (optional, type: `string`): When the feature reached Baseline widely available status
   - `support`: An object representing per-browser support information, showing the version number where each browser first started to support that feature.
     All keys are optional.
     Keys are one of: `"chrome"`, `"chrome_android"`, `"edge"`, `"firefox"`, `"firefox"`, `"firefox_android"`, `"safari"`, `"safari_ios"`.
     Each value is a `string` containing the version number.
+  - `by_compat_key` (optional, type: `object`): An object mapping each compat key from the feature's `compat_features` array to its individual support status data.
+    Each value follows the same structure as the main `status` object, with `baseline`, `baseline_low_date`, `baseline_high_date`, and `support` properties.
+    Only present for features that have `compat_features`.
 
 - `group` (optional, type: `string[]`): A `groups` key or an array of them
 - `snapshot` (optional, type: `string[]`): A `snapshots` key or an array of them
@@ -98,7 +100,6 @@ It has the following properties:
 - `compat_features` (optional, type: `string[]`): An array of `@mdn/browser-compat-data` feature key strings.
 - `discouraged` (optional): An object indicating that web developers should avoid using the feature.
   It has the following properties:
-
   - `according_to` (type: `string[]`): One or more links to a formal discouragement notice, such as specification text or an intent-to-unship
   - `alternatives` (optional, type: `string[]`): One or more feature IDs (as in `features[alternatives[0]]`) that substitute some or all of this feature's utility
 

schemas/data.schema.json

@@ -298,7 +298,7 @@
         "baseline_low_date": {},
         "support": {},
         "by_compat_key": {
-          "description": "Statuses for each key in the feature's compat_features list, if applicable. Not available to the npm release of web-features.",
+          "description": "Statuses for each key in the feature's compat_features list, if applicable.",
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/Status"

scripts/build.ts

@@ -1,13 +1,11 @@
 import { DefinedError } from "ajv";
-import { getStatus } from "compute-baseline";
 import stringify from "fast-json-stable-stringify";
 import { execSync } from "node:child_process";
 import fs from "node:fs";
 import { basename } from "node:path";
 import winston from "winston";
 import yargs from "yargs";
 import * as data from "../index.js";
-import { isOrdinaryFeatureData } from "../type-guards.js";
 import { validate } from "./validate.js";
 
 const logger = winston.createLogger({
@@ -27,11 +25,6 @@ yargs(process.argv.slice(2))
     describe: "Generate the web-features npm package",
     handler: buildPackage,
   })
-  .command({
-    command: "extended-json",
-    describe: "Generate a web-features JSON file with BCD per-key statuses",
-    handler: buildExtendedJSON,
-  })
   .parseSync();
 
 function buildPackage() {
@@ -51,6 +44,11 @@ function buildPackage() {
   const json = stringify(data);
   const path = new URL("data.json", packageDir);
   fs.writeFileSync(path, json);
+
+  // TODO: Remove the extended data artifact in the next major release.
+  const extendedPath = new URL("data.extended.json", rootDir);
+  fs.writeFileSync(extendedPath, json);
+
   for (const file of filesToCopy) {
     fs.copyFileSync(
       new URL(file, rootDir),
@@ -67,32 +65,6 @@ function buildPackage() {
   });
 }
 
-function buildExtendedJSON() {
-  for (const [id, featureData] of Object.entries(data.features)) {
-    if (!isOrdinaryFeatureData(featureData)) {
-      continue;
-    }
-
-    if (
-      Array.isArray(featureData.compat_features) &&
-      featureData.compat_features.length &&
-      featureData.status
-    ) {
-      featureData.status.by_compat_key = {};
-      for (const key of featureData.compat_features) {
-        featureData.status.by_compat_key[key] = getStatus(id, key);
-      }
-    }
-  }
-
-  if (!valid(data)) {
-    logger.error("Data failed schema validation. No JSON file written.");
-    process.exit(1);
-  }
-
-  fs.writeFileSync(new URL("./data.extended.json", rootDir), stringify(data));
-}
-
 function valid(data: any): boolean {
   const valid = validate(data);
   if (!valid) {

types.quicktype.ts

@@ -153,8 +153,7 @@ export interface StatusHeadline {
    */
   baseline_low_date?: string;
   /**
-   * Statuses for each key in the feature's compat_features list, if applicable. Not available
-   * to the npm release of web-features.
+   * Statuses for each key in the feature's compat_features list, if applicable.
    */
   by_compat_key?: { [key: string]: Status };
   /**