Move draft features into a special directory (#1180)

foolip · web-flow · commit f1ebf697e6d0 · 2024-06-05T13:41:48.000+02:00
This is to prepare for a large number of generated draft features,
which we'll put in features/draft/generated/.
diff --git a/features/draft/README.md b/features/draft/README.md
@@ -0,0 +1,12 @@
+# Draft features
+
+This directory is for draft features which are not yet ready to be published as
+part of web-features. Draft features can be used for:
+
+- Features where the specification is not yet complete.
+- Features that have not yet shipped in any browser.
+- Definitions that need further editorial review, and are made available as
+  drafts as a way to invite contributions through such review.
+
+Draft features must have a `draft_date` field, and draft features more than 1
+year old with no sign of progress may be deleted.
diff --git a/features/draft/file-and-directory-entries.dist.yml b/features/draft/file-and-directory-entries.dist.yml
@@ -1,8 +1,7 @@
 # Generated from: file-and-directory-entries.yml
 # Do not edit this file by hand. Edit the source file instead!
 
-draft: true
-draft_on: 2024-05-07
+draft_date: 2024-05-07
 name: File and directory entries
 description: File and directory entries represent a virtual file system for working with files and directories dragged and dropped into the browser.
 spec: https://wicg.github.io/entries-api/
diff --git a/features/draft/file-and-directory-entries.yml b/features/draft/file-and-directory-entries.yml
@@ -1,5 +1,4 @@
-draft: true
-draft_on: 2024-05-07
+draft_date: 2024-05-07
 name: File and directory entries
 description: File and directory entries represent a virtual file system for working with files and directories dragged and dropped into the browser.
 spec: https://wicg.github.io/entries-api/
diff --git a/features/draft/scroll-marker.dist.yml b/features/draft/scroll-marker.dist.yml
@@ -2,6 +2,5 @@
 # Do not edit this file by hand. Edit the source file instead!
 
 # https://github.com/flackr/carousel/tree/main/scroll-marker
-draft: true
 draft_date: 2024-04-30
 name: "::scroll-marker"
diff --git a/features/draft/scroll-marker.yml b/features/draft/scroll-marker.yml
@@ -1,4 +1,3 @@
 # https://github.com/flackr/carousel/tree/main/scroll-marker
-draft: true
 draft_date: 2024-04-30
 name: "::scroll-marker"
diff --git a/features/draft/selectlist.dist.yml b/features/draft/selectlist.dist.yml
@@ -1,7 +1,6 @@
 # Generated from: selectlist.yml
 # Do not edit this file by hand. Edit the source file instead!
 
-draft: true
 draft_date: 2024-05-06
 name: "<selectlist>"
 caniuse: selectlist
diff --git a/features/draft/selectlist.yml b/features/draft/selectlist.yml
@@ -1,4 +1,3 @@
-draft: true
 draft_date: 2024-05-06
 name: "<selectlist>"
 caniuse: selectlist
diff --git a/features/draft/speech-recognition.dist.yml b/features/draft/speech-recognition.dist.yml
@@ -3,7 +3,6 @@
 
 # Speech recognition is prefixed in all implementations and would appear as
 # unsupported, so don't publish it. Revisit if it's unprefixed.
-draft: true
 draft_date: 2024-04-30
 name: Speech recognition
 description: The `SpeechRecognition` API converts human speech from a microphone to text.
diff --git a/features/draft/speech-recognition.yml b/features/draft/speech-recognition.yml
@@ -1,6 +1,5 @@
 # Speech recognition is prefixed in all implementations and would appear as
 # unsupported, so don't publish it. Revisit if it's unprefixed.
-draft: true
 draft_date: 2024-04-30
 name: Speech recognition
 description: The `SpeechRecognition` API converts human speech from a microphone to text.
diff --git a/features/draft/text-box-trim.dist.yml b/features/draft/text-box-trim.dist.yml
@@ -2,7 +2,6 @@
 # Do not edit this file by hand. Edit the source file instead!
 
 # TODO: Publish when supported by some browser.
-draft: true
 draft_date: 2024-04-30
 name: text-box-trim
 description: The `text-box-trim` CSS property removes the additional space above and below text which is normally reserved for ascenders and descenders.
diff --git a/features/draft/text-box-trim.yml b/features/draft/text-box-trim.yml
@@ -1,5 +1,4 @@
 # TODO: Publish when supported by some browser.
-draft: true
 draft_date: 2024-04-30
 name: text-box-trim
 description: The `text-box-trim` CSS property removes the additional space above and below text which is normally reserved for ascenders and descenders.
diff --git a/index.ts b/index.ts
@@ -20,6 +20,10 @@ const nameMaxLength = 80;
 // The longest description allowed, to avoid them growing into documentation.
 const descriptionMaxLength = 300;
 
+// Internal symbol to mark draft entries, so that using the draft field outside
+// of a draft directory doesn't work.
+const draft = Symbol('draft');
+
 // Some FeatureData keys aren't (and may never) be ready for publishing.
 // They're not part of the public schema (yet).
 const omittables = [
@@ -49,6 +53,10 @@ function* yamlEntries(root: string): Generator<[string, any]> {
         const src = fs.existsSync(dist) ? fs.readFileSync(dist, { encoding: 'utf-8'}) : fs.readFileSync(fp, { encoding: 'utf-8'});
         const data = YAML.parse(src);
 
+        if (fp.split(path.sep).includes('draft')) {
+            data[draft] = true;
+        }
+
         yield [key, data];
     }
 }
@@ -116,7 +124,10 @@ const bcdToFeatureId: Map<string, string> = new Map();
 const features: { [key: string]: FeatureData } = {};
 for (const [key, data] of yamlEntries('features')) {
     // Draft features reserve an identifier but aren't complete yet. Skip them.
-    if (data.draft) {
+    if (data[draft]) {
+        if (!data.draft_date) {
+            throw new Error(`The draft feature ${key} is missing the draft_date field. Set it to the current date.`);
+        }
         continue;
     }
 
diff --git a/package.json b/package.json
@@ -22,7 +22,7 @@
     "schema-defs:write": "npm run schema-defs -- --out ./schemas/defs.schema.json",
     "test": "npm run test:caniuse -- --quiet && npm run test:schema && npm run test:specs && npm run test:format && npm run test:dist && npm run test --workspaces",
     "test:caniuse": "tsx scripts/caniuse.ts",
-    "test:dist": "tsx scripts/dist.ts --check features/*.dist.yml",
+    "test:dist": "tsx scripts/dist.ts --check features/**/*.dist.yml",
     "test:schema": "tsx scripts/schema.ts",
     "test:specs": "tsx scripts/specs.ts",
     "test:format": "prettier --check .",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-draft: true`
`2`	`1`	`draft_date: 2024-05-06`
`3`	`2`	`name: "<selectlist>"`
`4`	`3`	`caniuse: selectlist`