project

package

v0.13.0 Latest Latest Go to latest Published: Dec 3, 2023 License: MIT Imports: 13 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

This section is empty.

View Source

var ErrProjectNotFound = errors.New("project not found")

ErrProjectNotFound is returned when the project was not found

func FindBestLinkMatch(expr string, index []string) string

type Project struct {
	Path string // Local path of this project on disk
	// contains filtered or unexported fields
}

Project represents a project whether it exists locally or not

func FindBestMatch(expr string, cfg *config.Config) (found *Project, err error)

func FindCurrent() (*Project, error)

FindCurrent returns the project that contains the current directory

func NewFromID(id string, conf *config.Config) (p *Project, err error)

NewFromID creates an instance of Project from a short id like "org/name" or "name"

func NewFromPath(path string) *Project

NewFromPath creates an instance of Project from the local path

func (p *Project) Clone() (err error)

Clone runs the Git command needed to clone the project

func (p *Project) Create() (err error)

Create creates the project directory locally

func (p *Project) Exists() bool

Exists checks whether the project exists locally

func (p *Project) FullName() string

FullName returns a logical id like platform:org/project

func (p *Project) GetRemoteURL() (url string, err error)

GetRemoteURL builds the Git remote url for the project

func (p *Project) Name() string

Name returns a logical id like platform:org/project

func (p *Project) Slug() string

Slug returns a short, unique but humanly recognizable id based on the path