format-code: enable markdownlint

Enable markdownlint but allow it to always pass.  This will allow
maintainers the opportunity to run the tools and fix up their own
markdown before we enable this globally.

Signed-off-by: Patrick Williams <[email protected]>
Change-Id: Ie397a72ca4ef113cdbe433d263ccf3bd5063cf4b

Author: williamspatrick

.markdownlint.yaml

@@ -0,0 +1 @@
+config/markdownlint.yaml

README.md

@@ -1 +1,3 @@
+# openbmc-build-scripts
+
 Build script for CI jobs in Jenkins.

config/markdownlint.yaml

@@ -0,0 +1,3 @@
+default: true
+MD024:
+    siblings_only: true

jenkins/README.md

@@ -1,3 +1,5 @@
+# Jenkins
+
 These are the top level scripts launched by the
 [OpenBMC Jenkins instance](https://jenkins.openbmc.org):
 

scripts/build-unit-test-docker

@@ -859,6 +859,7 @@ RUN pip3 install requests
 
 RUN npm install -g \
         eslint@latest eslint-plugin-json@latest \
+        markdownlint-cli@latest \
         prettier@latest
 """
 

scripts/format-code.sh

@@ -34,6 +34,7 @@ LINTERS_ALL=( \
         eslint \
         flake8 \
         isort \
+        markdownlint \
         prettier \
         shellcheck \
     )
@@ -209,6 +210,16 @@ function do_isort() {
     isort --profile black "$@"
 }
 
+LINTER_REQUIRE+=([markdownlint]="markdownlint;.markdownlint.yaml;${CONFIG_PATH}/markdownlint.yaml")
+LINTER_IGNORE+=([markdownlint]=".markdownlint-ignore")
+LINTER_TYPES+=([markdownlint]="markdown")
+function do_markdownlint() {
+    markdownlint --config "${LINTER_CONFIG[markdownlint]}" \
+        --disable line-length -- "$@" || \
+        echo -e "    ${YELLOW}Failed markdownlint; temporarily ignoring."
+    # We disable line-length because prettier should handle prose wrap for us.
+}
+
 LINTER_REQUIRE+=([prettier]="prettier;.prettierrc.yaml;${CONFIG_PATH}/prettierrc.yaml")
 LINTER_IGNORE+=([prettier]=".prettierignore")
 LINTER_TYPES+=([prettier]="json;markdown;yaml")