gitrepo

Documentation

Index

• type GitRepo
  • func NewGitRepo(dirPath string) *GitRepo
  • func (g *GitRepo) GetFileCommitLabel(filePath string) (string, error)
  • func (g *GitRepo) IsGitRepo() bool

Types

type GitRepo

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

func NewGitRepo

func NewGitRepo(dirPath string) *GitRepo

NewGitRepo creates new GitRepo struct checks if the given directory path is part of git repository accordingly updates the fields of GitRepo struct and returns it

func (*GitRepo) GetFileCommitLabel

func (g *GitRepo) GetFileCommitLabel(filePath string) (string, error)

getFileCommitLabel returns the value of 'commit' label for the resources present in the file

The value of the `commit` label for different status of the file is as follows: | Git File Status | Label Value | |---------------------------------------|----------------------| | New untracked file | untracked | | New staged file | staged | | Tracked file with changes in worktree | <commitID>-unstaged | | Tracked file with changes staged | <commitID>-staged | | Tracked file with clean commit | <commitID> |

func (*GitRepo) IsGitRepo

func (g *GitRepo) IsGitRepo() bool

IsGitRepo returns if the initialized directory path is tracked by git repo