Update markdownlint-github for new breaking change

JoyceZhu · JoyceZhu · commit f8be03a800b5 · 2025-06-25T03:50:10.000Z
diff --git a/.markdownlint-cli2.mjs b/.markdownlint-cli2.mjs
@@ -1,5 +1,8 @@
+import markdownIt from "markdown-it";
 import { init } from "./index.js";
 
+const markdownItFactory = () => markdownIt({ html: true });
+
 const configOptions = await init({
   default: false,
   "heading-increment": true,
@@ -11,5 +14,6 @@ const configOptions = await init({
 const options = {
   config: configOptions,
   customRules: ["./index.js"],
+  markdownItFactory,
 };
 export default options;
diff --git a/README.md b/README.md
@@ -47,10 +47,13 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
 4. Edit `.markdownlint-cli2.mjs` file to suit your needs. Start with
 
     ```js
+    import markdownIt from "markdown-it"
     import configOptions, {init} from "@github/markdownlint-github"
+    const markdownItFactory = () => markdownIt({ html: true })
     const options = {
         config: init(),
         customRules: ["@github/markdownlint-github"],
+        markdownItFactory,
         outputFormatters: [
           [ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ] // ensures the error message includes a link to the rule documentation
         ]
@@ -62,13 +65,16 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
     This looks like:
 
     ```js
+    import markdownIt from "markdown-it"
     import configOptions, {init} from "@github/markdownlint-github"
     const overriddenOptions = init({
         'fenced-code-language': false, // Custom overrides
     })
+    const markdownItFactory = () => markdownIt({ html: true })
     const options = {
         config: overriddenOptions,
         customRules: ["@github/markdownlint-github"],
+        markdownItFactory,
         outputFormatters: [
           [ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ]
         ]
@@ -96,9 +102,12 @@ The rule will need to be enabled in the configuration. For instance, if you intr
 
 ```js
 import configOptions, {init} from "@github/markdownlint-github"
+import markdownIt from "markdown-it"
+const markdownItFactory = () => markdownIt({ html: true })
 const options = init({
     "some-rule": true,
     customRules: ["@github/markdownlint-github", "some-rule.js"],
+    markdownItFactory
 })
 export default options
 ```
diff --git a/test/accessibility-rules.test.js b/test/accessibility-rules.test.js
@@ -1,8 +1,10 @@
 import { lint } from "markdownlint/async";
+import markdownIt from "markdown-it";
 import githubMarkdownLint from "../index.js";
 import accessibilityRules from "../style/accessibility.js";
 
 const exampleFileName = "./test/example.md";
+const markdownItFactory = () => markdownIt({ html: true });
 
 describe("when A11y rules applied", () => {
   test("fails expected rules", async () => {
@@ -13,6 +15,7 @@ describe("when A11y rules applied", () => {
       },
       files: [exampleFileName],
       customRules: githubMarkdownLint,
+      markdownItFactory,
     };
 
     const result = await new Promise((resolve, reject) => {
diff --git a/test/utils/run-test.js b/test/utils/run-test.js
@@ -1,4 +1,7 @@
 import { lint } from "markdownlint/async";
+import markdownIt from "markdown-it";
+
+const markdownItFactory = () => markdownIt({ html: true });
 
 export async function runTest(strings, rule, ruleConfig) {
   const thisRuleName = rule.names[1];
@@ -9,6 +12,7 @@ export async function runTest(strings, rule, ruleConfig) {
       [thisRuleName]: ruleConfig || true,
     },
     customRules: [rule],
+    markdownItFactory,
   };
 
   const results = await Promise.all(
