gitw

Documentation

Index

• func BranchesWithRemotes() (map[string]string, error)
• func CurrentBranch() string
• func DefaultBranch(remote string) (string, error)
• func HasFile(segments ...string) bool
• func IsGitDir() bool
• func LocalBranches() ([]string, error)
• func RemoteFromHead() (string, error)
• type Range
  • func NewRange(a, b string) (*Range, error)
  • func (r *Range) IsAncestor() bool
  • func (r *Range) IsIdentical() bool

Functions

func BranchesWithRemotes

func BranchesWithRemotes() (map[string]string, error)

BranchesWithRemotes uses the Git config to determine which branches also exist on the remotes. Returns a list of branches.

func CurrentBranch

func CurrentBranch() string

CurrentBranch gets the current local branch.

func DefaultBranch

func DefaultBranch(remote string) (string, error)

DefaultBranch gets the default branch (like main) from the remote refs.

func HasFile

func HasFile(segments ...string) bool

func IsGitDir

func IsGitDir() bool

IsGitDir checks if the current working directory containers a .git folder.

func LocalBranches

func LocalBranches() ([]string, error)

LocalBranches gets a list of all local branches as a slice of strings.

func RemoteFromHead

func RemoteFromHead() (string, error)

RemoteFromHead gets the remote where the HEAD is.

Types

type Range

type Range struct {
	A string
	B string
}

func NewRange

func NewRange(a, b string) (*Range, error)

func (*Range) IsAncestor

func (r *Range) IsAncestor() bool

func (*Range) IsIdentical

func (r *Range) IsIdentical() bool