scripts: add linter for markdown files

Signed-off-by: SorinO <sorin.olari2@gmail.com>

Author: SorinOlari

scripts/check_license_banner_conf_files.sh

@@ -43,7 +43,7 @@ check_license_banner() {
 echo "Checking license banners."
 ERROR_FOUND=0
 for file in $(find . -type f \( -name 'CMakeLists.txt' -o -name '*.yaml' \
-    -o -name '*.yml' -o -name '*.awk' -o -name '*.conf' -o -name 'Kconfig*' \
+    -o -name '*.yml' -o -name '*.awk' -o -name '*.conf' -o -name 'Kconfig*' -o -name '*.mdlrc' \
     -o -name '.gitignore' -o -name '.gitmodules' -o -name '*.sh' -o -name '*.cmake' -o -name '*.py' \) \
     ! -path './tests/Unity/*' \
     ! -path './build/*' \

scripts/md_linter.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+# @copyright Copyright (c) contributors to Project Ocre,
+# which has been established as Project Ocre a Series of LF Projects, LLC
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Simple linter checker for markdown files
+# Checks all markdown files with markdownlint
+
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+echo "Checking markdown files."
+
+cd "$ROOT_DIR"
+
+find . -type f -name '*.md' \
+    ! -path '*/build/*' \
+    ! -path './ocre-sdk/*' \
+    ! -path './wasm-micro-runtime/*' \
+    ! -path './tests/*' \
+    -print0 | \
+    xargs -0 mdl -s ./scripts/md_linter_rules.mdlrc

scripts/md_linter_rules.mdlrc

@@ -0,0 +1,15 @@
+# @copyright Copyright (c) contributors to Project Ocre,
+# which has been established as Project Ocre a Series of LF Projects, LLC
+#
+# SPDX-License-Identifier: Apache-2.0
+
+all
+exclude_rule 'MD002' # First header should be a top level header
+exclude_rule 'MD010' # Hard tabs
+exclude_rule 'MD013' # Line length
+exclude_rule 'MD029' # Ordered list item prefix
+exclude_rule 'MD041' # First line in file should be a top level header
+exclude_rule 'MD040' # Fenced code blocks should have a language specified
+rule 'MD024', :allow_different_nesting  => 'true' # Multiple headers with the same content
+rule 'MD026', :punctuation => '.,;!' # Trailing punctuation in header
+rule 'MD007', :indent => 2 # Unordered list indentation