Lock version of markdownlint-cli and fix violations (#398)

* Lock version of markdownlint-cli and fix violations markdownlint-cli was using a floating version, and since this linter was introduced additional rules have been added so now the linting fails on the master branch. Lock the version to the currently latest version and disable the rule that we didn't comply with (since addressing it properly would be rather intrusive). Co-authored-by: Mattias Linnér <[email protected]>
eiffel-community · May 16, 2024 · 42229f8 · 42229f8
1 parent 8ab5e01
commit 42229f8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.markdown-lint.yml b/.markdown-lint.yml
@@ -30,6 +30,11 @@
 # Rules by tags #
 #################
 
+# MD041/first-line-heading/first-line-h1
+# First line in a file being a top-level heading collides with starting
+# each file with a copyright statement.
+first-line-h1: false # Affects 45 files
+
 # MD013/line-length - Line length
 line-length:
     line_length: 900 # Arbitrary length to catch the worst. Setting this to 120 affects 500 lines

diff --git a/tox.ini b/tox.ini
@@ -79,4 +79,4 @@ changedir = {toxinidir}
 allowlist_externals =
     npx
 commands =
-    npx markdownlint-cli -c .markdown-lint.yml *.md **/*.md
+    npx markdownlint-cli@v0.34.0 -c .markdown-lint.yml *.md **/*.md