issues

Documentation

Overview

package issues can store and report issues found during the bazel-deps-mirror process.

Index

• type ByFile
  • func NewByFile() ByFile
  • func (m ByFile) Add(rule string, issues ...error)
• type Map
  • func New() Map
  • func (m Map) FileHasIssues(file string) bool
  • func (m Map) IssuesPerFile(file string) int
  • func (m Map) IssuesPerRule(file string, rule string) int
  • func (m Map) Report(w io.Writer)
  • func (m Map) Set(file string, issues ByFile)

Types

type ByFile

type ByFile map[string][]error

ByFile is a map of issues belonging to one file arranged by rulename => issues.

func NewByFile

func NewByFile() ByFile

NewByFile creates a new ByFile.

func (ByFile) Add

func (m ByFile) Add(rule string, issues ...error)

Add adds one or more issues belonging to a rule.

type Map

type Map map[string]map[string][]error

Map is a map of issues arranged by path => rulename => issues.

func New

func New() Map

New creates a new Map.

func (Map) FileHasIssues

func (m Map) FileHasIssues(file string) bool

FileHasIssues returns true if the file has any issues.

func (Map) IssuesPerFile

func (m Map) IssuesPerFile(file string) int

IssuesPerFile returns the number of issues for a file.

func (Map) IssuesPerRule

func (m Map) IssuesPerRule(file string, rule string) int

IssuesPerRule returns the number of issues for a rule.

func (Map) Report

func (m Map) Report(w io.Writer)

Report prints all issues to a writer in a human-readable format.

func (Map) Set

func (m Map) Set(file string, issues ByFile)

Set sets all issues for a file.