project

Documentation

Index

• Variables
• type Project
  • func FindBestMatch(expr string, conf *config.Config) (found *Project, err error)
  • func FindCurrent() (*Project, error)
  • func NewFromID(id string, conf *config.Config) (p *Project, err error)
  • func NewFromPath(path string) *Project
  • func (p *Project) Clone() (err error)
  • func (p *Project) Create() (err error)
  • func (p *Project) Exists() bool
  • func (p *Project) FullName() string
  • func (p *Project) GetRemoteURL() (url string, err error)
  • func (p *Project) Name() string
  • func (p *Project) Slug() string

Variables

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

Types

type Project

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

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

func FindCurrent

func FindCurrent() (*Project, error)

func NewFromID

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

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

func NewFromPath

func NewFromPath(path string) *Project

NewFromPath creates an instance of Project from the local path

func (*Project) Clone

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

Clone runs the Git command needed to clone the project

func (*Project) Create

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

Create creates the project directory locally

func (*Project) Exists

func (p *Project) Exists() bool

Exists checks whether the project exists locally

func (*Project) FullName

func (p *Project) FullName() string

FullName returns a logical id like platform:org/project

func (*Project) GetRemoteURL

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

GetRemoteURL builds the Git remote url for the project

func (*Project) Name

func (p *Project) Name() string

Name returns a logical id like platform:org/project

func (*Project) Slug

func (p *Project) Slug() string

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