grammar

grammar

import "github.com/tfadeyi/slotalk/internal/parser/specification/sloth/grammar"

Package grammar contains the grammar rules and lexer related to sloth

Index

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

Variables

var (
    ErrMissingRequiredField = errors.New("missing required application field(s)")
    ErrParseSource          = errors.New("error parsing source material")
)

func Eval

func Eval(source string, options ...participle.ParseOption) (*sloth.Spec, error)

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

type Grammar

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

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

type Scope

Scope defines the statement scope, similar to a code function

type Scope struct {
    // Type is the specification struct a statement refers to
    Type  string `(Sloth @((".alerting"(".page"|".ticket")?|".sli"|".slo"))?)`
    Value string `Whitespace* @("service"|"version"|"error_query"|"total_query"|"error_ratio_query"|"name"|"description"|"objective"|"labels"|"annotations"|"disable")`
}

func (Scope) GetType

func (k Scope) GetType() string

GetType returns the type of the statement scope

type Statement

Statement is any comment starting with @sloth keyword

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

Generated by gomarkdoc