Add --display-style json2 to allow for more complex outputs being sen…

…t to extensions (#445)

CHANGELOG.md

@@ -2,6 +2,8 @@
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased](https://github.com/Kampfkarren/selene/compare/0.22.0...HEAD)
+### Added
+- Added `--display-style=json2`, which gives the same outputs as `--display-style=json`, but with an extra `type` field so that it can support more than diagnostics. Extensions should move over to `--display-style=json2` as more becomes available for it, but take care to check for `type`. Currently the only possible value is "Diagnostic".
 
 ## [0.22.0](https://github.com/Kampfkarren/selene/releases/tag/0.22.0) - 2022-10-15
 ### Added

docs/src/cli/usage.md

@@ -16,7 +16,7 @@ FLAGS:
 OPTIONS:
         --color <color>                     [default: auto]  [possible values: Always, Auto, Never]
         --config <config>                  A toml file to configure the behavior of selene [default: selene.toml]
-        --display-style <display-style>    Sets the display method [possible values: Json, Rich, Quiet]
+        --display-style <display-style>    Sets the display method [possible values: Json, Json2, Rich, Quiet]
         --num-threads <num-threads>        Number of threads to run on, default to the numbers of logical cores on your
                                            system [default: your system's cores]
         --pattern <pattern>                A glob to match files with to check

selene-vscode/src/extension.ts

@@ -3,7 +3,8 @@ import * as selene from "./selene"
 import * as timers from "timers"
 import * as util from "./util"
 import * as vscode from "vscode"
-import { Diagnostic, Severity, Label } from "./diagnostic"
+import { Diagnostic, Severity, Label } from "./structures/diagnostic"
+import { Output } from "./structures/output"
 
 let trySelene: Promise<boolean>
 
@@ -102,7 +103,7 @@ export async function activate(
 
         const output = await selene.seleneCommand(
             context.globalStorageUri,
-            "--display-style=json --no-summary -",
+            "--display-style=json2 --no-summary -",
             selene.Expectation.Stderr,
             vscode.workspace.getWorkspaceFolder(document.uri),
             document.getText(),
@@ -118,13 +119,18 @@ export async function activate(
         const byteOffsets = new Set<number>()
 
         for (const line of output.split("\n")) {
-            const data: Diagnostic = JSON.parse(line)
-            dataToAdd.push(data)
-            byteOffsets.add(data.primary_label.span.start)
-            byteOffsets.add(data.primary_label.span.end)
-            for (const label of data.secondary_labels) {
-                byteOffsets.add(label.span.start)
-                byteOffsets.add(label.span.end)
+            const output: Output = JSON.parse(line)
+
+            switch (output.type) {
+                case "diagnostic":
+                    dataToAdd.push(output)
+                    byteOffsets.add(output.primary_label.span.start)
+                    byteOffsets.add(output.primary_label.span.end)
+                    for (const label of output.secondary_labels) {
+                        byteOffsets.add(label.span.start)
+                        byteOffsets.add(label.span.end)
+                    }
+                    break
             }
         }
 

selene-vscode/src/roblox.ts

@@ -1,5 +1,5 @@
 import * as vscode from "vscode"
-import { Diagnostic } from "./diagnostic"
+import { Diagnostic } from "./structures/diagnostic"
 import { TextDecoder, TextEncoder } from "util"
 
 const SETUP_CONFIGURATION = "Setup Configuration"

selene-vscode/src/structures/output.ts

@@ -0,0 +1,5 @@
+import { Diagnostic } from "./diagnostic"
+
+export type Output = {
+    type: "diagnostic"
+} & Diagnostic

selene/src/json_output.rs

@@ -4,7 +4,13 @@ use codespan_reporting::diagnostic::{
 use serde::Serialize;
 
 #[derive(Serialize)]
-struct JsonDiagnostic {
+#[serde(tag = "type")]
+pub enum JsonOutput {
+    Diagnostic(JsonDiagnostic),
+}
+
+#[derive(Serialize)]
+pub struct JsonDiagnostic {
     severity: Severity,
     code: Option<String>,
     message: String,
@@ -55,8 +61,8 @@ fn label_to_serializable(
 pub fn diagnostic_to_json(
     diagnostic: &CodespanDiagnostic<codespan::FileId>,
     files: &codespan::Files<&str>,
-) -> serde_json::Result<String> {
-    serde_json::to_string(&JsonDiagnostic {
+) -> JsonDiagnostic {
+    JsonDiagnostic {
         code: diagnostic.code.to_owned(),
         message: diagnostic.message.to_owned(),
         severity: diagnostic.severity.to_owned(),
@@ -71,5 +77,5 @@ pub fn diagnostic_to_json(
             .filter(|label| label.style == LabelStyle::Secondary)
             .map(|label| label_to_serializable(label, files))
             .collect(),
-    })
+    }
 }

selene/src/main.rs

@@ -118,16 +118,32 @@ fn emit_codespan(
         ..Default::default()
     };
 
-    if let Some(opts::DisplayStyle::Json) = opts.display_style {
-        writeln!(
-            writer,
-            "{}",
-            json_output::diagnostic_to_json(diagnostic, files).unwrap()
-        )
-        .unwrap();
-    } else {
-        codespan_reporting::term::emit(writer, config, files, diagnostic)
-            .expect("couldn't emit error to codespan");
+    match opts.display_style {
+        Some(opts::DisplayStyle::Json) => {
+            writeln!(
+                writer,
+                "{}",
+                serde_json::to_string(&json_output::diagnostic_to_json(diagnostic, files)).unwrap()
+            )
+            .unwrap();
+        }
+
+        Some(opts::DisplayStyle::Json2) => {
+            writeln!(
+                writer,
+                "{}",
+                serde_json::to_string(&json_output::JsonOutput::Diagnostic(
+                    json_output::diagnostic_to_json(diagnostic, files)
+                ))
+                .unwrap()
+            )
+            .unwrap();
+        }
+
+        Some(opts::DisplayStyle::Rich) | Some(opts::DisplayStyle::Quiet) | None => {
+            codespan_reporting::term::emit(writer, config, files, diagnostic)
+                .expect("couldn't emit error to codespan");
+        }
     }
 }
 

selene/src/opts.rs

@@ -106,6 +106,7 @@ arg_enum! {
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
     pub enum DisplayStyle {
         Json,
+        Json2,
         Rich,
         Quiet,
     }