golangci-lint/pkg/printers/codeclimate.go
2023-06-04 07:59:04 +02:00

60 lines
1.5 KiB
Go

package printers
import (
"encoding/json"
"io"
"github.com/golangci/golangci-lint/pkg/result"
)
const defaultCodeClimateSeverity = "critical"
// CodeClimateIssue is a subset of the Code Climate spec.
// https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types
// It is just enough to support GitLab CI Code Quality.
// https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html
type CodeClimateIssue struct {
Description string `json:"description"`
Severity string `json:"severity,omitempty"`
Fingerprint string `json:"fingerprint"`
Location struct {
Path string `json:"path"`
Lines struct {
Begin int `json:"begin"`
} `json:"lines"`
} `json:"location"`
}
type CodeClimate struct {
w io.Writer
}
func NewCodeClimate(w io.Writer) *CodeClimate {
return &CodeClimate{w: w}
}
func (p CodeClimate) Print(issues []result.Issue) error {
codeClimateIssues := make([]CodeClimateIssue, 0, len(issues))
for i := range issues {
issue := &issues[i]
codeClimateIssue := CodeClimateIssue{}
codeClimateIssue.Description = issue.Description()
codeClimateIssue.Location.Path = issue.Pos.Filename
codeClimateIssue.Location.Lines.Begin = issue.Pos.Line
codeClimateIssue.Fingerprint = issue.Fingerprint()
codeClimateIssue.Severity = defaultCodeClimateSeverity
if issue.Severity != "" {
codeClimateIssue.Severity = issue.Severity
}
codeClimateIssues = append(codeClimateIssues, codeClimateIssue)
}
err := json.NewEncoder(p.w).Encode(codeClimateIssues)
if err != nil {
return err
}
return nil
}