status

Documentation

Index

• type ComplexScope
  • func (s ComplexScope) PathList() []string
  • func (s ComplexScope) Submodules() []submodule
• type Index
  • func (s Index) Checksum() string
  • func (s Index) PathList() []string
  • func (s Index) Submodules() []submodule
• type Result
  • func Status(ctx context.Context, workTreeDir string) (r Result, err error)
  • func (r *Result) IndexWithWorktree() Scope
  • func (r *Result) PathList() (result []string)
• type Scope
• type Worktree
  • func (s Worktree) PathList() []string
  • func (s Worktree) Submodules() []submodule

Types

type ComplexScope

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

func (ComplexScope) PathList

func (s ComplexScope) PathList() []string

func (ComplexScope) Submodules

func (s ComplexScope) Submodules() []submodule

type Index

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

func (Index) Checksum

func (s Index) Checksum() string

func (Index) PathList

func (s Index) PathList() []string

func (Index) Submodules

func (s Index) Submodules() []submodule

type Result

type Result struct {
	Index             Index
	Worktree          Worktree
	UntrackedPathList []string
}

func Status

func Status(ctx context.Context, workTreeDir string) (r Result, err error)

Status returns Result with path lists of untracked files and modified files for index and worktree. The function counts each file status as Modified if it is not Unmodified or Untracked ([ADU] == M). The function does not work with ignored, renamed and copied files.

func (*Result) IndexWithWorktree

func (r *Result) IndexWithWorktree() Scope

func (*Result) PathList

func (r *Result) PathList() (result []string)

PathList returns a list of changed files

type Scope

type Scope interface {
	PathList() []string
	Submodules() []submodule
}

type Worktree

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

func (Worktree) PathList

func (s Worktree) PathList() []string

func (Worktree) Submodules

func (s Worktree) Submodules() []submodule