project

Documentation

Index

• func GetCodeBlocks(filepath string, allowUnknown bool, allowUnnamed bool, fs billy.Basic) (document.CodeBlocks, error)
• func GetCodeBlocksAndParseFrontmatter(filepath string, allowUnknown bool, allowUnnamed bool, fs billy.Basic) (document.CodeBlocks, document.Frontmatter, error)
• func GetCurrentGitEmail(cwd string) (string, error)
• func ReadMarkdownFile(filepath string, fs billy.Basic) ([]byte, error)
• type Branch
  • func GetBranchNames(cwd string) ([]Branch, error)
  • func GetRepoBranches() ([]Branch, error)
  • func GetUsersBranchNames(cwd string, email string) ([]Branch, error)
  • func GetUsersBranches(repoUser string) ([]Branch, error)
• type CodeBlock
  • func (b CodeBlock) Clone() *CodeBlock
  • func (b CodeBlock) GetBlock() *document.CodeBlock
  • func (b CodeBlock) GetFile() string
  • func (b CodeBlock) GetFileRel() string
  • func (b CodeBlock) GetFrontmatter() document.Frontmatter
  • func (b CodeBlock) GetID() string
• type CodeBlockFS
• type CodeBlocks
  • func (blocks CodeBlocks) Lookup(queryName string) []CodeBlock
  • func (blocks CodeBlocks) LookupByFile(queryFile string) ([]CodeBlock, error)
  • func (blocks CodeBlocks) LookupByID(query string) ([]CodeBlock, error)
  • func (blocks CodeBlocks) LookupWithFile(queryFile string, queryName string) ([]CodeBlock, error)
  • func (blocks CodeBlocks) Names() []string
• type DirectoryProject
  • func NewDirectoryProject(dir string, findNearestRepo bool, allowUnknown bool, allowUnnamed bool, ...) (*DirectoryProject, error)
  • func (p *DirectoryProject) Dir() string
  • func (p *DirectoryProject) EnvLoadOrder() []string
  • func (p *DirectoryProject) LoadEnvs() (map[string]string, error)
  • func (p *DirectoryProject) LoadTasks() (CodeBlocks, error)
  • func (p *DirectoryProject) SetEnvLoadOrder(envLoadOrder []string)
  • func (p *DirectoryProject) SetRespectGitignore(respectGitignore bool)
• type DirectoryProjectMatcher
  • func (m *DirectoryProjectMatcher) Match(path []string, isDir bool) bool
• type ErrCodeBlockFileNotFound
  • func (e ErrCodeBlockFileNotFound) Error() string
  • func (e ErrCodeBlockFileNotFound) FailedFileQuery() string
• type ErrCodeBlockNameNotFound
  • func (e ErrCodeBlockNameNotFound) Error() string
  • func (e ErrCodeBlockNameNotFound) FailedNameQuery() string
• type FileCodeBlock
• type Project
• type Resolver
  • func NewResolver(dir string) *Resolver
• type SingleFileProject
  • func NewSingleFileProject(file string, allowUnknown bool, allowUnnamed bool) *SingleFileProject
  • func (p *SingleFileProject) Dir() string
  • func (p *SingleFileProject) EnvLoadOrder() []string
  • func (p *SingleFileProject) LoadEnvs() (map[string]string, error)
  • func (p *SingleFileProject) LoadTasks() (CodeBlocks, error)

Functions

func GetCodeBlocks

func GetCodeBlocks(filepath string, allowUnknown bool, allowUnnamed bool, fs billy.Basic) (document.CodeBlocks, error)

func GetCodeBlocksAndParseFrontmatter

func GetCodeBlocksAndParseFrontmatter(filepath string, allowUnknown bool, allowUnnamed bool, fs billy.Basic) (document.CodeBlocks, document.Frontmatter, error)

func GetCurrentGitEmail

func GetCurrentGitEmail(cwd string) (string, error)

func ReadMarkdownFile

func ReadMarkdownFile(filepath string, fs billy.Basic) ([]byte, error)

Types

type Branch

type Branch struct {
	Name        string
	Description string
}

func GetBranchNames

func GetBranchNames(cwd string) ([]Branch, error)

func GetRepoBranches

func GetRepoBranches() ([]Branch, error)

func GetUsersBranchNames

func GetUsersBranchNames(cwd string, email string) ([]Branch, error)

func GetUsersBranches

func GetUsersBranches(repoUser string) ([]Branch, error)

type CodeBlock

type CodeBlock struct {
	Block       *document.CodeBlock
	File        string
	Frontmatter document.Frontmatter
	// contains filtered or unexported fields
}

func (CodeBlock) Clone

func (b CodeBlock) Clone() *CodeBlock

func (CodeBlock) GetBlock

func (b CodeBlock) GetBlock() *document.CodeBlock

func (CodeBlock) GetFile

func (b CodeBlock) GetFile() string

func (CodeBlock) GetFileRel

func (b CodeBlock) GetFileRel() string

func (CodeBlock) GetFrontmatter

func (b CodeBlock) GetFrontmatter() document.Frontmatter

func (CodeBlock) GetID

func (b CodeBlock) GetID() string

type CodeBlockFS

type CodeBlockFS interface {
	billy.Basic
	billy.Chroot
}

type CodeBlocks

type CodeBlocks []CodeBlock

func (CodeBlocks) Lookup

func (blocks CodeBlocks) Lookup(queryName string) []CodeBlock

func (CodeBlocks) LookupByFile

func (blocks CodeBlocks) LookupByFile(queryFile string) ([]CodeBlock, error)

func (CodeBlocks) LookupByID

func (blocks CodeBlocks) LookupByID(query string) ([]CodeBlock, error)

func (CodeBlocks) LookupWithFile

func (blocks CodeBlocks) LookupWithFile(queryFile string, queryName string) ([]CodeBlock, error)

func (CodeBlocks) Names

func (blocks CodeBlocks) Names() []string

type DirectoryProject

type DirectoryProject struct {
	// contains filtered or unexported fields
}

func NewDirectoryProject

func NewDirectoryProject(dir string, findNearestRepo bool, allowUnknown bool, allowUnnamed bool, ignorePatterns []string) (*DirectoryProject, error)

func (*DirectoryProject) Dir

func (p *DirectoryProject) Dir() string

func (*DirectoryProject) EnvLoadOrder

func (p *DirectoryProject) EnvLoadOrder() []string

func (*DirectoryProject) LoadEnvs

func (p *DirectoryProject) LoadEnvs() (map[string]string, error)

func (*DirectoryProject) LoadTasks

func (p *DirectoryProject) LoadTasks() (CodeBlocks, error)

func (*DirectoryProject) SetEnvLoadOrder

func (p *DirectoryProject) SetEnvLoadOrder(envLoadOrder []string)

func (*DirectoryProject) SetRespectGitignore

func (p *DirectoryProject) SetRespectGitignore(respectGitignore bool)

type DirectoryProjectMatcher

type DirectoryProjectMatcher struct {
	// contains filtered or unexported fields
}

TODO(mxs): support `.runmeignore` file

func (*DirectoryProjectMatcher) Match

func (m *DirectoryProjectMatcher) Match(path []string, isDir bool) bool

type ErrCodeBlockFileNotFound

type ErrCodeBlockFileNotFound struct {
	// contains filtered or unexported fields
}

func (ErrCodeBlockFileNotFound) Error

func (e ErrCodeBlockFileNotFound) Error() string

func (ErrCodeBlockFileNotFound) FailedFileQuery

func (e ErrCodeBlockFileNotFound) FailedFileQuery() string

type ErrCodeBlockNameNotFound

type ErrCodeBlockNameNotFound struct {
	// contains filtered or unexported fields
}

func (ErrCodeBlockNameNotFound) Error

func (e ErrCodeBlockNameNotFound) Error() string

func (ErrCodeBlockNameNotFound) FailedNameQuery

func (e ErrCodeBlockNameNotFound) FailedNameQuery() string

type FileCodeBlock

type FileCodeBlock interface {
	GetBlock() *document.CodeBlock

	// relative to project root
	GetFileRel() string

	// absolute file path
	GetFile() string
	GetFrontmatter() document.Frontmatter
}

type Project

type Project interface {
	LoadTasks() (CodeBlocks, error)
	LoadEnvs() (map[string]string, error)
	EnvLoadOrder() []string
	Dir() string
}

type Resolver

type Resolver struct {
	// contains filtered or unexported fields
}

func NewResolver

func NewResolver(dir string) *Resolver

type SingleFileProject

type SingleFileProject struct {
	// contains filtered or unexported fields
}

func NewSingleFileProject

func NewSingleFileProject(file string, allowUnknown bool, allowUnnamed bool) *SingleFileProject

func (*SingleFileProject) Dir

func (p *SingleFileProject) Dir() string

func (*SingleFileProject) EnvLoadOrder

func (p *SingleFileProject) EnvLoadOrder() []string

func (*SingleFileProject) LoadEnvs

func (p *SingleFileProject) LoadEnvs() (map[string]string, error)

func (*SingleFileProject) LoadTasks

func (p *SingleFileProject) LoadTasks() (CodeBlocks, error)