vcs.go

package vcsview

// Common interfaces for each one version control system like git, mercurial, etc
type Vcs interface {
	// check for VCS version
	Version() (string, error)

	// Returns pathname for repository config (.git, .hg, etc)
	RepositoryPathname() string

	// Check project repository
	// projectPath is absolute path to project path
	// Returns error if repository not found at provided projectPath
	// Returns nil if repository found
	CheckRepository(projectPath string) error

	// Fetch repository current status
	// Returns error if the repository doesn't exists at specified path
	StatusRepository(projectPath string) (string, error)

	// Create the command which reads branches from repository
	// ProjectPath is a path to project with VCS
	// Result is a channel, which get branches line-by-line
	// To start read run executor Run method
	ReadBranches(projectPath string, result chan Branch) *Executor

	// Create the command which reads commit from repository by commit id
	// ProjectPath is a path to project with VCS
	// CommitId is a commit identifier
	// Result is a channel, whic get commit result
	// To start read run executor Run method
	ReadCommit(projectPath string, commitId string, result chan Commit) *Executor

	// Create the command which reads commits history from repository by commit id
	// ProjectPath is a path to project with VCS
	// Path is a relative file or directory path to read history
	// If need to read whole project path, path should be empty string (not a dot)
	// If need to read history of path in some branch, argument branch should contain branch identifier
	// Offset is number of skipped commits
	// Limit is number of maximum commits to read
	ReadHistory(projectPath string, path string, branch string, offset int, limit int, result chan Commit) *Executor
}