constraints

Documentation

Index

• Variables
• func IsEqualityToken(token Token) bool
• func IsJoinToken(token Token) bool
• func IsOperatorToken(token Token) bool
• func IsRangeToken(token Token) bool
• type Constraint
  • func ParseConstraint(constraintString string) (Constraint, error)
  • func (c *Constraint) String() string
• type JoinOp
• type Lexer
  • func (lexer Lexer) ScanOne() (token Token, literal string)
  • func (lexer Lexer) ScanWhole() (tokens []Token, literals []string)
• type Range
  • func (parsedRange Range) String() string
• type SubConstraint
• type Token
  • func LexConstraint(constraint string) (tokens []Token, literals []string)

Variables

var (
	ErrInvalidConstraint            = errors.New("invalid Semantic Version")
	ErrEmptyConstraint              = errors.New("empty constraint")
	ErrIllegalCharacterInConstraint = errors.New("illegal character in constraint")
	ErrInvalidVersion               = errors.New("invalid Version")
)

Functions

func IsEqualityToken

func IsEqualityToken(token Token) bool

func IsJoinToken

func IsJoinToken(token Token) bool

func IsOperatorToken

func IsOperatorToken(token Token) bool

func IsRangeToken

func IsRangeToken(token Token) bool

Types

type Constraint

type Constraint struct {
	Original string
	Ranges   []Range
	Join     []JoinOp
}

func ParseConstraint

func ParseConstraint(constraintString string) (Constraint, error)

Parses a given node semver constraint string into a constraint object

func (*Constraint) String

func (c *Constraint) String() string

type JoinOp

type JoinOp string

const (
	CONJUNCTON  JoinOp = "and"
	DISJUNCTION JoinOp = "or"
)

type Lexer

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

func (Lexer) ScanOne

func (lexer Lexer) ScanOne() (token Token, literal string)

func (Lexer) ScanWhole

func (lexer Lexer) ScanWhole() (tokens []Token, literals []string)

type Range

type Range struct {
	StartOp      Token
	StartVersion version.Semver
	EndOp        Token
	EndVersion   version.Semver
}

func (Range) String

func (parsedRange Range) String() string

type SubConstraint

type SubConstraint struct {
	Ranges Range
}

type Token

type Token string

const (
	// Special tokens
	ILLEGAL Token = "ILLEGAL"
	EOF     Token = "EOF"
	SOF     Token = "SOF"
	WS      Token = "WS"

	// Keywords
	EQ                 Token = "EQ"                // =
	LT                 Token = "LT"                // <
	LE                 Token = "LE"                // <=
	GT                 Token = "GT"                // >
	GE                 Token = "GE"                // >=
	NOT                Token = "NOT"               // !
	TILDE              Token = "TILDE"             // ~
	CARET              Token = "CARET"             // ^
	OPEN_PARENTHESIS   Token = "OPEN_PARENTHESIS"  // (
	CLOSE_PARENTHESIS  Token = "CLOSE_PARENTHESIS" // )
	AND                Token = "AND"               // &&
	OR                 Token = "OR"                // ||
	HYPHEN             Token = "HYPHEN"            // -
	STAR               Token = "STAR"              // *
	ANY                Token = "ANY"               // ANY
	WILDCARD_X         Token = "WILDCARD_X"        // X
	CONSTRAINT         Token = "CONSTRAINT"
	UNKNOW_IDENTIFIER  Token = "UNKNOW_IDENTIFIER"
	VERSION_EXPRESSION Token = "VERSION_EXPRESSION"
)

func LexConstraint

func LexConstraint(constraint string) (tokens []Token, literals []string)