Use mise for running markdownlint (#2478)

Author: trask

.github/copilot-instructions.md

@@ -63,4 +63,4 @@ When implementing changes or new features:
 1. Follow all [Style Guide](../docs/style-guide.md) conventions and the Code Review Priorities above
 2. Run tests to ensure they still pass (use `./gradlew test` and `./gradlew integrationTest` as needed)
 3. **Always run `./gradlew spotlessApply`** after making code changes to ensure proper formatting
-4. Run markdown lint to ensure it still passes: `npx [email protected] --config .github/config/.markdownlint-cli2.yaml "**/*.md"`
+4. Run markdown lint to ensure it still passes: `mise run lint:markdown`

.github/workflows/reusable-markdown-lint.yml

@@ -12,6 +12,12 @@ jobs:
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
 
+      - uses: jdx/mise-action@9dc7d5dd454262207dea3ab5a06a3df6afc8ff26 # v3.4.1
+
       - name: Run markdownlint
         run: |
-          npx [email protected] --config .github/config/.markdownlint-cli2.yaml "**/*.md"
+          if ! mise run lint:markdown; then
+            echo "markdownlint failed. To auto-fix many issues locally, run:"
+            echo "  mise run lint:markdown --fix"
+            exit 1
+          fi

.markdownlint.yaml

@@ -0,0 +1,13 @@
+# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+# and https://github.com/DavidAnson/markdownlint-cli2
+
+ul-style: false
+line-length: false
+no-duplicate-heading:
+  siblings_only: true
+ol-prefix:
+  style: ordered
+no-inline-html: false
+fenced-code-language: false
+no-trailing-punctuation:
+  punctuation: ".,;:" # allowing exclamation points and question marks at end of sentences

.mise/tasks/lint/markdown.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+#MISE description="Lint markdown files"
+#MISE flag "--fix" help="Automatically fix issues"
+
+set -e
+
+if [ "${usage_fix}" = "true" ]; then
+  markdownlint-cli2 --fix "**/*.md" "#**/build" "#**/node_modules" "#CHANGELOG.md" "#ibm-mq-metrics/docs/metrics.md" "#.github/pull_request_template.md"
+else
+  markdownlint-cli2 "**/*.md" "#**/build" "#**/node_modules" "#CHANGELOG.md" "#ibm-mq-metrics/docs/metrics.md" "#.github/pull_request_template.md"
+fi

mise.toml

@@ -1,5 +1,6 @@
 [tools]
 lychee = "0.21.0"
+markdownlint-cli2 = "0.17.1"
 
 [settings]
 # Only install tools explicitly defined in the [tools] section above
@@ -10,3 +11,6 @@ idiomatic_version_file_enable_tools = []
 windows_executable_extensions = ["sh"]
 windows_default_file_shell_args = "bash"
 use_file_shell_for_executable_tasks = true
+
+[tasks."lint:markdown"]
+file = ".mise/tasks/lint/markdown.sh"