Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Oct 26, 2023
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions metals/src/main/scala/scala/meta/internal/metals/ClientCommands.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down