From 2cbf5c26ac1f81c740df862626145f5e1d6b2770 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bartek=20Iwa=C5=84czuk?= <biwanczuk@gmail.com>
Date: Sat, 14 Nov 2020 20:51:30 +0100
Subject: feat(lint): support --rules --json (#8384)

This commit adds support for "--json" flag in combination
with "--rules". List of rules is serialized to JSON and printed.
---
 cli/lint.rs | 27 +++++++++++++++++++++------
 cli/main.rs |  2 +-
 2 files changed, 22 insertions(+), 7 deletions(-)

(limited to 'cli')

diff --git a/cli/lint.rs b/cli/lint.rs
index 02cf269c9..1ac680bac 100644
--- a/cli/lint.rs
+++ b/cli/lint.rs
@@ -96,14 +96,29 @@ pub async fn lint_files(
   Ok(())
 }
 
-pub fn print_rules_list() {
+fn rule_to_json(rule: Box<dyn LintRule>) -> serde_json::Value {
+  serde_json::json!({
+    "code": rule.code(),
+    "tags": rule.tags(),
+    "docs": rule.docs(),
+  })
+}
+
+pub fn print_rules_list(json: bool) {
   let lint_rules = rules::get_recommended_rules();
 
-  // The rules should still be printed even if `--quiet` option is enabled,
-  // so use `println!` here instead of `info!`.
-  println!("Available rules:");
-  for rule in lint_rules {
-    println!(" - {}", rule.code());
+  if json {
+    let json_rules: Vec<serde_json::Value> =
+      lint_rules.into_iter().map(rule_to_json).collect();
+    let json_str = serde_json::to_string_pretty(&json_rules).unwrap();
+    println!("{}", json_str);
+  } else {
+    // The rules should still be printed even if `--quiet` option is enabled,
+    // so use `println!` here instead of `info!`.
+    println!("Available rules:");
+    for rule in lint_rules {
+      println!(" - {}", rule.code());
+    }
   }
 }
 
diff --git a/cli/main.rs b/cli/main.rs
index 752e2e5a5..87e817cf0 100644
--- a/cli/main.rs
+++ b/cli/main.rs
@@ -229,7 +229,7 @@ async fn lint_command(
   }
 
   if list_rules {
-    lint::print_rules_list();
+    lint::print_rules_list(json);
     return Ok(());
   }
 
-- 
cgit v1.2.3