vcs

package

v0.0.0-...-ef490db Latest Latest Go to latest Published: Feb 16, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chaopeng/ph

Links

Open Source Insights

Documentation ¶

Overview ¶

Package vcs stores helper for getting vcs information

Index ¶

Constants
func RegisterVCS(v VCS)
type VCS
type VCSInfo
- func GetVCSInfo(path string, user *user.User, conf *config.Config) *VCSInfo
- func (s *VCSInfo) StatusDirty() bool

Constants ¶

View Source

const (
	// don't have status or don't care status.
	StatusNone     = -1
	StatusClean    = 0
	StatusUntrack  = 1
	StatusUnstage  = 1 << 1
	StatusUncommit = 1 << 2
)

Variables ¶

This section is empty.

Functions ¶

func RegisterVCS ¶

func RegisterVCS(v VCS)

Types ¶

type VCS ¶

type VCS interface {
	GetVCSInfo(path string, user *user.User, conf *config.Config) *VCSInfo
}

type VCSInfo ¶

type VCSInfo struct {
	// git or "", "" means not a repo
	RepoType string
	// git branch name, git commit id, hg bookmark
	Name string
	// git status, hg status
	Status int
}

func GetVCSInfo ¶

func GetVCSInfo(path string, user *user.User, conf *config.Config) *VCSInfo

func (*VCSInfo) StatusDirty ¶

func (s *VCSInfo) StatusDirty() bool

Source Files ¶

View all Source files

vcs.go

Directories ¶

Path	Synopsis
git Package git contains vcs info for git	Package git contains vcs info for git
hg Package hg contains vcs info for hg	Package hg contains vcs info for hg

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL