codeclimate

Documentation

Index

• Constants
• type Category
• type Content
• type Issue
  • func NewIssue(checkName, description string, categories []Category, location Location) (*Issue, error)
• type LineAndColumn
• type Lines
  • func (l Lines) String() string
• type Location
  • func (l Location) String() string
• type Offset
• type Position
• type Positions
• type Severity
• type Trace

Constants

const (
	BugRisk       Category = "Bug Risk"
	Clarity       Category = "Clarity"
	Compatibility Category = "Compatibility"
	Complexity    Category = "Complexity"
	Duplication   Category = "Duplication"
	Performance   Category = "Performance"
	Security      Category = "Security"
	Style         Category = "Style"

	Info     Severity = "info"
	Minor    Severity = "minor"
	Major    Severity = "major"
	Critical Severity = "critical"
	Blocker  Severity = "blocker"
)

Types

type Category

type Category string

type Content

type Content struct {
	Body string `json:"body"`
}

type Issue

type Issue struct {
	Type              string     `json:"type"`
	CheckName         string     `json:"check_name"`
	Description       string     `json:"description"`
	Content           *Content   `json:"content,omitempty"`
	Categories        []Category `json:"categories"`
	Location          Location   `json:"location"`
	OtherLocations    []Location `json:"other_locations,omitempty"`
	Trace             *Trace     `json:"trace,omitempty"`
	RemediationPoints uint64     `json:"remediation_points,omitempty"`
	Severity          Severity   `json:"severity,omitempty"`
	Fingerprint       string     `json:"fingerprint,omitempty"`
}

func NewIssue

func NewIssue(
	checkName, description string,
	categories []Category,
	location Location,
) (*Issue, error)

type LineAndColumn

type LineAndColumn struct{}

type Lines

type Lines struct {
	Begin uint64 `json:"begin,omitempty"`
	End   uint64 `json:"end,omitempty"`
}

func (Lines) String

func (l Lines) String() string

type Location

type Location struct {
	Path  string `json:"path"`
	Lines Lines  `json:"lines,omitempty"`
}

func (Location) String

func (l Location) String() string

type Offset

type Offset struct{}

type Position

type Position interface{}

type Positions

type Positions struct {
	Begin Position `json:"begin,omitempty"`
	End   Position `json:"end,omitempty"`
}

type Severity

type Severity string

type Trace

type Trace struct {
	Locations  []Location `json:"locations,omitempty"`
	Stacktrace bool       `json:"stacktrace,omitempty"`
}