docker

Documentation

Index

• type Command
• type Parser
  • func (p *Parser) GetCommentToken() string
  • func (p *Parser) GetKind() model.FileKind
  • func (p *Parser) GetResolvedFiles() map[string]model.ResolvedFile
  • func (p *Parser) Parse(_ string, fileContent []byte) ([]model.Document, []int, error)
  • func (p *Parser) Resolve(fileContent []byte, _ string) ([]byte, error)
  • func (p *Parser) StringifyContent(content []byte) (string, error)
  • func (p *Parser) SupportedExtensions() []string
  • func (p *Parser) SupportedTypes() map[string]bool
• type Resource

Types

type Command

type Command struct {
	Cmd       string
	SubCmd    string
	Flags     []string
	Value     []string
	Original  string
	StartLine int `json:"_kics_line"`
	EndLine   int
	JSON      bool
}

Command is the struct for each dockerfile command

type Parser

type Parser struct {
}

Parser is a Dockerfile parser

func (*Parser) GetCommentToken

func (p *Parser) GetCommentToken() string

GetCommentToken return the comment token of Docker - #

func (*Parser) GetKind

func (p *Parser) GetKind() model.FileKind

GetKind returns the kind of the parser

func (*Parser) GetResolvedFiles

func (p *Parser) GetResolvedFiles() map[string]model.ResolvedFile

GetResolvedFiles returns the list of files that are resolved

func (*Parser) Parse

func (p *Parser) Parse(_ string, fileContent []byte) ([]model.Document, []int, error)

Parse - parses dockerfile to Json

func (*Parser) Resolve

func (p *Parser) Resolve(fileContent []byte, _ string) ([]byte, error)

Resolve - replace or modifies in-memory content before parsing

func (*Parser) StringifyContent

func (p *Parser) StringifyContent(content []byte) (string, error)

StringifyContent converts original content into string formatted version

func (*Parser) SupportedExtensions

func (p *Parser) SupportedExtensions() []string

SupportedExtensions returns Dockerfile extensions

func (*Parser) SupportedTypes

func (p *Parser) SupportedTypes() map[string]bool

SupportedTypes returns types supported by this parser, which are dockerfile

type Resource

type Resource struct {
	CommandList map[string][]Command `json:"command"`
	Arguments   []Command            `json:"args"`
}

Resource Separates the list of commands by file