raw

Documentation

Overview

Package raw implements raw access to Oyafiles, allowing for access without actually parsing the files. This allows for working with incorrect Oyafiles (e.g. with invalid imports) as long as they are well-formed YAML files.

Index

• Constants
• func InitDir(dirPath string) error
• type DecodedOyafile
  • func (lhs DecodedOyafile) Merge(rhs DecodedOyafile) DecodedOyafile
• type ErrNotRootOyafile
  • func (e ErrNotRootOyafile) Error() string
• type Oyafile
  • func Load(oyafilePath, rootDir string) (*Oyafile, bool, error)
  • func LoadFromDir(dirPath, rootDir string) (*Oyafile, bool, error)
  • func New(oyafilePath, rootDir string) (*Oyafile, error)
  • func (raw *Oyafile) AddImport(alias, uri string) error
  • func (raw *Oyafile) AddRequire(pack Pack) error
  • func (raw *Oyafile) Decode() (DecodedOyafile, error)
  • func (raw *Oyafile) IsRoot() (bool, error)
  • func (raw *Oyafile) LookupKey(key string) (interface{}, bool, error)
• type Pack
• Bugs

Constants

const DefaultName = "Oyafile"

Functions

func InitDir

func InitDir(dirPath string) error

Types

type DecodedOyafile

type DecodedOyafile template.Scope

DecodedOyafile is an Oyafile that has been loaded from YAML but hasn't been parsed yet.

func (DecodedOyafile) Merge

func (lhs DecodedOyafile) Merge(rhs DecodedOyafile) DecodedOyafile

type ErrNotRootOyafile

type ErrNotRootOyafile struct {
	Path string
}

func (ErrNotRootOyafile) Error

func (e ErrNotRootOyafile) Error() string

type Oyafile

type Oyafile struct {
	Path    string // Path contains normalized absolute path.
	RootDir string // RootDir is the absolute, normalized path to the project root directory.
	// contains filtered or unexported fields
}

Oyafile represents an unparsed Oyafile.

func Load

func Load(oyafilePath, rootDir string) (*Oyafile, bool, error)

func LoadFromDir

func LoadFromDir(dirPath, rootDir string) (*Oyafile, bool, error)

func New

func New(oyafilePath, rootDir string) (*Oyafile, error)

func (*Oyafile) AddImport

func (raw *Oyafile) AddImport(alias, uri string) error

func (*Oyafile) AddRequire

func (raw *Oyafile) AddRequire(pack Pack) error

AddRequire adds a Require: entry for the pack.

func (*Oyafile) Decode

func (raw *Oyafile) Decode() (DecodedOyafile, error)

func (*Oyafile) IsRoot

func (raw *Oyafile) IsRoot() (bool, error)

func (*Oyafile) LookupKey

func (raw *Oyafile) LookupKey(key string) (interface{}, bool, error)

type Pack

type Pack interface {
	ImportPath() types.ImportPath
	Version() semver.Version
}

Notes

Bugs

• This is slightly brittle because it will match any line that ends with the uri. It might be a good idea to add a raw.(*Oyafile).matchesWithin function along the lines of how insertBeforeWithin is written.

• Use raw access.