models

Documentation

Index

• type Branch
  • func (b *Branch) Description() string
  • func (b *Branch) HasCommitsToPull() bool
  • func (b *Branch) HasCommitsToPush() bool
  • func (b *Branch) ID() string
  • func (b *Branch) IsRealBranch() bool
  • func (b *Branch) IsTrackingRemote() bool
  • func (b *Branch) MatchesUpstream() bool
  • func (b *Branch) RefName() string
• type Commit
  • func (c *Commit) Description() string
  • func (c *Commit) ID() string
  • func (c *Commit) IsMerge() bool
  • func (c *Commit) RefName() string
  • func (c *Commit) ShortSha() string
• type CommitFile
  • func (f *CommitFile) Description() string
  • func (f *CommitFile) ID() string
• type File
  • func (f *File) Description() string
  • func (f *File) GetHasStagedChanges() bool
  • func (f *File) GetHasUnstagedChanges() bool
  • func (f *File) GetIsTracked() bool
  • func (f *File) GetPath() string
  • func (f *File) ID() string
  • func (f *File) IsRename() bool
  • func (f *File) IsSubmodule(configs []*SubmoduleConfig) bool
  • func (f *File) Matches(f2 *File) bool
  • func (f *File) Names() []string
  • func (f *File) SubmoduleConfig(configs []*SubmoduleConfig) *SubmoduleConfig
• type IFile
• type Remote
  • func (r *Remote) Description() string
  • func (r *Remote) ID() string
  • func (r *Remote) RefName() string
• type RemoteBranch
  • func (r *RemoteBranch) Description() string
  • func (r *RemoteBranch) FullName() string
  • func (r *RemoteBranch) ID() string
  • func (r *RemoteBranch) RefName() string
• type StashEntry
  • func (s *StashEntry) Description() string
  • func (s *StashEntry) ID() string
  • func (s *StashEntry) RefName() string
• type SubmoduleConfig
  • func (r *SubmoduleConfig) Description() string
  • func (r *SubmoduleConfig) ID() string
  • func (r *SubmoduleConfig) RefName() string
• type Tag
  • func (t *Tag) Description() string
  • func (t *Tag) ID() string
  • func (t *Tag) RefName() string

Types

type Branch

type Branch struct {
	Name string
	// the displayname is something like '(HEAD detached at 123asdf)', whereas in that case the name would be '123asdf'
	DisplayName  string
	Recency      string
	Pushables    string
	Pullables    string
	UpstreamName string
	Head         bool
}

Branch : A git branch duplicating this for now

func (*Branch) Description

func (b *Branch) Description() string

func (*Branch) HasCommitsToPull

func (b *Branch) HasCommitsToPull() bool

func (*Branch) HasCommitsToPush

func (b *Branch) HasCommitsToPush() bool

func (*Branch) ID

func (b *Branch) ID() string

func (*Branch) IsRealBranch

func (b *Branch) IsRealBranch() bool

for when we're in a detached head state

func (*Branch) IsTrackingRemote

func (b *Branch) IsTrackingRemote() bool

this method does not consider the case where the git config states that a branch is tracking the config. The Pullables value here is based on whether or not we saw an upstream when doing `git branch`

func (*Branch) MatchesUpstream

func (b *Branch) MatchesUpstream() bool

func (*Branch) RefName

func (b *Branch) RefName() string

type Commit

type Commit struct {
	Sha           string
	Name          string
	Status        string // one of "unpushed", "pushed", "merged", "rebasing" or "selected"
	Action        string // one of "", "pick", "edit", "squash", "reword", "drop", "fixup"
	Tags          []string
	ExtraInfo     string // something like 'HEAD -> master, tag: v0.15.2'
	Author        string
	UnixTimestamp int64

	// SHAs of parent commits (will be multiple if it's a merge commit)
	Parents []string
}

Commit : A git commit

func (*Commit) Description

func (c *Commit) Description() string

func (*Commit) ID

func (c *Commit) ID() string

func (*Commit) IsMerge

func (c *Commit) IsMerge() bool

func (*Commit) RefName

func (c *Commit) RefName() string

func (*Commit) ShortSha

func (c *Commit) ShortSha() string

type CommitFile

type CommitFile struct {
	// TODO: rename this to Path
	Name string

	ChangeStatus string // e.g. 'A' for added or 'M' for modified. This is based on the result from git diff --name-status
}

CommitFile : A git commit file

func (*CommitFile) Description

func (f *CommitFile) Description() string

func (*CommitFile) ID

func (f *CommitFile) ID() string

type File

type File struct {
	Name                    string
	PreviousName            string
	HasStagedChanges        bool
	HasUnstagedChanges      bool
	Tracked                 bool
	Added                   bool
	Deleted                 bool
	HasMergeConflicts       bool
	HasInlineMergeConflicts bool
	DisplayString           string
	Type                    string // one of 'file', 'directory', and 'other'
	ShortStatus             string // e.g. 'AD', ' A', 'M ', '??'
}

File : A file from git status duplicating this for now

func (*File) Description

func (f *File) Description() string

func (*File) GetHasStagedChanges

func (f *File) GetHasStagedChanges() bool

func (*File) GetHasUnstagedChanges

func (f *File) GetHasUnstagedChanges() bool

func (*File) GetIsTracked

func (f *File) GetIsTracked() bool

func (*File) GetPath

func (f *File) GetPath() string

func (*File) ID

func (f *File) ID() string

func (*File) IsRename

func (f *File) IsRename() bool

func (*File) IsSubmodule

func (f *File) IsSubmodule(configs []*SubmoduleConfig) bool

func (*File) Matches

func (f *File) Matches(f2 *File) bool

returns true if the file names are the same or if a a file rename includes the filename of the other

func (*File) Names

func (f *File) Names() []string

Names returns an array containing just the filename, or in the case of a rename, the after filename and the before filename

func (*File) SubmoduleConfig

func (f *File) SubmoduleConfig(configs []*SubmoduleConfig) *SubmoduleConfig

type IFile

type IFile interface {
	GetHasUnstagedChanges() bool
	GetHasStagedChanges() bool
	GetIsTracked() bool
	GetPath() string
}

sometimes we need to deal with either a node (which contains a file) or an actual file

type Remote

type Remote struct {
	Name     string
	Urls     []string
	Branches []*RemoteBranch
}

Remote : A git remote

func (*Remote) Description

func (r *Remote) Description() string

func (*Remote) ID

func (r *Remote) ID() string

func (*Remote) RefName

func (r *Remote) RefName() string

type RemoteBranch

type RemoteBranch struct {
	Name       string
	RemoteName string
}

Remote Branch : A git remote branch

func (*RemoteBranch) Description

func (r *RemoteBranch) Description() string

func (*RemoteBranch) FullName

func (r *RemoteBranch) FullName() string

func (*RemoteBranch) ID

func (r *RemoteBranch) ID() string

func (*RemoteBranch) RefName

func (r *RemoteBranch) RefName() string

type StashEntry

type StashEntry struct {
	Index int
	Name  string
}

StashEntry : A git stash entry

func (*StashEntry) Description

func (s *StashEntry) Description() string

func (*StashEntry) ID

func (s *StashEntry) ID() string

func (*StashEntry) RefName

func (s *StashEntry) RefName() string

type SubmoduleConfig

type SubmoduleConfig struct {
	Name string
	Path string
	Url  string
}

func (*SubmoduleConfig) Description

func (r *SubmoduleConfig) Description() string

func (*SubmoduleConfig) ID

func (r *SubmoduleConfig) ID() string

func (*SubmoduleConfig) RefName

func (r *SubmoduleConfig) RefName() string

type Tag

type Tag struct {
	Name string
}

Tag : A git tag

func (*Tag) Description

func (t *Tag) Description() string

func (*Tag) ID

func (t *Tag) ID() string

func (*Tag) RefName

func (t *Tag) RefName() string