respec 35.9.0 → 37.0.0

package/builds/respec-worker.js

@@ -1,4 +1,4 @@
-// ReSpec Worker v1.0.0
+// ReSpec Worker
 // hljs is either inlined by core/worker.js (preferred) or loaded below via
 // importScripts as a fallback when the inline fetch was not possible.
 if (typeof self.hljs === "undefined" && self.RESPEC_HIGHLIGHT_URL) {
@@ -9,24 +9,70 @@ if (typeof self.hljs === "undefined" && self.RESPEC_HIGHLIGHT_URL) {
   }
 }
 
-self.addEventListener("message", ({ data: originalData }) => {
-  const data = Object.assign({}, originalData);
+self.addEventListener("message", ({ data }) => {
   switch (data.action) {
     case "highlight-load-lang": {
-      const { langURL, propName, lang } = data;
-      importScripts(langURL);
-      self.hljs.registerLanguage(lang, self[propName]);
+      const { langURL, langScript, propName, lang } = data;
+      console.warn(
+        `[ReSpec] The "highlight-load-lang" worker action is deprecated ` +
+          `and will be removed in a future version. ` +
+          `To migrate, fetch your language script in the main thread and ` +
+          `send the text as "langScript" instead of "langURL". ` +
+          `The "langURL" path may fail in Firefox. ` +
+          `See https://github.com/speced/respec/issues/5228`
+      );
+      try {
+        if (langScript) {
+          const blob = new Blob([langScript], {
+            type: "application/javascript",
+          });
+          const objectURL = URL.createObjectURL(blob);
+          try {
+            importScripts(objectURL);
+          } finally {
+            URL.revokeObjectURL(objectURL);
+          }
+        } else if (langURL) {
+          const { protocol, hostname } = new URL(langURL);
+          const isSecure =
+            protocol === "https:" ||
+            (protocol === "http:" &&
+              (hostname === "localhost" ||
+                hostname === "127.0.0.1" ||
+                hostname === "[::1]"));
+          if (!isSecure) {
+            throw new Error(
+              `langURL must be https: or http: on localhost, got "${langURL}"`
+            );
+          }
+          importScripts(langURL);
+        } else {
+          throw new Error(
+            `No langScript or langURL provided for language "${lang}"`
+          );
+        }
+        if (typeof self[propName] === "function") {
+          self.hljs.registerLanguage(lang, self[propName]);
+        } else {
+          throw new Error(
+            `Language definer "${propName}" is not a function on self`
+          );
+        }
+      } catch (err) {
+        console.error("Failed to load or register language", lang, err);
+      }
+      delete data.langScript;
+      delete data.langURL;
       break;
     }
     case "highlight": {
       const { code } = data;
-      const langs = data.languages.length ? data.languages : undefined;
+      const langs = data.languages?.length ? data.languages : undefined;
       try {
         const { value, language } = self.hljs.highlightAuto(code, langs);
         Object.assign(data, { value, language });
       } catch (err) {
         console.error("Could not transform some code?", err);
-        // Post back the original code
         Object.assign(data, { value: code, language: "" });
       }
       break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "respec",
-  "version": "35.9.0",
+  "version": "37.0.0",
   "license": "W3C",
   "description": "A technical specification pre-processor.",
   "engines": {
@@ -24,13 +24,13 @@
     "Robin Berjon"
   ],
   "devDependencies": {
-    "@rollup/plugin-alias": "^5.1.1",
+    "@eslint/js": "^9.8.0",
     "@rollup/plugin-commonjs": "^29.0.2",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@types/pluralize": "0.0.33",
-    "@eslint/js": "^9.8.0",
     "boxen": "^8.0.1",
+    "cddlparser": "^0.6.0",
     "chokidar": "^5.0.0",
     "clean-css": "^5.3.3",
     "epipebomb": "^1.0.0",
@@ -39,12 +39,12 @@
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jasmine": "^4.2.2",
     "eslint-plugin-prettier": "^5.5.5",
-    "globals": "^16.0.0",
+    "globals": "^17.5.0",
     "highlight.js": "^11.11.1",
     "hyperhtml": "^2.34.2",
     "idb": "^8.0.3",
-    "jasmine": "^6.1.0",
-    "jasmine-core": "^6.1.0",
+    "jasmine": "^6.2.0",
+    "jasmine-core": "^6.2.0",
     "karma": "^6.4.4",
     "karma-chrome-launcher": "^3.2.0",
     "karma-firefox-launcher": "^2.1.3",
@@ -52,17 +52,19 @@
     "karma-jasmine-html-reporter": "^2.2.0",
     "karma-mocha-reporter": "^2.2.5",
     "karma-safari-launcher": "^1.0.0",
+    "lint-staged": "^16.4.0",
     "loading-indicator": "^2.0.0",
     "pluralize": "^8.0.0",
-    "prettier": "^3.8.1",
+    "prettier": "^3.8.3",
     "prompt": "^1.3.0",
-    "rollup": "^4.59.0",
+    "rollup": "^4.60.2",
     "rollup-plugin-minify-html-literals": "^1.2.6",
-    "serve": "^14.2.5",
+    "serve": "^14.2.6",
     "serve-handler": "^6.1.7",
+    "simple-git-hooks": "^2.13.1",
     "sniffy-mimetype": "^1.1.1",
-    "typescript": "^5.9.3",
-    "vnu-jar": "^26.3.8",
+    "typescript": "^6.0.3",
+    "vnu-jar": "^26.4.16",
     "webidl2": "^24.5.0"
   },
   "scripts": {
@@ -76,7 +78,7 @@
     "build:dini": "pnpm builder dini",
     "builddeps": "rollup -c js/deps/rollup.config.js --bundleConfigAsCjs && rollup -c worker/rollup.config.js --bundleConfigAsCjs",
     "lint": "tsc -p src/jsconfig.json && eslint .",
-    "prepare": "pnpm builddeps",
+    "prepare": "pnpm builddeps && simple-git-hooks",
     "builder": "node ./tools/builder.cjs",
     "release": "node ./tools/release.cjs",
     "server": "serve",
@@ -90,8 +92,8 @@
   "dependencies": {
     "colors": "1.4.0",
     "finalhandler": "^2.1.1",
-    "marked": "^16.3.0",
-    "puppeteer": "^24.37.5",
+    "marked": "^18.0.2",
+    "puppeteer": "^24.42.0",
     "sade": "^1.8.1",
     "serve-static": "^2.2.1"
   },
@@ -100,17 +102,43 @@
     "tools/respec2html.js",
     "tools/respecDocWriter.js"
   ],
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "lint-staged": {
+    "*.js": "eslint --fix",
+    "*.{js,json,md,html,css}": "prettier --write"
+  },
   "prettier": {
     "trailingComma": "es5",
     "arrowParens": "avoid"
   },
   "pnpm": {
     "onlyBuiltDependencies": [
-      "puppeteer"
+      "puppeteer",
+      "simple-git-hooks"
     ],
     "ignoredBuiltDependencies": [
       "vnu-jar"
-    ]
+    ],
+    "overrides": {
+      "flatted": ">=3.4.2",
+      "jasmine>glob": ">=10.5.0",
+      "lodash": ">=4.18.0",
+      "qs": ">=6.14.2",
+      "socket.io-parser": ">=4.2.6",
+      "tmp": ">=0.2.4",
+      "ws": ">=8.17.1",
+      "eslint-plugin-import>minimatch": "^3.1.4",
+      "eslint>minimatch": "^3.1.4",
+      "eslint>brace-expansion": "^1.1.13",
+      "minimatch>brace-expansion": "^1.1.13",
+      "karma>minimatch": "^3.1.4",
+      "jasmine>minimatch": "^9.0.7",
+      "@rollup/pluginutils>picomatch": "^2.3.2",
+      "@rollup/plugin-commonjs>picomatch": "^4.0.4",
+      "anymatch>picomatch": "^2.3.2"
+    }
   },
   "funding": {
     "type": "opencollective",

package/tools/respec2html.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 import { readFile, writeFile } from "fs/promises";
 import colors from "colors";
-import { fileURLToPath } from "url";
 import finalhandler from "finalhandler";
 import http from "http";
 import { marked } from "marked";
@@ -10,7 +9,7 @@ import sade from "sade";
 import serveStatic from "serve-static";
 import { toHTML } from "./respecDocWriter.js";
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const __dirname = import.meta.dirname;
 
 class Renderer extends marked.Renderer {
   strong(token) {

package/tools/respecDocWriter.js

@@ -1,13 +1,10 @@
 /**
  * Exports toHTML() method, allowing programmatic control of the spec generator.
  */
-import { fileURLToPath } from "url";
 import path from "path";
 import puppeteer from "puppeteer";
 import { readFile } from "fs/promises";
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
 const noop = () => {};
 
 /**
@@ -142,7 +139,12 @@ async function useLocalReSpec(page, log) {
     const url = new URL(request.url());
     const respecProfileRegex = /\/(respec-[\w-]+)(?:\.js)?$/;
     const profile = url.pathname.match(respecProfileRegex)[1];
-    const localPath = path.join(__dirname, "..", "builds", `${profile}.js`);
+    const localPath = path.join(
+      import.meta.dirname,
+      "..",
+      "builds",
+      `${profile}.js`
+    );
     const relPath = path.relative(process.cwd(), localPath);
     log(`Intercepted ${url} to respond with ${relPath}`);
     await request.respond({
@@ -223,7 +225,7 @@ async function checkIfReSpec(page) {
  */
 async function generateHTML(page, timer, version, url) {
   try {
-    return await page.evaluate(evaluateHTML, version, timer);
+    return await page.evaluate(evaluateHTML, timer);
   } catch (err) {
     const msg = `\n😭  Sorry, there was an error generating the HTML. Please report this issue!\n${`${
       `Specification: ${url}\n` +
@@ -235,48 +237,29 @@ async function generateHTML(page, timer, version, url) {
 }
 
 /**
- * @param {ReSpecVersion} version
  * @param {ReturnType<typeof createTimer>} timer
  */
-async function evaluateHTML(version, timer) {
+async function evaluateHTML(timer) {
   await timeout(
     document.respec ? document.respec.ready : document.respecIsReady,
     timer.remaining
   );
 
-  const [major, minor] = version;
-  if (major < 20 || (major === 20 && minor < 10)) {
-    console.warn(
-      "👴🏽  Ye Olde ReSpec version detected! Please update to 20.10.0 or above. " +
-        `Your version: ${window.respecVersion}.`
+  if (!document.respec?.toHTML) {
+    throw new Error(
+      "document.respec.toHTML is not available. " +
+        "Please upgrade to a newer version of ReSpec, " +
+        "or use an older version of the ReSpec CLI."
     );
-    // Document references an older version of ReSpec that does not yet
-    // have the "core/exporter" module. Try with the old "ui/save-html"
-    // module.
-    const { exportDocument } = await new Promise((resolve, reject) => {
-      require(["ui/save-html"], resolve, err => {
-        reject(new Error(err.message));
-      });
-    });
-    return exportDocument("html", "text/html");
-  } else if (!document.respec || !document.respec.toHTML) {
-    const { rsDocToDataURL } = await new Promise((resolve, reject) => {
-      require(["core/exporter"], resolve, err => {
-        reject(new Error(err.message));
-      });
-    });
-    const dataURL = rsDocToDataURL("text/html");
-    const encodedString = dataURL.replace(/^data:\w+\/\w+;charset=utf-8,/, "");
-    return decodeURIComponent(encodedString);
-  } else {
-    return await document.respec.toHTML();
   }
 
+  return await document.respec.toHTML();
+
   function timeout(promise, ms) {
     return new Promise((resolve, reject) => {
       promise.then(resolve, reject);
       const msg = `Timeout: document.respec.ready didn't resolve in ${ms}ms.`;
-      setTimeout(() => reject(msg), ms);
+      setTimeout(() => reject(new Error(msg)), ms);
     });
   }
 }