repository

Documentation

Index

• Variables
• type Branch
• type BranchOptions
• type Brancher
• type Commit
• type Configer
• type Description
• type Head
• type Header
• type Refs
• type Remoter
• type Repository
  • func New() *Repository
  • func (r *Repository) Apply(c Commit) error
  • func (r *Repository) Branch() (Branch, error)
  • func (r *Repository) Describe() (Description, error)
  • func (r *Repository) Head() (Head, error)
  • func (r *Repository) IgnoreGlobalConfig()
  • func (r *Repository) Open() error
  • func (r *Repository) Remotes() ([]string, error)
  • func (r *Repository) Users() ([]User, error)
  • func (r *Repository) Worktree() (Worktree, error)
• type User
• type Worktree
  • func (w *Worktree) IsStaged() bool
• type Worktreer

Variables

var ErrLocalBranchNotFound = errors.New("local branch not found")

Types

type Branch

type Branch struct {
	Local  string
	Remote string
	Refs   Refs
}

type BranchOptions

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

type Brancher

type Brancher interface {
	Configer
	Head() (*plumbing.Reference, error)
	References() (storer.ReferenceIter, error)
	TagObject(plumbing.Hash) (*object.Tag, error)
}

type Commit

type Commit struct {
	Author      string
	Subject     string
	Body        string
	Footer      string
	Amend       bool
	DryRun      bool
	File        bool
	MessageFile string
}

type Configer

type Configer interface {
	Config() (*config.Config, error)
}

type Description

type Description struct {
	Users    []User
	Remotes  []string
	Head     Head
	Branch   Branch
	Worktree Worktree
}

type Head

type Head struct {
	Hash    string
	Author  User
	When    time.Time
	Message string
}

type Header

type Header interface {
	Head() (*plumbing.Reference, error)
	CommitObject(h plumbing.Hash) (*object.Commit, error)
}

type Refs

type Refs struct {
	Locals  []string
	Remotes []string
	Tags    []string
}

type Remoter

type Remoter interface {
	Remotes() ([]*git.Remote, error)
}

type Repository

type Repository struct {
	Opener       func(string, *git.PlainOpenOptions) (*git.Repository, error)
	Runner       func(io.Writer, string, []string) error
	OpenFiler    func(string, int, os.FileMode) (*os.File, error)
	GlobalConfig func(config.Scope) (*config.Config, error)
	Configer     Configer
	Remoter      Remoter
	Header       Header
	Brancher     Brancher
	Worktreer    Worktreer
}

func New

func New() *Repository

func (*Repository) Apply

func (r *Repository) Apply(c Commit) error

func (*Repository) Branch

func (r *Repository) Branch() (Branch, error)

func (*Repository) Describe

func (r *Repository) Describe() (Description, error)

func (*Repository) Head

func (r *Repository) Head() (Head, error)

func (*Repository) IgnoreGlobalConfig

func (r *Repository) IgnoreGlobalConfig()

func (*Repository) Open

func (r *Repository) Open() error

func (*Repository) Remotes

func (r *Repository) Remotes() ([]string, error)

func (*Repository) Users

func (r *Repository) Users() ([]User, error)

func (*Repository) Worktree

func (r *Repository) Worktree() (Worktree, error)

type User

type User struct {
	Name    string `yaml:"name,omitempty"`
	Email   string `yaml:"email,omitempty"`
	Default bool   `yaml:"default,omitempty"`
}

type Worktree

type Worktree struct {
	Status git.Status
}

func (*Worktree) IsStaged

func (w *Worktree) IsStaged() bool

type Worktreer

type Worktreer interface {
	Worktree() (*git.Worktree, error)
}