checks

Documentation

Index

• Variables
• func RunChecksInParallel(checks []Check, checkInput CheckInput, errHandler func(error)) chan []CheckFinding
• func SeverityLevelToName(level int) string
• func SeverityNameToLevel(name string) int
• type Check
  • func AllChecks() []Check
• type CheckFinding
  • func (cf *CheckFinding) Compare(o CheckFinding) int
  • func (cf *CheckFinding) Location() (string, error)
  • func (cf *CheckFinding) SeverityName() string
• type CheckInput
• type CiYaml
  • func NewCiYaml(content []byte) (*CiYaml, error)
• type GitlabPagesJobCheck
  • func (g GitlabPagesJobCheck) Run(i *CheckInput) ([]CheckFinding, error)
• type PipelineLintApiCheck
  • func (p PipelineLintApiCheck) Run(i *CheckInput) ([]CheckFinding, error)
• type ShellScriptCheck
  • func (s ShellScriptCheck) Run(i *CheckInput) ([]CheckFinding, error)

Variables

var SeverityError = 0

var SeverityInfo = 2

var SeverityStyle = 3

var SeverityWarning = 1

Functions

func RunChecksInParallel

func RunChecksInParallel(checks []Check, checkInput CheckInput, errHandler func(error)) chan []CheckFinding

RunChecksInParallel for the given input and handle errors with the callback provided Output is provided in a unbuffered channel that is closed once all checks finished

func SeverityLevelToName

func SeverityLevelToName(level int) string

func SeverityNameToLevel

func SeverityNameToLevel(name string) int

Types

type Check

type Check interface {
	// Run the check
	Run(i *CheckInput) ([]CheckFinding, error)
}

Check that runs verifications

func AllChecks

func AllChecks() []Check

AllChecks available

type CheckFinding

type CheckFinding struct {
	Severity int
	Code     string
	Line     int
	Message  string
	Link     string
	File     string
}

func (*CheckFinding) Compare

func (cf *CheckFinding) Compare(o CheckFinding) int

func (*CheckFinding) Location

func (cf *CheckFinding) Location() (string, error)

func (*CheckFinding) SeverityName

func (cf *CheckFinding) SeverityName() string

type CheckInput

type CheckInput struct {
	CiYaml        *CiYaml
	Configuration *cli.Configuration
}

type CiYaml

type CiYaml struct {
	FileContent   []byte
	ParsedYamlMap map[string]any
	ParsedYamlDoc *yaml.Node
}

func NewCiYaml

func NewCiYaml(content []byte) (*CiYaml, error)

NewCiYaml from byte contents

type GitlabPagesJobCheck

type GitlabPagesJobCheck struct{}

func (GitlabPagesJobCheck) Run

func (g GitlabPagesJobCheck) Run(i *CheckInput) ([]CheckFinding, error)

type PipelineLintApiCheck

type PipelineLintApiCheck struct {
}

func (PipelineLintApiCheck) Run

func (p PipelineLintApiCheck) Run(i *CheckInput) ([]CheckFinding, error)

type ShellScriptCheck

type ShellScriptCheck struct {
}

func (ShellScriptCheck) Run

func (s ShellScriptCheck) Run(i *CheckInput) ([]CheckFinding, error)