tmmd

Documentation

Index

• func CreateYamlBlockExtension(blocks ...string) *yamlBlockExt
• func GetErrors(pc parser.Context) []error
• func GetItems(name string, factory func() interface{}, pc parser.Context) []interface{}
• type TMBlockRenderer
  • func (r *TMBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type YamlData
  • func Get(pc parser.Context) *YamlData
• type YamlNode
  • func NewYamlNode(kind gast.NodeKind) *YamlNode
  • func (n *YamlNode) Dump(source []byte, level int)
  • func (n *YamlNode) IsRaw() bool
  • func (n *YamlNode) Kind() gast.NodeKind

Functions

func CreateYamlBlockExtension

func CreateYamlBlockExtension(blocks ...string) *yamlBlockExt

Threat is an extension to allow for documenting threat modeling threats.

func GetErrors

func GetErrors(pc parser.Context) []error

Returns any errors found while parsing YAML

func GetItems

func GetItems(name string, factory func() interface{}, pc parser.Context) []interface{}

Get returns YAML items

Types

type TMBlockRenderer

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

func (*TMBlockRenderer) RegisterFuncs

func (r *TMBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type YamlData

type YamlData struct {
	Data map[string][]interface{}
	// TODO better error handling
	Errors []error
}

func Get

func Get(pc parser.Context) *YamlData

Get returns a YAML metadata.

type YamlNode

type YamlNode struct {
	gast.BaseBlock
	// contains filtered or unexported fields
}

A TaskCheckBox struct represents a checkbox of a task list.

func NewYamlNode

func NewYamlNode(kind gast.NodeKind) *YamlNode

Returns a new ThreatNode

func (*YamlNode) Dump

func (n *YamlNode) Dump(source []byte, level int)

Dump implements Node.Dump.

func (*YamlNode) IsRaw

func (n *YamlNode) IsRaw() bool

IsRaw seems to prevent any child nodes from being parsed

func (*YamlNode) Kind

func (n *YamlNode) Kind() gast.NodeKind

Kind implements Node.Kind.