docs: add in schema for the new errorReports field in Doctor

scalameta · Oct 25, 2023 · e8f9cf7 · e8f9cf7
1 parent 13e8ed1
commit e8f9cf7
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/metals/src/main/scala/scala/meta/internal/metals/ClientCommands.scala b/metals/src/main/scala/scala/meta/internal/metals/ClientCommands.scala
@@ -68,6 +68,8 @@ object ClientCommands {
         |   messages?: DoctorRecommendation[];
         |   /** Explanations for the various statuses present in the doctor */
         |   explanations?: DoctorExplanation[];
+        |   /** Error reports reported from Metals */
+        |   errorReports: ErrorReportInfo[];
         |}
         |```
         |```json
@@ -130,6 +132,22 @@ object ClientCommands {
         |  recommendations: string[]
         |}
         |```
+        |```json
+        |export interface ErrorReportInfo {
+        |  /** Display name of the error */
+        |  name: string;
+        |  /** Timestamp of the report creation date */
+        |  timestamp: number;
+        |  /** Error report file uri */
+        |  uri: string;
+        |  /** Build target that the error is associated with */
+        |  buildTarget?: string;
+        |  /** Short error summary */
+        |  shortSummary: string;
+        |  /** The type of error -- This can be metals, metals-full, or bloop currently */
+        |  errorReportType: string;
+        |}
+        |```
         |""".stripMargin,
     arguments =
       """`string`, the HTML to display in the focused window.""".stripMargin,