lint

Documentation

Index

• Constants
• Variables
• func PrintLintViolations(dt []byte, w io.Writer, scb SourceInfoMap) error
• type BuildError
• type LintResults
  • func (results *LintResults) AddSource(sourceMap *llb.SourceMap) int
  • func (results *LintResults) AddWarning(rulename, description, url, fmtmsg string, sourceIndex int, ...)
  • func (results *LintResults) PrintErrorTo(w io.Writer, scb SourceInfoMap)
  • func (results *LintResults) PrintTo(w io.Writer, scb SourceInfoMap) error
  • func (results *LintResults) ToResult(scb SourceInfoMap) (*client.Result, error)
• type SourceInfoMap
• type Warning
  • func (w *Warning) PrintTo(wr io.Writer, sources []*pb.SourceInfo, scb SourceInfoMap) error

Constants

const RequestLint = "frontend.lint"

Variables

var SubrequestLintDefinition = subrequests.Request{
	Name:        RequestLint,
	Version:     "1.0.0",
	Type:        subrequests.TypeRPC,
	Description: "Lint a Dockerfile",
	Opts:        []subrequests.Named{},
	Metadata: []subrequests.Named{
		{Name: "result.json"},
		{Name: "result.txt"},
		{Name: "result.statuscode"},
	},
}

Functions

func PrintLintViolations

func PrintLintViolations(dt []byte, w io.Writer, scb SourceInfoMap) error

Types

type BuildError

type BuildError struct {
	Message  string      `json:"message"`
	Location pb.Location `json:"location"`
}

type LintResults

type LintResults struct {
	Warnings []Warning        `json:"warnings"`
	Sources  []*pb.SourceInfo `json:"sources"`
	Error    *BuildError      `json:"buildError,omitempty"`
}

func (*LintResults) AddSource

func (results *LintResults) AddSource(sourceMap *llb.SourceMap) int

func (*LintResults) AddWarning

func (results *LintResults) AddWarning(rulename, description, url, fmtmsg string, sourceIndex int, location []parser.Range)

func (*LintResults) PrintErrorTo

func (results *LintResults) PrintErrorTo(w io.Writer, scb SourceInfoMap)

func (*LintResults) PrintTo

func (results *LintResults) PrintTo(w io.Writer, scb SourceInfoMap) error

func (*LintResults) ToResult

func (results *LintResults) ToResult(scb SourceInfoMap) (*client.Result, error)

type SourceInfoMap

type SourceInfoMap func(*pb.SourceInfo) *pb.SourceInfo

type Warning

type Warning struct {
	RuleName    string       `json:"ruleName"`
	Description string       `json:"description,omitempty"`
	URL         string       `json:"url,omitempty"`
	Detail      string       `json:"detail,omitempty"`
	Location    *pb.Location `json:"location,omitempty"`
}

func (*Warning) PrintTo

func (w *Warning) PrintTo(wr io.Writer, sources []*pb.SourceInfo, scb SourceInfoMap) error