Lint MarkDown files with mdl

Platoniq · Jun 24, 2024 · 8a721a3 · 8a721a3
1 parent 93fb351
commit 8a721a3
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/.mdl_style.rb b/.mdl_style.rb
@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+all
+
+exclude_rule "first-line-h1"
+
+exclude_rule "line-length"
+
+exclude_rule "no-bare-urls"
+
+exclude_rule "no-inline-html"
+
+exclude_rule "ol-prefix"
+
+exclude_rule "ul-indent"
+
+rule "no-trailing-punctuation", punctuation: ".,;:!"
diff --git a/.mdlrc b/.mdlrc
@@ -0,0 +1 @@
+style ".mdl_style.rb"
diff --git a/Gemfile b/Gemfile
@@ -22,6 +22,7 @@ group :development, :test do
 
   gem "brakeman", "~> 5.4"
   gem "decidim-dev", "0.28.1"
+  gem "mdl"
   gem "net-imap", "~> 0.2.3"
   gem "net-pop", "~> 0.1.1"
   gem "net-smtp", "~> 0.3.1"

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -157,6 +157,8 @@ GEM
       actionpack (>= 5.0)
       cells (>= 4.1.6, < 5.0.0)
     charlock_holmes (0.7.7)
+    chef-utils (18.4.12)
+      concurrent-ruby
     commonmarker (0.23.10)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
@@ -480,6 +482,10 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     launchy (2.5.2)
       addressable (~> 2.8)
     letter_opener (1.8.1)
@@ -502,6 +508,12 @@ GEM
       net-smtp
     marcel (1.0.2)
     matrix (0.4.2)
+    mdl (0.13.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+      mixlib-shellout
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
@@ -510,6 +522,11 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
     minitest (5.20.0)
+    mixlib-cli (2.1.8)
+    mixlib-config (3.0.27)
+      tomlrb
+    mixlib-shellout (3.2.8)
+      chef-utils
     msgpack (1.4.5)
     multi_json (1.15.0)
     multi_xml (0.6.0)
@@ -782,6 +799,7 @@ GEM
     thor (1.3.0)
     tilt (2.1.0)
     timeout (0.4.0)
+    tomlrb (2.0.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uber (0.1.0)
@@ -846,6 +864,7 @@ DEPENDENCIES
   figaro (~> 1.2)
   letter_opener_web (~> 2.0)
   listen (~> 3.1)
+  mdl
   net-imap (~> 0.2.3)
   net-pop (~> 0.1.1)
   net-smtp (~> 0.3.1)