Merge pull request #266 from TracerBench/update-remark

krisselden · web-flow · commit 9a31365bb069 · 2025-07-17T11:30:50.000-07:00
[chore] update remark and readme example sync
diff --git a/@tracerbench/find-chrome/package.json b/@tracerbench/find-chrome/package.json
@@ -35,6 +35,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/@tracerbench/message-transport/package.json b/@tracerbench/message-transport/package.json
@@ -22,6 +22,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/@tracerbench/protocol-connection/package.json b/@tracerbench/protocol-connection/package.json
@@ -41,7 +41,7 @@
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-sourcemaps": "^0.6.2",
     "rollup-plugin-terser": "^6.1.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "devtools-protocol": "*"
diff --git a/@tracerbench/protocol-transport/package.json b/@tracerbench/protocol-transport/package.json
@@ -40,6 +40,6 @@
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-sourcemaps": "^0.6.2",
     "rollup-plugin-terser": "^6.1.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/@tracerbench/spawn-chrome/package.json b/@tracerbench/spawn-chrome/package.json
@@ -37,7 +37,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   },
   "gitHead": "930bc11c8b01620e5095df9249f0647af68235b5"
 }
diff --git a/@tracerbench/spawn/package.json b/@tracerbench/spawn/package.json
@@ -38,7 +38,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   },
   "gitHead": "930bc11c8b01620e5095df9249f0647af68235b5"
 }
diff --git a/@tracerbench/websocket-message-transport/package.json b/@tracerbench/websocket-message-transport/package.json
@@ -36,6 +36,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/README.md b/README.md
@@ -9,29 +9,27 @@ designed with automation in mind.
 
 ## Table of Contents
 
-*   [Features](#features)
-
-*   [Examples](#examples)
-
-    *   [Print URL as PDF](#print-url-as-pdf)
-    *   [Node Debugging](#node-debugging)
+* [Features](#features)
+* [Examples](#examples)
+  * [Print URL as PDF](#print-url-as-pdf)
+  * [Node Debugging](#node-debugging)
 
 ## Features
 
-*   Promise API for async/await (most debugger commands are meant to be sequential).
-*   TypeScript support and uses "devtools-protocol" types, allowing you to pick a protocol version.
-*   Launches Chrome with a new temp user data folder so Chrome launches an isolated instance.
-    (regardless if you already have Chrome open).
-*   Opens Chrome with a pipe message transport to the browser connection and supports
-    attaching flattened session connections to targets.
-*   Supports cancellation in a way that avoids unhandled rejections, and allows you to add combine
-    additional cancellation concerns.
-*   Supports seeing protocol debug messages with `DEBUG=chrome-debugging-client:*`
-*   Use with race-cancellation library to add timeouts or other cancellation concerns to tasks
-    using the connection.
-*   The library was designed to be careful about not floating promises (promises are
-    chained immediately after being created, combining concurrent promises with all
-    or race), this avoids unhandled rejections.
+* Promise API for async/await (most debugger commands are meant to be sequential).
+* TypeScript support and uses "devtools-protocol" types, allowing you to pick a protocol version.
+* Launches Chrome with a new temp user data folder so Chrome launches an isolated instance.
+  (regardless if you already have Chrome open).
+* Opens Chrome with a pipe message transport to the browser connection and supports
+  attaching flattened session connections to targets.
+* Supports cancellation in a way that avoids unhandled rejections, and allows you to add combine
+  additional cancellation concerns.
+* Supports seeing protocol debug messages with `DEBUG=chrome-debugging-client:*`
+* Use with race-cancellation library to add timeouts or other cancellation concerns to tasks
+  using the connection.
+* The library was designed to be careful about not floating promises (promises are
+  chained immediately after being created, combining concurrent promises with all
+  or race), this avoids unhandled rejections.
 
 ## Examples
 
diff --git a/chrome-debugging-client.code-workspace b/chrome-debugging-client.code-workspace
@@ -13,7 +13,7 @@
     },
     "eslint.validate": ["javascript", "typescript"],
     "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
+      "source.fixAll.eslint": "always"
     }
   },
   "folders": [
diff --git a/chrome-debugging-client/README.md b/chrome-debugging-client/README.md
@@ -9,29 +9,27 @@ designed with automation in mind.
 
 ## Table of Contents
 
-*   [Features](#features)
-
-*   [Examples](#examples)
-
-    *   [Print URL as PDF](#print-url-as-pdf)
-    *   [Node Debugging](#node-debugging)
+* [Features](#features)
+* [Examples](#examples)
+  * [Print URL as PDF](#print-url-as-pdf)
+  * [Node Debugging](#node-debugging)
 
 ## Features
 
-*   Promise API for async/await (most debugger commands are meant to be sequential).
-*   TypeScript support and uses "devtools-protocol" types, allowing you to pick a protocol version.
-*   Launches Chrome with a new temp user data folder so Chrome launches an isolated instance.
-    (regardless if you already have Chrome open).
-*   Opens Chrome with a pipe message transport to the browser connection and supports
-    attaching flattened session connections to targets.
-*   Supports cancellation in a way that avoids unhandled rejections, and allows you to add combine
-    additional cancellation concerns.
-*   Supports seeing protocol debug messages with `DEBUG=chrome-debugging-client:*`
-*   Use with race-cancellation library to add timeouts or other cancellation concerns to tasks
-    using the connection.
-*   The library was designed to be careful about not floating promises (promises are
-    chained immediately after being created, combining concurrent promises with all
-    or race), this avoids unhandled rejections.
+* Promise API for async/await (most debugger commands are meant to be sequential).
+* TypeScript support and uses "devtools-protocol" types, allowing you to pick a protocol version.
+* Launches Chrome with a new temp user data folder so Chrome launches an isolated instance.
+  (regardless if you already have Chrome open).
+* Opens Chrome with a pipe message transport to the browser connection and supports
+  attaching flattened session connections to targets.
+* Supports cancellation in a way that avoids unhandled rejections, and allows you to add combine
+  additional cancellation concerns.
+* Supports seeing protocol debug messages with `DEBUG=chrome-debugging-client:*`
+* Use with race-cancellation library to add timeouts or other cancellation concerns to tasks
+  using the connection.
+* The library was designed to be careful about not floating promises (promises are
+  chained immediately after being created, combining concurrent promises with all
+  or race), this avoids unhandled rejections.
 
 ## Examples
 
diff --git a/chrome-debugging-client/package.json b/chrome-debugging-client/package.json
@@ -43,7 +43,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "devtools-protocol": "*"
diff --git a/examples/package.json b/examples/package.json
@@ -22,6 +22,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/scripts/import-code/index.js b/scripts/import-code/index.js
@@ -1,24 +1,23 @@
-const fs = require("fs");
-const path = require("path");
-const { split } = require("shell-split");
-const visit = require("unist-util-visit");
+import * as fs from "fs";
+import * as path from "path";
+import { visit } from "unist-util-visit";
 
-/** @type {import("unified").Plugin} */
-const importCode = () => replaceCodeTransform;
-
-module.exports = importCode;
+/** @type {import("unified").Plugin<[], import("mdast").Root, import("vfile").VFile>} */
+const importCode = replaceCodeTransform;
+export default importCode;
 
 /**
- * @param {import("unist").Node} tree
- * @param {import("vfile").VFile} file
+ * @param {unknown[]} options
+ * @return {import("unified").Transformer<import("mdast").Root, import("mdast").Root>}
  */
-function replaceCodeTransform(tree, file) {
-  visit(tree, "code", (code) => processCodeNode(code, file));
-  return tree;
+function replaceCodeTransform(...options) {
+  return (tree, file) => {
+    visit(tree, "code", (code) => processCodeNode(code, file));
+  };
 }
 
 /**
- * @param {import("unist").Node} code
+ * @param {import("mdast").Code} code
  * @param {import("vfile").VFile} file
  */
 function processCodeNode(code, file) {
@@ -37,7 +36,7 @@ function processCodeNode(code, file) {
  */
 function parseCodeMeta(meta, file) {
   if (meta) {
-    const parts = split(meta);
+    const parts = meta.split(/\s+/);
     for (const part of parts) {
       const [key, value] = part.split("=", 2);
       if (key === "file") {
diff --git a/scripts/package.json b/scripts/package.json
@@ -7,16 +7,19 @@
     "fixlint": "eslint . --fix",
     "lint": "eslint ."
   },
+  "type": "module",
   "dependencies": {
     "@types/node": "^18.16.0",
-    "remark": "^14.0.2",
-    "remark-parse": "^10.0.1",
-    "remark-stringify": "^10.0.2",
-    "remark-toc": "^8.0.1",
-    "shell-split": "^1.0.0",
-    "unified": "^9.0.0",
-    "unist-util-visit": "^2.0.0",
-    "vfile": "^4.0.1"
+    "rehype-stringify": "^10.0.1",
+    "remark": "^15.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "remark-stringify": "^11.0.0",
+    "remark-toc": "^9.0.0",
+    "to-vfile": "^8.0.0",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.3"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.59.1",
@@ -27,6 +30,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/scripts/readme.js b/scripts/readme.js
@@ -1,29 +1,31 @@
 #!/usr/bin/env node
-const fs = require("fs");
-const path = require("path");
-const unified = require("unified");
-const vfile = require("vfile");
-
-const importCode = require("./import-code");
+import * as fs from "fs";
+import * as path from "path";
+import importCode from "./import-code/index.js";
+import { VFile } from "vfile";
+import { fileURLToPath } from "url";
+import remarkParse from "remark-parse";
+import { unified } from "unified";
+import remarkStringify from "remark-stringify";
 
 void main();
 
 async function main() {
-  const { default: parse } = await import("remark-parse");
-  const { default: stringify } = await import("remark-stringify");
-  const { default: toc } = await import("remark-toc");
+  const toc = await import("remark-toc");
   const processor = unified()
-    .use(parse)
-    .use(toc)
+    .use(remarkParse)
+    .use(toc.default)
     .use(importCode)
-    .use(stringify);
+    .use(remarkStringify);
+
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
 
-  let readme = readReadme(path.resolve(__dirname, "../README.md"));
+  let readme = readReadme(path.resolve(dirname, "../README.md"));
 
   readme = await processor.process(readme);
 
   writeReadme(
-    path.resolve(__dirname, "../chrome-debugging-client/README.md"),
+    path.resolve(dirname, "../chrome-debugging-client/README.md"),
     readme,
   );
 }
@@ -33,10 +35,7 @@ async function main() {
  */
 function readReadme(path) {
   const contents = fs.readFileSync(path, "utf8");
-  return vfile({
-    contents,
-    path,
-  });
+  return new VFile({ value: contents, path });
 }
 
 /**
diff --git a/scripts/tsconfig.json b/scripts/tsconfig.json
@@ -4,9 +4,10 @@
     "allowJs": true,
     "checkJs": true,
     "strict": true,
+    "esModuleInterop": true,
     "moduleResolution": "node",
-    "module": "commonjs",
-    "target": "ES2017"
+    "module": "esnext",
+    "target": "es2024"
   },
   "files": ["types.d.ts", "readme.js"]
 }
diff --git a/scripts/types.d.ts b/scripts/types.d.ts
@@ -3,15 +3,6 @@ declare module "remark-toc" {
   export = toc;
 }
 
-declare module "unist-util-visit" {
-  function visit(
-    tree: import("unist").Node,
-    type: string,
-    visitor: (node: import("unist").Node) => void,
-  ): void;
-  export = visit;
-}
-
 declare module "shell-split" {
   export function split(str: string): string[];
 }
diff --git a/test/package.json b/test/package.json
@@ -29,6 +29,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^2.0.5",
-    "typescript": "^5.0.4"
+    "typescript": "^5.8.3"
   }
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,6 @@`
`35`	`35`	`"eslint-plugin-prettier": "^4.2.1",`
`36`	`36`	`"eslint-plugin-simple-import-sort": "^10.0.0",`
`37`	`37`	`"prettier": "^2.0.5",`
`38`		`- "typescript": "^5.0.4"`
	`38`	`+ "typescript": "^5.8.3"`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,6 @@`
`22`	`22`	`"eslint-plugin-prettier": "^4.2.1",`
`23`	`23`	`"eslint-plugin-simple-import-sort": "^10.0.0",`
`24`	`24`	`"prettier": "^2.0.5",`
`25`		`- "typescript": "^5.0.4"`
	`25`	`+ "typescript": "^5.8.3"`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,6 @@`
`40`	`40`	`"rollup-plugin-commonjs": "^10.1.0",`
`41`	`41`	`"rollup-plugin-sourcemaps": "^0.6.2",`
`42`	`42`	`"rollup-plugin-terser": "^6.1.0",`
`43`		`- "typescript": "^5.0.4"`
	`43`	`+ "typescript": "^5.8.3"`
`44`	`44`	`}`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`"eslint-plugin-prettier": "^4.2.1",`
`38`	`38`	`"eslint-plugin-simple-import-sort": "^10.0.0",`
`39`	`39`	`"prettier": "^2.0.5",`
`40`		`- "typescript": "^5.0.4"`
	`40`	`+ "typescript": "^5.8.3"`
`41`	`41`	`},`
`42`	`42`	`"gitHead": "930bc11c8b01620e5095df9249f0647af68235b5"`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`"eslint-plugin-prettier": "^4.2.1",`
`39`	`39`	`"eslint-plugin-simple-import-sort": "^10.0.0",`
`40`	`40`	`"prettier": "^2.0.5",`
`41`		`- "typescript": "^5.0.4"`
	`41`	`+ "typescript": "^5.8.3"`
`42`	`42`	`},`
`43`	`43`	`"gitHead": "930bc11c8b01620e5095df9249f0647af68235b5"`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,6 @@`
`36`	`36`	`"eslint-plugin-prettier": "^4.2.1",`
`37`	`37`	`"eslint-plugin-simple-import-sort": "^10.0.0",`
`38`	`38`	`"prettier": "^2.0.5",`
`39`		`- "typescript": "^5.0.4"`
	`39`	`+ "typescript": "^5.8.3"`
`40`	`40`	`}`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`},`
`14`	`14`	`"eslint.validate": ["javascript", "typescript"],`
`15`	`15`	`"editor.codeActionsOnSave": {`
`16`		`- "source.fixAll.eslint": true`
	`16`	`+ "source.fixAll.eslint": "always"`
`17`	`17`	`}`
`18`	`18`	`},`
`19`	`19`	`"folders": [`