Make markdownlint config separate for specification docs

Author: m-houston

.markdownlint.jsonc

@@ -0,0 +1,11 @@
+// SEE: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+{
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+  "MD013": false,
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+  "MD024": {
+    "siblings_only": true
+  },
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
+  "MD033": false
+}

scripts/config/.repository-template-sync-ignore

@@ -14,6 +14,7 @@ CHANGELOG.md
 project.code-workspace
 README.md
 scripts/config/sonar-scanner.properties
+scripts/githooks/check-markdown-format.sh
 scripts/tests/
 VERSION
 

scripts/config/markdownlint.yaml

@@ -51,11 +51,22 @@ function main() {
       ;;
   esac
 
-  if [ -n "$files" ]; then
+  specfiles=$(echo "$files" | grep '^specification/') || true
+  otherfiles=$(echo "$files" | grep -v '^specification/') || true
+
+  if [ -n "$specfiles" ]; then
+    if command -v markdownlint > /dev/null 2>&1 && ! is-arg-true "${FORCE_USE_DOCKER:-false}"; then
+      files="$specfiles" config="specification/.markdownlint.json" run-markdownlint-natively
+    else
+      files="$specfiles" config="specification/.markdownlint.json" run-markdownlint-in-docker
+    fi
+  fi
+
+  if [ -n "$otherfiles" ]; then
     if command -v markdownlint > /dev/null 2>&1 && ! is-arg-true "${FORCE_USE_DOCKER:-false}"; then
-      files="$files" run-markdownlint-natively
+      files="$otherfiles" config=".markdownlint.jsonc" run-markdownlint-natively
     else
-      files="$files" run-markdownlint-in-docker
+      files="$otherfiles" config=".markdownlint.jsonc" run-markdownlint-in-docker
     fi
   fi
 }
@@ -68,7 +79,7 @@ function run-markdownlint-natively() {
   # shellcheck disable=SC2086
   markdownlint \
     $files \
-    --config "$PWD/scripts/config/markdownlint.yaml"
+    --config "$config"
 }
 
 # Run markdownlint in a Docker container.
@@ -86,7 +97,7 @@ function run-markdownlint-in-docker() {
     --volume "$PWD":/workdir \
     "$image" \
       $files \
-      --config /workdir/scripts/config/markdownlint.yaml
+      --config "$config"
 }
 
 # ==============================================================================

scripts/githooks/check-markdown-format.sh

@@ -0,0 +1,6 @@
+{
+  "MD041": {
+    "level": 2
+  },
+  "extends": "../.markdownlint.jsonc"
+}