support markdownlint case

Author: TylerJang27

.markdownlint.json

@@ -0,0 +1,14 @@
+{
+  "default": true,
+  "extends": "markdownlint/style/prettier",
+  "MD026": false,
+  "search-replace": {
+    "rules": [
+      {
+        "name": "found-todo",
+        "message": "Don't use todo",
+        "searchPattern": "/TODO/gi"
+      }
+    ]
+  }
+}

.trunk/configs/.markdownlint.yaml

@@ -27,14 +27,14 @@ lint:
   enabled:
     - checkov@3.2.141
     - git-diff-check
-    - markdownlint@0.41.0
     - prettier@3.3.2
     - shellcheck@0.10.0
     - shfmt@3.6.0
     - trivy@0.52.2
     - trufflehog@3.78.1
     - yamllint@1.35.1
     # TODO linters
+    - markdownlint@0.41.0
     - cspell@8.9.0
     - codespell@2.3.0
     - vale@3.6.0
@@ -64,3 +64,4 @@ lint:
         - styles/**
         - .semgrep.yaml
         - toolbox.toml
+        - .markdownlint.json

.trunk/trunk.yaml

@@ -2,12 +2,13 @@
 
 An exploration of different ways to build a TODO linter, including:
 
-- [trunk-toolbox](#trunk-toolbox)
-- [custom `grep` linter](#grep-linter)
+- [markdownlint](#markdownlint)
 - [CSpell](#cspell)
 - [codespell](#codespell)
 - [Vale](#vale)
 - [Semgrep](#semgrep)
+- [trunk-toolbox](#trunk-toolbox)
+- [custom `grep` linter](#grep-linter)
 
 ## Prerequisites
 
@@ -25,6 +26,22 @@ plugins:
       uri: https://github.com/trunk-io/todo-linter-demo
 ```
 
+## markdownlint
+
+This markdownlint linter setup is dependent on:
+
+- `.markdownlint.json`
+
+```bash
+trunk check --filter=markdownlint test_data.md
+```
+
+To run outside Trunk, run:
+
+```bash
+.trunk/tools/markdownlint test_data.md
+```
+
 ## CSpell
 
 This CSpell linter setup is dependent on:

README.md

@@ -1,6 +1,29 @@
 version: 0.1
+tools:
+  definitions:
+    - name: markdownlint
+      extra_packages: [markdownlint-rule-search-replace]
 lint:
   definitions:
+    - name: markdownlint
+      commands:
+        - name: lint
+          run: markdownlint ${target} --json -r markdownlint-rule-search-replace
+    - name: codespell
+      direct_configs:
+        - .codespellrc
+        - todo_dict.txt
+    - name: vale
+      direct_configs:
+        - .vale.ini
+        - styles/base/todo.yml
+    - name: semgrep
+      commands:
+        - name: check
+          # Add our custom rules
+          run:
+            semgrep --config=auto --config=.semgrep.yaml --sarif --output=${tmpfile}
+            --include=${target}
     - name: todo-grep-wrapped
       description: Uses grep to look for TODOs
       files: [ALL]
@@ -21,21 +44,6 @@ lint:
             run: 'sed -E "s/([^:]*):([0-9]+):(.*)/\1:\2:0: [error] Found \3 in line (TODO)/"'
           output: regex
           parse_regex: "((?P<path>.*):(?P<line>-?\\d+):(?P<col>-?\\d+): \\[(?P<severity>.*)\\] (?P<message>.*) \\((?P<code>.*)\\))"
-    - name: codespell
-      direct_configs:
-        - .codespellrc
-        - todo_dict.txt
-    - name: vale
-      direct_configs:
-        - .vale.ini
-        - styles/base/todo.yml
-    - name: semgrep
-      commands:
-        - name: check
-          # Add our custom rules
-          run:
-            semgrep --config=auto --config=.semgrep.yaml --sarif --output=${tmpfile}
-            --include=${target}
   exported_configs:
     - configs:
         - cspell.yaml

plugin.yaml

@@ -20,6 +20,6 @@ Look at all the ways to check for todo!
 
 <!-- trunk-ignore-begin(todo-grep-wrapped,codespell,cspell,vale,semgrep,trunk-toolbox) -->
 
-Let's ignore this TODO though.
+Let's ignore this TODO though
 
 <!-- trunk-ignore-end(todo-grep-wrapped,codespell,cspell,vale,semgrep,trunk-toolbox) -->