Add tests for custom rules (markdown-it and micromark) with no errors…

… and errors.
DavidAnson · Jan 19, 2025 · 1d17f9b · 1d17f9b
1 parent 51527aa
commit 1d17f9b
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 5 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -51,7 +51,7 @@ jobs:
       with:
         globs: |
           *.md
-          test/*
+          test/*.md
       continue-on-error: true
       id: test
     - run: exit 1
@@ -63,7 +63,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ./
       with:
-        globs: '*.md,test/*'
+        globs: '*.md,test/*.md'
         separator: ','
       continue-on-error: true
       id: test
@@ -78,7 +78,7 @@ jobs:
     - uses: ./
       with:
         config: 'config/test.markdownlint.jsonc'
-        globs: 'test/*'
+        globs: 'test/*.md'
       continue-on-error: true
       id: test
     - run: exit 1
@@ -91,7 +91,7 @@ jobs:
     - uses: ./
       with:
         config: 'invalid.markdownlint.jsonc'
-        globs: 'test/*'
+        globs: 'test/*.md'
       continue-on-error: true
       id: test
     - run: exit 1
@@ -104,4 +104,28 @@ jobs:
     - uses: ./
       with:
         fix: true
-        globs: 'test/*'
+        globs: 'test/*.md'
+  rules-pass:
+    name: custom rules (README.md, 0 errors)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: rm .markdownlint.json
+    - uses: ./
+      with:
+        config: 'config/custom-rules-pass.markdownlint-cli2.jsonc'
+        globs: 'README.md'
+  rules-fail:
+    name: custom rules (README.md, 2 errors)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: rm .markdownlint.json
+    - uses: ./
+      with:
+        config: 'config/custom-rules-fail.markdownlint-cli2.jsonc'
+        globs: 'README.md'
+      continue-on-error: true
+      id: test
+    - run: exit 1
+      if: steps.test.outcome != 'failure'
diff --git a/config/custom-rules-fail.markdownlint-cli2.jsonc b/config/custom-rules-fail.markdownlint-cli2.jsonc
@@ -0,0 +1,14 @@
+{
+  "config": {
+    "custom-rule-markdown-it": {
+      "error": true
+    },
+    "custom-rule-micromark": {
+      "error": true
+    }
+  },
+  "customRules": [
+    "../test/custom-rule-markdown-it.cjs",
+    "../test/custom-rule-micromark.cjs"
+  ]
+}
diff --git a/config/custom-rules-pass.markdownlint-cli2.jsonc b/config/custom-rules-pass.markdownlint-cli2.jsonc
@@ -0,0 +1,6 @@
+{
+  "customRules": [
+    "../test/custom-rule-markdown-it.cjs",
+    "../test/custom-rule-micromark.cjs"
+  ]
+}
diff --git a/test/custom-rule-markdown-it.cjs b/test/custom-rule-markdown-it.cjs
@@ -0,0 +1,14 @@
+// @ts-check
+
+/** @type {import("markdownlint").Rule} */
+module.exports = {
+  "names": [ "custom-rule-markdown-it" ],
+  "description": "Custom rule using markdown-it",
+  "tags": [ "test" ],
+  "parser": "markdownit",
+  "function": (params, onError) => {
+    if (params.config.error) {
+      onError({ "lineNumber": 1 });
+    }
+  }
+}
diff --git a/test/custom-rule-micromark.cjs b/test/custom-rule-micromark.cjs
@@ -0,0 +1,14 @@
+// @ts-check
+
+/** @type {import("markdownlint").Rule} */
+module.exports = {
+  "names": [ "custom-rule-micromark" ],
+  "description": "Custom rule using micromark",
+  "tags": [ "test" ],
+  "parser": "micromark",
+  "function": (params, onError) => {
+    if (params.config.error) {
+      onError({ "lineNumber": 1 });
+    }
+  }
+}