Skip to content

docs(linter/plugins): improve JSDoc comment for DiagnosticReport #19103

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

Merged
graphite-app merged 1 commit into from
Feb 7, 2026
Merged

docs(linter/plugins): improve JSDoc comment for DiagnosticReport #19103

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
8 changes: 5 additions & 3 deletions apps/oxlint/src-js/plugins/report.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,19 @@ export interface SuggestionReport {
fixes: FixReport[];
}

// Diagnostic in form sent to Rust.
// Actually, the `messageId` field is removed before sending to Rust.
/**
* Diagnostic in form sent to Rust.
*/
export interface DiagnosticReport {
message: string;
start: number;
end: number;
ruleIndex: number;
fixes: FixReport[] | null;
suggestions: SuggestionReport[] | null;
// Not needed on Rust side, but `RuleTester` needs it
messageId: string | null;
// Only used in conformance tests
// Only used in conformance tests. This field is not present except in conformance build.
loc?: LocationWithOptionalEnd | null;
}

Expand Down
Loading