API Descriptions Update

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "mdn-content"]
+	path = mdn-content
+	url = https://github.com/mdn/content.git

README.md

@@ -88,7 +88,7 @@ If you are familiar with Web IDL, you may also want to check whether the upstrea
 - `overridingTypes.jsonc`: types that are defined in the spec but have TypeScript-friendly modifications in the json files.
 - `removedTypes.jsonc`: types that are defined in the spec but should be removed.
 - `comments.json`: comment strings to be embedded in the generated .js files.
-- `deprecatedMessage.json`: the reason why one type is deprecated. The reason why it is a separate file rather than merge in comment.json is mdn/apiDescriptions.json would also possibly be deprecated.
+
 
 ## Deployment to TypeScript
 

package.json

@@ -13,6 +13,7 @@
   ],
   "scripts": {
     "build": "tsc && node ./lib/build.js",
+    "generate": "tsc && node ./lib/generateDescriptions.js",
     "baseline-accept": "cpx \"generated\\**\" baselines\\",
     "lint": "eslint --max-warnings 0 src deploy/*.js && tsc -p deploy/jsconfig.json",
     "lint-fix": "eslint --max-warnings 0 src deploy/*.js --fix",

src/generateDescriptions.ts

@@ -0,0 +1,82 @@
+import { promises as fs } from "fs";
+import * as path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+function extractSummary(markdown: string) {
+  // Remove frontmatter (--- at the beginning)
+  markdown = markdown.replace(/^---[\s\S]+?---\n/, "");
+
+  // Split into lines and find the first meaningful paragraph
+  const lines = markdown.split("\n");
+  for (const line of lines) {
+    const trimmed = line.trim();
+    if (
+      trimmed &&
+      !trimmed.startsWith("#") &&
+      !trimmed.startsWith(">") &&
+      !trimmed.startsWith("{{")
+    ) {
+      // Remove bold (**text**), inline code (`text`), and links ([text](url))
+      return trimmed
+        .replace(/\*\*(.*?)\*\*/g, "$1") // Remove bold
+        .replace(/`(.*?)`/g, "$1") // Remove inline code
+        .replace(/\[([^\]]+)\]\([^)]+\)/g, "$1") // Remove links
+        .replace(/\{\{[^()]+\("([^"]+)"\)\}\}/g, "$1");
+    }
+  }
+
+  return "";
+}
+
+async function getFolders(dirPath: string) {
+  try {
+    const entries = await fs.readdir(dirPath, { withFileTypes: true });
+    const folders = entries
+      .filter((entry) => entry.isDirectory())
+      .map((entry) => path.join(dirPath, entry.name));
+    return folders;
+  } catch (error) {
+    console.error("Error reading directories:", error);
+    return [];
+  }
+}
+
+async function getIndexMdContents(folders: string[]) {
+  const results: { [key: string]: string } = {};
+
+  for (const folder of folders) {
+    const indexPath = path.join(folder, "index.md");
+
+    try {
+      const content = await fs.readFile(indexPath, "utf-8");
+      const titleMatch = content.match(/title: (.*)/);
+      const title = titleMatch ? titleMatch[1] : "";
+      const summary = extractSummary(content);
+      results[title] = summary;
+    } catch {
+      // Ignore missing index.md files
+    }
+  }
+
+  return results;
+}
+
+async function generateDescription() {
+  const basePath = path.resolve(
+    __dirname,
+    "../mdn-content/files/en-us/web/api",
+  );
+  const folders = await getFolders(basePath);
+  const data = await getIndexMdContents(folders);
+  // Write to JSON file
+  await fs.writeFile(
+    path.resolve(__dirname, "../inputfiles/mdn/") + "/apiDescriptions.json",
+    JSON.stringify(data, null, 2),
+    "utf-8",
+  );
+}
+
+await generateDescription();