Update .markdownlint-cli2.jsonc/yaml example files with modulePaths, …

…add test case for absolute platform-specific modulePaths.
DavidAnson · Oct 5, 2023 · f079c44 · f079c44
1 parent e736a1a
commit f079c44
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 2 deletions.
diff --git a/test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc b/test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
@@ -34,6 +34,11 @@
     [ "@iktakahiro/markdown-it-katex" ]
   ],
 
+  // Additional paths to resolve module locations from
+  "modulePaths": [
+    "./modules"
+  ],
+
   // Disable inline config comments
   "noInlineConfig": true,
 

diff --git a/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml b/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
@@ -30,6 +30,10 @@ markdownItPlugins:
   -
     - "@iktakahiro/markdown-it-katex"
 
+# Additional paths to resolve module locations from
+modulePaths:
+  - "./modules"
+
 # Disable inline config comments
 noInlineConfig: true
 

diff --git a/test/modulePaths-non-root/dir2/.markdownlint-cli2.cjs b/test/modulePaths-non-root/dir2/.markdownlint-cli2.cjs
@@ -0,0 +1,20 @@
+// @ts-check
+
+"use strict";
+
+const path = require("node:path");
+
+module.exports = {
+  "customRules": [
+    "markdownlint-rule-sample-commonjs"
+  ],
+  "markdownItPlugins": [
+    [ "custom-markdown-it-plugin" ]
+  ],
+  "modulePaths": [
+    "../../customRules",
+    "../../invalid",
+    "../../no-config",
+    "../../markdownItPlugins/module"
+  ].map((dir) => path.resolve(__dirname, dir))
+};
diff --git a/test/modulePaths-non-root/dir2/link.md b/test/modulePaths-non-root/dir2/link.md
@@ -0,0 +1,3 @@
+# Heading
+
+Text [ link ](https://example.com)
diff --git a/test/snapshots/markdownlint-cli2-test-exec.js.md b/test/snapshots/markdownlint-cli2-test-exec.js.md
@@ -7250,7 +7250,7 @@ Generated by [AVA](https://avajs.dev).
       `,
       stdout: `markdownlint-cli2 vX.Y.Z (markdownlint vX.Y.Z)␊
       Finding: **/*.md␊
-      Linting: 5 file(s)␊
+      Linting: 6 file(s)␊
       Summary: 14 error(s)␊
       `,
     }
diff --git a/test/snapshots/markdownlint-cli2-test-exec.js.snap b/test/snapshots/markdownlint-cli2-test-exec.js.snap
diff --git a/test/snapshots/markdownlint-cli2-test-main.js.md b/test/snapshots/markdownlint-cli2-test-main.js.md
@@ -5325,7 +5325,7 @@ Generated by [AVA](https://avajs.dev).
       `,
       stdout: `markdownlint-cli2 vX.Y.Z (markdownlint vX.Y.Z)␊
       Finding: **/*.md␊
-      Linting: 5 file(s)␊
+      Linting: 6 file(s)␊
       Summary: 14 error(s)␊
       `,
     }
diff --git a/test/snapshots/markdownlint-cli2-test-main.js.snap b/test/snapshots/markdownlint-cli2-test-main.js.snap