vcs

package
v0.3.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 6, 2026 License: BSD-3-Clause Imports: 14 Imported by: 1

README

vcs

Package vcs provides a more complete version control system (ex: git) interface, building on Masterminds/vcs.

It adds the following methods on top of what is available in Masterminds/vcs:

  • Files: files in the repository, and their FileStatus

  • Add, Move, Delete, CommitFile, RevertFile: manipulate files in the repository.

  • Log, CommitDesc, Blame: details on prior commits

The total interface is now sufficient for complete management of a VCS.

Current Status

Only git and svn are currently supported in vcs; other repositories supported in vcs include Mercurial (Hg) and Bazaar (Bzr); contributions from users of those VCS's are welcome.

Documentation

Overview

Package vcs provides a more complete version control system (ex: git) interface, building on https://github.com/Masterminds/vcs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Commit 

type Commit struct {

	// revision number / hash code / unique id
	Rev string

	// date (author's time) when committed
	Date string

	// author's name
	Author string

	// author's email
	Email string

	// message / subject line for commit
	Message string `width:"100"`
}

Commit is one VCS commit entry, as returned in a Log.

type FileStatus 

type FileStatus int32 //enums:enum

FileStatus indicates the status of files in the repository 

const (
	// Untracked means file is not under VCS control
	Untracked FileStatus = iota

	// Stored means file is stored under VCS control, and has not been modified in working copy
	Stored

	// Modified means file is under VCS control, and has been modified in working copy
	Modified

	// Added means file has just been added to VCS but is not yet committed
	Added

	// Deleted means file has been deleted from VCS
	Deleted

	// Conflicted means file is in conflict -- has not been merged
	Conflicted

	// Updated means file has been updated in the remote but not locally
	Updated
)
const FileStatusN FileStatus = 7

FileStatusN is the highest valid value for type FileStatus, plus one.

func FileStatusValues 

func FileStatusValues() []FileStatus

FileStatusValues returns all possible values for the type FileStatus.

func (FileStatus) Desc 

func (i FileStatus) Desc() string

Desc returns the description of the FileStatus value.

func (FileStatus) Int64 

func (i FileStatus) Int64() int64

Int64 returns the FileStatus value as an int64.

func (FileStatus) MarshalText 

func (i FileStatus) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*FileStatus) SetInt64 

func (i *FileStatus) SetInt64(in int64)

SetInt64 sets the FileStatus value from an int64.

func (*FileStatus) SetString 

func (i *FileStatus) SetString(s string) error

SetString sets the FileStatus value from its string representation, and returns an error if the string is invalid.

func (FileStatus) String 

func (i FileStatus) String() string

String returns the string representation of this FileStatus value.

func (*FileStatus) UnmarshalText 

func (i *FileStatus) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (FileStatus) Values 

func (i FileStatus) Values() []enums.Enum

Values returns all possible values for the type FileStatus.

type Files 

type Files map[string]FileStatus

Files is a map used for storing files in a repository along with their status

func (*Files) Status 

func (fl *Files) Status(repo Repo, fname string) FileStatus

Status returns the VCS file status associated with given filename, returning Untracked if not found and safe to empty map.

type GitRepo 

type GitRepo struct {
	vcs.GitRepo

	sync.Mutex
	// contains filtered or unexported fields
}

func (*GitRepo) Add 

func (gr *GitRepo) Add(fname string) error

Add adds the file to the repo

func (*GitRepo) Blame 

func (gr *GitRepo) Blame(fname string) ([]byte, error)

Blame returns an annotated report about the file, showing which revision last modified each line.

func (*GitRepo) CommitDesc 

func (gr *GitRepo) CommitDesc(rev string, diffs bool) ([]byte, error)

CommitDesc returns the full textual description of the given commit, if rev is empty, defaults to current HEAD, -1, -2 etc also work as universal ways of specifying prior revisions. Optionally includes diffs for the changes (otherwise just a list of files with modification status).

func (*GitRepo) CommitFile 

func (gr *GitRepo) CommitFile(fname string, message string) error

CommitFile commits single file to repo staging

func (*GitRepo) Delete 

func (gr *GitRepo) Delete(fname string) error

Delete removes the file from the repo; uses "force" option to ensure deletion

func (*GitRepo) DeleteRemote 

func (gr *GitRepo) DeleteRemote(fname string) error

Delete removes the file from the repo

func (*GitRepo) FileContents 

func (gr *GitRepo) FileContents(fname string, rev string) ([]byte, error)

FileContents returns the contents of given file, as a []byte array at given revision specifier. -1, -2 etc also work as universal ways of specifying prior revisions.

func (*GitRepo) Files 

func (gr *GitRepo) Files(onUpdated func(f Files)) (Files, error)

Files returns a map of the current files and their status, using a cached version of the file list if available. nil will be returned immediately if no cache is available. The given onUpdated function will be called from a separate goroutine when the updated list of the files is available, if an update is not already under way. An update is always triggered if no files have yet been cached, even if the function is nil.

func (*GitRepo) FilesChanged added in v0.2.0 

func (gr *GitRepo) FilesChanged(revA, revB string, diffs bool) ([]byte, error)

FilesChanged returns the list of files changed and their statuses, between two revisions. If revA is empty, defaults to current HEAD; revB defaults to HEAD-1. -1, -2 etc also work as universal ways of specifying prior revisions. Optionally includes diffs for the changes.

func (*GitRepo) Log 

func (gr *GitRepo) Log(fname string, since string) (Log, error)

Log returns the log history of commits for given filename (or all files if empty). If since is non-empty, it should be a date-like expression that the VCS will understand, such as 1/1/2020, yesterday, last year, etc

func (*GitRepo) Move 

func (gr *GitRepo) Move(oldpath, newpath string) error

Move moves updates the repo with the rename

func (*GitRepo) RevertFile 

func (gr *GitRepo) RevertFile(fname string) error

RevertFile reverts a single file to last commit of master

func (*GitRepo) Status 

func (gr *GitRepo) Status(fname string) (FileStatus, string)

Status returns status of given file; returns Untracked on any error.

func (*GitRepo) StatusFast added in v0.3.11 

func (gr *GitRepo) StatusFast(fname string) FileStatus

StatusFast returns file status based on the cached file info, which might be slightly stale. Much faster than Status. Returns Untracked if no cached files.

func (*GitRepo) Type added in v0.3.2 

func (gr *GitRepo) Type() Types

func (*GitRepo) UpdateVersion added in v0.3.4 

func (s *GitRepo) UpdateVersion(version string) error

UpdateVersion sets the version of a package currently checked out via Git.

type Log 

type Log []*Commit

Log is a listing of commits.

func (*Log) Add 

func (lg *Log) Add(rev, date, author, email, message string) *Commit

Add adds a new Commit to the Log, returning the Commit.

type Repo 

type Repo interface {
	vcs.Repo

	// Type returns the type of repo we are using
	Type() Types

	// Files returns a map of the current files and their status,
	// using a cached version of the file list if available.
	// nil will be returned immediately if no cache is available.
	// The given onUpdated function will be called from a separate
	// goroutine when the updated list of the files is available
	// (an update is always triggered even if the function is nil).
	Files(onUpdated func(f Files)) (Files, error)

	// StatusFast returns file status based on the cached file info,
	// which might be slightly stale. Much faster than Status.
	// Returns Untracked if no cached files.
	StatusFast(fname string) FileStatus

	// Status returns status of given file -- returns Untracked and error
	// message on any error. FileStatus is a summary status category,
	// and string return value is more detailed status information formatted
	// according to standard conventions of given VCS.
	Status(fname string) (FileStatus, string)

	// Add adds the file to the repo
	Add(fname string) error

	// Move moves the file using VCS command to keep it updated
	Move(oldpath, newpath string) error

	// Delete removes the file from the repo and working copy.
	// Uses "force" option to ensure deletion.
	Delete(fname string) error

	// DeleteRemote removes the file from the repo but keeps the local file itself
	DeleteRemote(fname string) error

	// CommitFile commits a single file
	CommitFile(fname string, message string) error

	// RevertFile reverts a single file to the version that it was last in VCS,
	// losing any local changes (destructive!)
	RevertFile(fname string) error

	// FileContents returns the contents of given file, as a []byte array
	// at given revision specifier (if empty, defaults to current HEAD).
	// -1, -2 etc also work as universal ways of specifying prior revisions.
	FileContents(fname string, rev string) ([]byte, error)

	// Log returns the log history of commits for given filename
	// (or all files if empty).  If since is non-empty, it should be
	// a date-like expression that the VCS will understand, such as
	// 1/1/2020, yesterday, last year, etc.  SVN only understands a
	// number as a maximum number of items to return.
	Log(fname string, since string) (Log, error)

	// CommitDesc returns the full textual description of the given commit,
	// if rev is empty, defaults to current HEAD, -1, -2 etc also work as universal
	// ways of specifying prior revisions.
	// Optionally includes diffs for the changes (otherwise just a list of files
	// with modification status).
	CommitDesc(rev string, diffs bool) ([]byte, error)

	// FilesChanged returns the list of files changed and their statuses,
	// between two revisions.
	// If revA is empty, defaults to current HEAD; revB defaults to HEAD-1.
	// -1, -2 etc also work as universal ways of specifying prior revisions.
	// Optionally includes diffs for the changes.
	FilesChanged(revA, revB string, diffs bool) ([]byte, error)

	// Blame returns an annotated report about the file, showing which revision last
	// modified each line.
	Blame(fname string) ([]byte, error)
}

Repo provides an interface extending vcs.Repo (https://github.com/Masterminds/vcs) with support for file status information and operations.

func NewRepo 

func NewRepo(remote, local string) (Repo, error)

type SvnRepo 

type SvnRepo struct {
	vcs.SvnRepo

	sync.Mutex
	// contains filtered or unexported fields
}

func (*SvnRepo) Add 

func (gr *SvnRepo) Add(fname string) error

Add adds the file to the repo

func (*SvnRepo) Blame 

func (gr *SvnRepo) Blame(fname string) ([]byte, error)

Blame returns an annotated report about the file, showing which revision last modified each line.

func (*SvnRepo) CharToStat 

func (gr *SvnRepo) CharToStat(stat byte) FileStatus

func (*SvnRepo) CommitDesc 

func (gr *SvnRepo) CommitDesc(rev string, diffs bool) ([]byte, error)

CommitDesc returns the full textual description of the given commit, if rev is empty, defaults to current HEAD, -1, -2 etc also work as universal ways of specifying prior revisions. Optionally includes diffs for the changes (otherwise just a list of files with modification status).

func (*SvnRepo) CommitFile 

func (gr *SvnRepo) CommitFile(fname string, message string) error

CommitFile commits single file to repo staging

func (*SvnRepo) Delete 

func (gr *SvnRepo) Delete(fname string) error

Delete removes the file from the repo -- uses "force" option to ensure deletion

func (*SvnRepo) DeleteRemote 

func (gr *SvnRepo) DeleteRemote(fname string) error

DeleteRemote removes the file from the repo, but keeps local copy

func (*SvnRepo) FileContents 

func (gr *SvnRepo) FileContents(fname string, rev string) ([]byte, error)

FileContents returns the contents of given file, as a []byte array at given revision specifier (if empty, defaults to current HEAD). -1, -2 etc also work as universal ways of specifying prior revisions.

func (*SvnRepo) Files 

func (gr *SvnRepo) Files(onUpdated func(f Files)) (Files, error)

Files returns a map of the current files and their status, using a cached version of the file list if available. nil will be returned immediately if no cache is available. The given onUpdated function will be called from a separate goroutine when the updated list of the files is available, if an update is not already under way. An update is always triggered if no files have yet been cached, even if the function is nil.

func (*SvnRepo) FilesChanged added in v0.2.0 

func (gr *SvnRepo) FilesChanged(revA, revB string, diffs bool) ([]byte, error)

func (*SvnRepo) Log 

func (gr *SvnRepo) Log(fname string, since string) (Log, error)

Log returns the log history of commits for given filename (or all files if empty). If since is non-empty, it is the maximum number of entries to return (a number).

func (*SvnRepo) Move 

func (gr *SvnRepo) Move(oldpath, newpath string) error

Move moves updates the repo with the rename

func (*SvnRepo) RevertFile 

func (gr *SvnRepo) RevertFile(fname string) error

RevertFile reverts a single file to last commit of master

func (*SvnRepo) Status 

func (gr *SvnRepo) Status(fname string) (FileStatus, string)

Status returns status of given file; returns Untracked on any error

func (*SvnRepo) StatusFast added in v0.3.11 

func (gr *SvnRepo) StatusFast(fname string) FileStatus

StatusFast returns file status based on the cached file info, which might be slightly stale. Much faster than Status. Returns Untracked if no cached files.

func (*SvnRepo) Type added in v0.3.2 

func (gr *SvnRepo) Type() Types

type Types added in v0.3.2 

type Types int32 //enums:enum -accept-lower

const (
	NoVCS Types = iota
	Git
	Svn
	Bzr
	Hg
)
const TypesN Types = 5

TypesN is the highest valid value for type Types, plus one.

func DetectRepo 

func DetectRepo(path string) Types

DetectRepo attempts to detect the presence of a repository at the given directory path -- returns type of repository if found, else NoVCS. Very quickly just looks for signature file name: .git for git .svn for svn -- but note that this will find any subdir in svn rep.o

func TypesValues added in v0.3.2 

func TypesValues() []Types

TypesValues returns all possible values for the type Types.

func (Types) Desc added in v0.3.2 

func (i Types) Desc() string

Desc returns the description of the Types value.

func (Types) Int64 added in v0.3.2 

func (i Types) Int64() int64

Int64 returns the Types value as an int64.

func (Types) MarshalText added in v0.3.2 

func (i Types) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*Types) SetInt64 added in v0.3.2 

func (i *Types) SetInt64(in int64)

SetInt64 sets the Types value from an int64.

func (*Types) SetString added in v0.3.2 

func (i *Types) SetString(s string) error

SetString sets the Types value from its string representation, and returns an error if the string is invalid.

func (Types) String added in v0.3.2 

func (i Types) String() string

String returns the string representation of this Types value.

func (*Types) UnmarshalText added in v0.3.2 

func (i *Types) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Types) Values added in v0.3.2 

func (i Types) Values() []enums.Enum

Values returns all possible values for the type Types.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.