parser

type Directive ¶

type Directive struct {
	Name     string
	Value    string
	Location []Range
}

type DirectiveParser ¶ added in v0.11.0

type DirectiveParser struct {
	// contains filtered or unexported fields
}

DirectiveParser is a parser for Dockerfile directives that enforces the quirks of the directive parser.

func (d *DirectiveParser) ParseAll(data []byte) ([]*Directive, error)

func (d *DirectiveParser) ParseLine(line []byte) (*Directive, error)

type ErrorLocation ¶ added in v0.8.0

type ErrorLocation struct {
	Locations [][]Range
	// contains filtered or unexported fields
}

ErrorLocation gives a location in source code that caused the error

func (e *ErrorLocation) Unwrap() error

type Heredoc ¶ added in v0.9.0

type Heredoc struct {
	Name           string
	FileDescriptor uint
	Expand         bool
	Chomp          bool
	Content        string
}

func MustParseHeredoc(src string) *Heredoc

func ParseHeredoc(src string) (*Heredoc, error)

type Node ¶

type Node struct {
	Value       string          // actual content
	Next        *Node           // the next item in the current sexp
	Children    []*Node         // the children of this sexp
	Heredocs    []Heredoc       // extra heredoc content attachments
	Attributes  map[string]bool // special attributes for this node
	Original    string          // original line used before parsing
	Flags       []string        // only top Node should have this set
	StartLine   int             // the line in the original dockerfile where the node begins
	EndLine     int             // the line in the original dockerfile where the node ends
	PrevComment []string
}

Node is a structure used to represent a parse tree.

In the node there are three fields, Value, Next, and Children. Value is the current token's string value. Next is always the next non-child token, and children contains all the children. Here's an example:

(value next (child child-next child-next-next) next-next)

This data structure is frankly pretty lousy for handling complex languages, but lucky for us the Dockerfile isn't very complicated. This structure works a little more effectively than a "proper" parse tree for our needs.

func (node *Node) AddChild(child *Node, startLine, endLine int)

func (node *Node) Dump() string

func (node *Node) Location() []Range

type Position ¶ added in v0.8.0

type Position struct {
	Line      int
	Character int
}

Position is a point in source code

type Range ¶ added in v0.8.0

type Range struct {
	Start Position
	End   Position
}

Range is a code section between two positions

func DetectSyntax(dt []byte) (string, string, []Range, bool)

type Result ¶

type Result struct {
	AST         *Node
	EscapeToken rune
	Warnings    []Warning
}

Result contains the bundled outputs from parsing a Dockerfile.

func Parse(rwc io.Reader) (*Result, error)

func (r *Result) PrintWarnings(out io.Writer)

type Warning ¶ added in v0.10.0

type Warning struct {
	Short    string
	Detail   [][]byte
	URL      string
	Location *Range
}

Warning contains information to identify and locate a warning generated during parsing.