Merge pull request #1089 from elverytr/elverytr

feat(back): #1087 enable custom rulesets for the lintMarkdown builtin

docs/src/api/builtins/lint.md

@@ -161,9 +161,12 @@ Types:
 - moduleType (`submodule`):
     - config (`str`): Optional.
         Path to the config file.
-        Defaults to [config.rb](/src/evaluator/modules/lint-markdown/config.rb).
+        Defaults to [config.rb](https://github.com/fluidattacks/makes/blob/main/src/evaluator/modules/lint-markdown/config.rb).
     - targets (`listOf str`): Required.
         paths to lint with `config`.
+    - rulesets (`str`): Optional.
+        Path to the custom rulesets file.
+        Defaults to [rulesets.rb](https://github.com/fluidattacks/makes/blob/main/src/evaluator/modules/lint-markdown/rulesets.rb).
 
 Example:
 
@@ -175,6 +178,8 @@ Example:
         all = {
           # You can pass custom configs like this:
           # config = "/src/config/markdown.rb";
+          # You can pass custom rules like this:
+          # rulesets = "/src/config/rulesets.rb";
           targets = [ "/" ];
         };
         others = {

src/args/lint-markdown/builder.sh

@@ -6,7 +6,7 @@ function main {
   info Linting Markdown code \
     && for target in "${targets[@]}"; do
       info Linting "${target}" \
-        && mdl --ignore-front-matter --style "${envConfig}" "${target}" \
+        && mdl --ignore-front-matter --style "${envConfig}" --rulesets "${envRulesets}" "${target}" \
         || return 1
     done \
     && touch "${out}"

src/args/lint-markdown/default.nix

@@ -7,11 +7,13 @@
   name,
   config,
   targets,
+  rulesets,
 }:
 makeDerivation {
   env = {
     envConfig = config;
     envTargets = toBashArray targets;
+    envRulesets = rulesets;
   };
   name = "lint-markdown-for-${name}";
   searchPaths = {

src/evaluator/modules/lint-markdown/default.nix

@@ -11,6 +11,7 @@
   makeOutput = name: {
     config,
     targets,
+    rulesets,
   }: {
     name = "/lintMarkdown/${name}";
     value = lintMarkdown {
@@ -20,6 +21,10 @@
         then ./config.rb
         else projectPath config;
       targets = builtins.map projectPath targets;
+      rulesets =
+        if rulesets == null
+        then ./rulesets.rb
+        else projectPath rulesets;
     };
   };
 in {
@@ -35,6 +40,10 @@ in {
           targets = lib.mkOption {
             type = lib.types.listOf lib.types.str;
           };
+          rulesets = lib.mkOption {
+            default = null;
+            type = lib.types.nullOr lib.types.str;
+          };
         };
       }));
     };

src/evaluator/modules/lint-markdown/rulesets.rb

@@ -0,0 +1 @@
+# Set custom rule sets here