Change schema string | string[] properties to string[] (#3184)

Author: ddbeck

index.ts

@@ -137,6 +137,28 @@ for (const [key, data] of yamlEntries('features')) {
         data.kind = "feature";
     }
 
+    // Upgrade authored strings to arrays of 1
+    const optionalArrays = [
+        "spec",
+        "group",
+        "snapshot",
+        "caniuse",
+        "foo"
+    ];
+    const stringToStringArray = (value: string | string[]) => typeof value === "string" ? [value] : value;
+    for (const optionalArray of optionalArrays) {
+        const value = data[optionalArray];
+        if (value) {
+            data[optionalArray] = stringToStringArray(value);
+        }
+    }
+    if (data.discouraged) {
+        const value = data.discouraged.according_to;
+        if (value) {
+            data.discouraged.according_to = stringToStringArray(value);
+        }
+    }
+
     // Convert markdown to text+HTML.
     if (data.description) {
         const { text, html } = convertMarkdown(data.description);

packages/web-features/README.md

@@ -79,7 +79,7 @@ It has the following properties:
 - `name` (type: `string`): A plain-text human-readable name for the feature
 - `description` (type: `string`): A short plain-text description of the feature
 - `description_html` (type: `string`): A short HTML-formatted description of the feature
-- `spec` (type: `string | string[]`): A specification URL or an array of them
+- `spec` (type: `string[]`): A specification URL or an array of them
 - `status`: Support status data.
   It has the following properties:
 
@@ -91,9 +91,9 @@ It has the following properties:
     Keys are one of: `"chrome"`, `"chrome_android"`, `"edge"`, `"firefox"`, `"firefox"`, `"firefox_android"`, `"safari"`, `"safari_ios"`.
     Each value is a `string` containing the version number.
 
-- `group` (optional, type: `string | string[]`): A `groups` key or an array of them
-- `snapshot` (optional, type: `string | string[]`): A `snapshots` key or an array of them
-- `caniuse` (optional, type: `string | string[]`): A caniuse feature ID that corresponds to the current feature, or an array of them.
+- `group` (optional, type: `string[]`): A `groups` key or an array of them
+- `snapshot` (optional, type: `string[]`): A `snapshots` key or an array of them
+- `caniuse` (optional, type: `string[]`): A caniuse feature ID that corresponds to the current feature, or an array of them.
   Use it to look up caniuse data from a package like [`caniuse-lite`](https://www.npmjs.com/package/caniuse-lite) or construct a URL to a page on caniuse.com.
 - `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.

schemas/data.schema.json

@@ -81,7 +81,7 @@
       "properties": {
         "according_to": {
           "description": "Links to a formal discouragement notice, such as specification text, intent-to-unship, etc.",
-          "$ref": "#/definitions/URLs"
+          "$ref": "#/definitions/Strings"
         },
         "alternatives": {
           "description": "IDs for features that substitute some or all of this feature's utility",
@@ -129,20 +129,20 @@
           "type": "string"
         },
         "spec": {
-          "description": "Specification URL(s)",
-          "$ref": "#/definitions/URLOrURLs"
+          "description": "Specification URLs",
+          "$ref": "#/definitions/Strings"
         },
         "group": {
-          "description": "Group identifier(s)",
-          "$ref": "#/definitions/StringOrStrings"
+          "description": "Group identifiers",
+          "$ref": "#/definitions/Strings"
         },
         "snapshot": {
-          "description": "Snapshot identifier(s)",
-          "$ref": "#/definitions/StringOrStrings"
+          "description": "Snapshot identifiers",
+          "$ref": "#/definitions/Strings"
         },
         "caniuse": {
-          "description": "caniuse.com identifier(s)",
-          "$ref": "#/definitions/StringOrStrings"
+          "description": "caniuse.com identifiers",
+          "$ref": "#/definitions/Strings"
         },
         "compat_features": {
           "description": "Sources of support data for this feature",
@@ -308,50 +308,12 @@
       "required": ["baseline", "support"],
       "additionalProperties": false
     },
-    "StringOrStrings": {
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "minItems": 2
-        }
-      ]
-    },
     "Strings": {
       "type": "array",
       "items": {
         "type": "string"
       },
       "minItems": 1
-    },
-    "URL": {
-      "type": "string"
-    },
-    "URLs": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "minItems": 1
-    },
-    "URLOrURLs": {
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "minItems": 2
-        }
-      ]
     }
   }
 }

types.quicktype.ts

@@ -67,9 +67,9 @@ export interface Release {
  */
 export interface FeatureData {
   /**
-   * caniuse.com identifier(s)
+   * caniuse.com identifiers
    */
-  caniuse?: string[] | string;
+  caniuse?: string[];
   /**
    * Sources of support data for this feature
    */
@@ -87,22 +87,22 @@ export interface FeatureData {
    */
   discouraged?: Discouraged;
   /**
-   * Group identifier(s)
+   * Group identifiers
    */
-  group?: string[] | string;
+  group?: string[];
   kind: Kind;
   /**
    * Short name
    */
   name?: string;
   /**
-   * Snapshot identifier(s)
+   * Snapshot identifiers
    */
-  snapshot?: string[] | string;
+  snapshot?: string[];
   /**
-   * Specification URL(s)
+   * Specification URLs
    */
-  spec?: string[] | string;
+  spec?: string[];
   /**
    * Whether a feature is considered a "Baseline" web platform feature and when it achieved
    * that status

types.ts

@@ -90,7 +90,7 @@ const goodFeatureData: FeatureData = {
   name: "Test",
   description: "Hi",
   description_html: "Hi",
-  spec: "",
+  spec: [""],
   status: {
     baseline: false,
     support: {},