grammar

Documentation

Index

• func Eval(source string, options ...participle.ParseOption) (*api.Manifest, error)
• type Grammar
• type Scope
  • func (k Scope) GetType() string
• type Statement

Functions

func Eval

func Eval(source string, options ...participle.ParseOption) (*api.Manifest, error)

Eval evaluates the source input against the grammar and returns an instance of *sloth.spec

Types

type Grammar

type Grammar struct {
	// Stmts is a list of Sloth grammar Statements
	Stmts []*Statement `@@*`
}

Grammar is the participle grammar use to parse the Sloth comment groups in source files

type Scope

type Scope struct {
	// Type is the specification struct a statement refers to
	Type  string `(Fyi @((".error" (".suggestion")? ))?)`
	Value string `` /* 128-byte string literal not displayed */
}

Scope defines the statement scope, similar to a code function

func (Scope) GetType

func (k Scope) GetType() string

GetType returns the type of the statement scope

type Statement

type Statement struct {
	Scope Scope  `@@`
	Value string `Whitespace* @(String (Whitespace|EOL)*)+`
}

Statement is any comment starting with @sloth keyword