project

Documentation

Index

• Constants
• type FileTargetSpec
• type Spec
  • func ReadFromFile(p string) (Spec, error)
  • func ReadFromYAML(src io.Reader) (Spec, error)

Constants

const SpecFileName = "sg-project.yaml"

SpecFileName is the default name of the project specification file.

Types

type FileTargetSpec

type FileTargetSpec struct {
	// Name - name of the target.
	Name string `json:"name"`
	// Paths - paths to the targets to check.
	Paths []string `json:"paths"`
	// Policies - paths to the policy to load.
	Policies strListOrMap `json:"policies"`
	// Data - paths to the (extra) data to load.
	Data []string `json:"data"`
}

FileTargetSpec defines the specification of a file target. Without further specification, paths are relative to the context root which is defined during execution.

NOTE: we should always use json tag here, please see the comment in ReadFromYAML for context.

type Spec

type Spec struct {
	Files []FileTargetSpec `json:"files"`
}

Spec defines the project specification.

func ReadFromFile

func ReadFromFile(p string) (Spec, error)

ReadFromFile reads a project specification from a file.

func ReadFromYAML

func ReadFromYAML(src io.Reader) (Spec, error)

ReadFromYAML reads a project specification from YAML.