config

Documentation

Index

• Constants
• Variables
• func CreateJigRoot(path string) error
• func FindClosestJigRoot(path string) (string, error)
• func FindJigRoot() (string, error)
• func IsJigRoot(path string) bool
• func JigRootDir(path string) string
• func ManifestPath(dir string) (string, error)
• type Manifest
  • func DefaultManifest(dir string) (*Manifest, error)
  • func FromJSON(r io.Reader) (*Manifest, error)
  • func JigRootManifest() (*Manifest, error)
  • func (m *Manifest) Add(repo *Repo) error
  • func (m *Manifest) Save(dir string) error
  • func (m *Manifest) ToJSON(w io.Writer) error
• type Repo

Constants

const (
	JigDirName = ".jig"
)

Variables

var (
	ManifestName  = "manifest.json"
	ErrNoManifest = errors.New("No manifest exists")
)

var (
	// ErrNoJigRoot is returned when no Jig root can be found
	ErrNoJigRoot = errors.New("Could not find Jig root")
)

Functions

func CreateJigRoot

func CreateJigRoot(path string) error

func FindClosestJigRoot

func FindClosestJigRoot(path string) (string, error)

func FindJigRoot

func FindJigRoot() (string, error)

func IsJigRoot

func IsJigRoot(path string) bool

func JigRootDir

func JigRootDir(path string) string

func ManifestPath

func ManifestPath(dir string) (string, error)

Types

type Manifest

type Manifest struct {
	Repos []*Repo
}

Manifest represents a serialized description of the repositories to check out

func DefaultManifest

func DefaultManifest(dir string) (*Manifest, error)

func FromJSON

func FromJSON(r io.Reader) (*Manifest, error)

FromJSON creates a Manifest from a JSON reader

func JigRootManifest

func JigRootManifest() (*Manifest, error)

func (*Manifest) Add

func (m *Manifest) Add(repo *Repo) error

func (*Manifest) Save

func (m *Manifest) Save(dir string) error

func (*Manifest) ToJSON

func (m *Manifest) ToJSON(w io.Writer) error

type Repo

type Repo struct {
	Repo string
	Ref  string
}