helpers

Documentation

Index

• Constants
• func Ensure(root string) error
• func JoinCwd(segments ...string) string
• func Log() string
• func Normalise(p string) string
• func Path(parent, relative string) string
• func Reason(name string) string
• func Repo(relative string) string
• func Root() string
• type CustomFilter
  • func (f *CustomFilter) Description() string
  • func (f *CustomFilter) IsApplicable(item *nav.TraverseItem) bool
  • func (f *CustomFilter) IsMatch(item *nav.TraverseItem) bool
  • func (f *CustomFilter) Scope() nav.FilterScopeBiEnum
  • func (f *CustomFilter) Source() string
  • func (f *CustomFilter) Validate()
• type Directory
• type File
• type Tree

Constants

const DO_WRITE = true

Functions

func Ensure

func Ensure(root string) error

func JoinCwd

func JoinCwd(segments ...string) string

func Log

func Log() string

func Normalise

func Normalise(p string) string

func Path

func Path(parent, relative string) string

func Reason

func Reason(name string) string

func Repo

func Repo(relative string) string

func Root

func Root() string

Types

type CustomFilter

type CustomFilter struct {
	Name  string
	Value string
}

func (*CustomFilter) Description

func (f *CustomFilter) Description() string

func (*CustomFilter) IsApplicable

func (f *CustomFilter) IsApplicable(item *nav.TraverseItem) bool

func (*CustomFilter) IsMatch

func (f *CustomFilter) IsMatch(item *nav.TraverseItem) bool

func (*CustomFilter) Scope

func (f *CustomFilter) Scope() nav.FilterScopeBiEnum

func (*CustomFilter) Source

func (f *CustomFilter) Source() string

func (*CustomFilter) Validate

func (f *CustomFilter) Validate()

type Directory

type Directory struct {
	XMLName     xml.Name    `xml:"directory"`
	Name        string      `xml:"name,attr"`
	Files       []File      `xml:"file"`
	Directories []Directory `xml:"directory"`
}

type File

type File struct {
	XMLName xml.Name `xml:"file"`
	Name    string   `xml:"name,attr"`
	Text    string   `xml:",chardata"`
}

type Tree

type Tree struct {
	XMLName xml.Name  `xml:"tree"`
	Root    Directory `xml:"directory"`
}