spec

Documentation

Index

• Variables
• type Framework
• type Php
• type Scope
  • func (s *Scope) GetFiles() ([]string, error)
• type Specification
  • func New(specificationFile string) (*Specification, error)

Variables

var ErrScopeWithoutExcludes = func(index int) error {
	return errors.New(fmt.Sprintf("scope does not have excludes: index %d", index))
}

var ErrScopeWithoutIncludes = func(index int) error {
	return errors.New(fmt.Sprintf("scope does not have includes: index %d", index))
}

var ErrScopeWithoutName = func(index int) error {
	return errors.New(fmt.Sprintf("scope does not have a name: index %d", index))
}

var ErrScopeWithoutPath = func(index int) error {
	return errors.New(fmt.Sprintf("scope does not have a path: index %d", index))
}

var ErrSpecWithoutPhpSettings = errors.New("specification without Php settings")

var ErrSpecWithoutScopes = errors.New("specification without scopes")

var ErrUnsupportedPhpVersion = errors.New("unsupported Php version")

Types

type Framework

type Framework struct {
	Name    string
	Version string
}

type Php

type Php struct {
	Version   string
	Framework *Framework
}

type Scope

type Scope struct {
	Name     string
	Path     string
	Includes []string
	Excludes []string
}

func (*Scope) GetFiles

func (s *Scope) GetFiles() ([]string, error)

type Specification

type Specification struct {
	PHP    *Php
	Scopes []Scope `toml:"Scope"`
}

func New

func New(specificationFile string) (*Specification, error)