types

Documentation

Overview

Package types contains all the custom types we will use in this program.

Index

• Constants
• type CLIOptions
• type ParsedTokens
• type ReportedVar
  • func (v *ReportedVar) Print(filepath string)

Constants

const (
	Err  = 0
	Warn = 1
	Note = 2
)

Types

type CLIOptions

type CLIOptions struct {
	// up options
	Files           []string
	ExcludeComments bool
	WError          bool
}

CLIOptions stores options we're passing to cobra's CLI args.

type ParsedTokens

type ParsedTokens struct {
	Arguments   map[string]*syntax.Assign
	Assignments map[string]*syntax.Assign
	Comments    []string
	Iters       map[string]*syntax.WordIter
	Variables   []*syntax.Lit
	Function    *syntax.FuncDecl
}

ParsedTokens will keep the results of all the parsing of the function, and will be then used to apply our rules.

type ReportedVar

type ReportedVar struct {
	Subject  *syntax.Lit
	Function *syntax.FuncDecl
	Reason   string
	Level    int
}

ReportedVar is our message to be displayed.

Subject is what is erroring
Function is the context function where Subject is
Reason is a brief description of the problem
Level is the severity from levels.

func (*ReportedVar) Print

func (v *ReportedVar) Print(filepath string)

Print will pretty print our outputs in a Vim compatible way.