Skip to content

x/tools/go/analysis: Add end position if present for the analysis JSON output for Diagnostics #504

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+11 −6
Open

x/tools/go/analysis: Add end position if present for the analysis JSON output for Diagnostics #504

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fc1f80
add end position for JSON analysis output
madneal Jul 13, 2024
b9d688b
fix for the unittest
madneal Jul 27, 2024
9bb63dd
ignore end_posn field when not present
madneal Aug 2, 2024
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
17 changes: 11 additions & 6 deletions go/analysis/internal/analysisflags/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,22 +363,20 @@ type JSONSuggestedFix struct {
}

// A JSONDiagnostic describes the JSON schema of an analysis.Diagnostic.
//
// TODO(matloob): include End position if present.
type JSONDiagnostic struct {
Category string `json:"category,omitempty"`
Posn string `json:"posn"` // e.g. "file.go:line:column"
EndPosn string `json:"end_posn,omitempty"`
Message string `json:"message"`
SuggestedFixes []JSONSuggestedFix `json:"suggested_fixes,omitempty"`
Related []JSONRelatedInformation `json:"related,omitempty"`
}

// A JSONRelated describes a secondary position and message related to
// a primary diagnostic.
//
// TODO(adonovan): include End position if present.
type JSONRelatedInformation struct {
Posn string `json:"posn"` // e.g. "file.go:line:column"
EndPosn string `json:"end_posn,omitempty"`
Message string `json:"message"`
}

Expand Down Expand Up @@ -412,10 +410,14 @@ func (tree JSONTree) Add(fset *token.FileSet, id, name string, diags []analysis.
}
var related []JSONRelatedInformation
for _, r := range f.Related {
related = append(related, JSONRelatedInformation{
relatedInfo := JSONRelatedInformation{
Posn: fset.Position(r.Pos).String(),
Message: r.Message,
})
}
if r.End != token.NoPos {
relatedInfo.EndPosn = fset.Position(r.End).String()
}
related = append(related, relatedInfo)
}
jdiag := JSONDiagnostic{
Category: f.Category,
Expand All @@ -424,6 +426,9 @@ func (tree JSONTree) Add(fset *token.FileSet, id, name string, diags []analysis.
SuggestedFixes: fixes,
Related: related,
}
if f.End != token.NoPos {
jdiag.EndPosn = fset.Position(f.End).String()
}
diagnostics = append(diagnostics, jdiag)
}
v = diagnostics
Expand Down