Makes JSON output consistent

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1] - 2020-11-04
+### Fixed
+- Fixed `--display-style=json` giving an output incompatible with previous tooling.
+
 ## [0.9.0] - 2020-11-04
 ### Added
 - Arguments that aren't required can now be filled with nil.

selene-lib/src/rules.rs

@@ -125,7 +125,7 @@ impl Diagnostic {
             code: Some(self.code.to_owned()),
             labels,
             message: self.message.to_owned(),
-            notes: self.notes.to_owned(),
+            notes: self.notes,
             severity,
         }
     }

selene/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "selene"
-version = "0.9.0"
+version = "0.9.1"
 license = "MPL-2.0"
 authors = ["Kampfkarren <kampfkarren@gmail.com>"]
 description = "A blazing-fast modern Lua linter written in Rust"

selene/src/json_output.rs

@@ -0,0 +1,54 @@
+use codespan_reporting::diagnostic::{
+    Diagnostic as CodespanDiagnostic, Label as CodespanLabel, LabelStyle, Severity,
+};
+use serde::Serialize;
+
+#[derive(Serialize)]
+struct JsonDiagnostic {
+    severity: Severity,
+    code: Option<String>,
+    message: String,
+    primary_label: Label,
+    notes: Vec<String>,
+    secondary_labels: Vec<Label>,
+}
+
+#[derive(Serialize)]
+struct Label {
+    span: Span,
+    message: String,
+}
+
+#[derive(Serialize)]
+struct Span {
+    start: usize,
+    end: usize,
+}
+
+fn label_to_serializable<T>(label: &CodespanLabel<T>) -> Label {
+    Label {
+        message: label.message.to_owned(),
+        span: Span {
+            start: label.range.start,
+            end: label.range.end,
+        },
+    }
+}
+
+pub fn diagnostic_to_json(
+    diagnostic: &CodespanDiagnostic<codespan::FileId>,
+) -> serde_json::Result<String> {
+    serde_json::to_string(&JsonDiagnostic {
+        code: diagnostic.code.to_owned(),
+        message: diagnostic.message.to_owned(),
+        severity: diagnostic.severity.to_owned(),
+        notes: diagnostic.notes.to_owned(),
+        primary_label: label_to_serializable(diagnostic.labels.first().expect("no labels passed")),
+        secondary_labels: diagnostic
+            .labels
+            .iter()
+            .filter(|label| label.style == LabelStyle::Secondary)
+            .map(label_to_serializable)
+            .collect(),
+    })
+}

selene/src/main.rs

@@ -21,6 +21,7 @@ use structopt::{clap, StructOpt};
 use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};
 use threadpool::ThreadPool;
 
+mod json_output;
 mod opts;
 #[cfg(feature = "roblox")]
 mod roblox;
@@ -112,7 +113,12 @@ fn emit_codespan(
     };
 
     if opts.display_style == opts::DisplayStyle::Json {
-        writeln!(writer, "{}", serde_json::to_string(&diagnostic).unwrap()).unwrap();
+        writeln!(
+            writer,
+            "{}",
+            json_output::diagnostic_to_json(diagnostic).unwrap()
+        )
+        .unwrap();
     } else {
         codespan_reporting::term::emit(writer, &config, files, diagnostic)
             .expect("couldn't emit error to codespan");