Allow use of Markdown in description and notes

lint/linter/test-descriptions.ts

@@ -66,23 +66,23 @@ const processApiData = (
       'constructor',
       path,
       data,
-      `<code>${apiName}()</code> constructor`,
+      `\`${apiName}()\` constructor`,
       errors,
     );
   } else if (featureName.endsWith('_event')) {
     checkDescription(
       'event',
       path,
       data,
-      `<code>${featureName.replace('_event', '')}</code> event`,
+      `\`${featureName.replace('_event', '')}\` event`,
       errors,
     );
   } else if (featureName.endsWith('_permission')) {
     checkDescription(
       'permission',
       path,
       data,
-      `<code>${featureName.replace('_permission', '')}</code> permission`,
+      `\`${featureName.replace('_permission', '')}\` permission`,
       errors,
     );
   } else if (featureName == 'secure_context_required') {
@@ -150,7 +150,7 @@ export default {
 
     for (const error of errors) {
       if (typeof error === 'string') {
-        logger.error(chalk`Description → ${error}`);
+        logger.error(chalk`{red ${error}}`);
       } else {
         logger.error(
           chalk`{red Incorrect ${error.ruleName} description for {bold ${error.path}}

lint/linter/test-notes.ts

@@ -3,6 +3,7 @@
 
 import chalk from 'chalk-template';
 import HTMLParser from '@desertnet/html-parser';
+import { marked } from 'marked';
 
 import { Linter, Logger, LinterData, VALID_ELEMENTS } from '../utils.js';
 import {
@@ -68,11 +69,12 @@ const testNode = (node): string[] => {
  */
 export const validateHTML = (string: string): string[] => {
   const errors: string[] = [];
-  const htmlErrors = HTMLParser.validate(string);
+  const html = marked.parseInline(string);
+  const htmlErrors = HTMLParser.validate(html);
 
   if (htmlErrors.length === 0) {
     // If HTML is valid, ensure we're only using valid elements
-    errors.push(...testNode(parser.parse(string)));
+    errors.push(...testNode(parser.parse(html)));
   } else {
     errors.push(
       chalk`Invalid HTML: ${htmlErrors.map((x) => x._message).join(', ')}`,

package.json

@@ -82,6 +82,7 @@
     "husky": "^9.0.2",
     "json-schema-to-typescript": "~14.1.0",
     "lint-staged": "^15.0.1",
+    "marked": "^11.0.0",
     "mocha": "~10.6.0",
     "open-cli": "~8.0.0",
     "ora": "~8.0.1",

scripts/build/index.ts

@@ -6,6 +6,7 @@ import fs from 'node:fs/promises';
 import esMain from 'es-main';
 import stringify from 'fast-json-stable-stringify';
 import { compareVersions } from 'compare-versions';
+import { marked } from 'marked';
 
 import { InternalSupportStatement } from '../../types/index.js';
 import { BrowserName, CompatData, VersionValue } from '../../types/types.js';
@@ -36,6 +37,18 @@ export const generateMeta = (): any => ({
   timestamp: new Date(),
 });
 
+/**
+ * Converts Markdown to HTML and sanitizes output
+ * @param {string | string[]} markdown The Markdown to convert
+ * @returns {string | string[]} The HTML output
+ */
+const mdToHtml = (markdown: string): string => {
+  // "as string" cast because TS thinks response could be a promise
+  return (marked.parseInline(markdown) as string)
+    .replace(/'/g, "'")
+    .replace(/"/g, '"');
+};
+
 /**
  * Apply mirroring to a feature
  * @param feature The BCD to perform mirroring on
@@ -109,6 +122,44 @@ export const addVersionLast = (feature: WalkOutput): void => {
   }
 };
 
+/**
+ * Convert descriptions and notes from Markdown to HTML
+ * @param {WalkOutput} feature The BCD to perform mirroring on
+ * @returns {void}
+ */
+export const transformMD = (feature: WalkOutput): void => {
+  if ('description' in feature.data.__compat) {
+    feature.data.__compat.description = mdToHtml(
+      feature.data.__compat.description,
+    );
+  }
+
+  for (const [browser, supportData] of Object.entries(
+    feature.compat.support as InternalSupportStatement,
+  )) {
+    if (!supportData) continue;
+
+    if (Array.isArray(supportData)) {
+      for (let i = 0; i < supportData.length; i++) {
+        if ('notes' in supportData[i]) {
+          (feature.data as any).__compat.support[browser][i].notes =
+            Array.isArray(supportData[i].notes)
+              ? supportData[i].notes.map((md) => mdToHtml(md))
+              : mdToHtml(supportData[i].notes);
+        }
+      }
+    } else if (typeof supportData === 'object') {
+      if ('notes' in supportData) {
+        (feature.data as any).__compat.support[browser].notes = Array.isArray(
+          (supportData as any).notes,
+        )
+          ? (supportData as any).notes.map((md) => mdToHtml(md))
+          : mdToHtml((supportData as any).notes);
+      }
+    }
+  }
+};
+
 /**
  * Applies transforms to the given data.
  * @param data - The data to apply transforms to.
@@ -119,6 +170,7 @@ export const applyTransforms = (data): void => {
   for (const feature of walker) {
     applyMirroring(feature);
     addVersionLast(feature);
+    transformMD(feature);
   }
 };