repos

Documentation

Overview

Package repos defines a generic repository.

Index

• Variables
• type RepoType
• type RepoURI
  • func NewFromLocalDirectory(path string) *RepoURI
  • func NewFromURL(u string) (*RepoURI, error)
  • func (r *RepoURI) AppendMetadata(m ...string) error
  • func (r *RepoURI) Equal(o *RepoURI) bool
  • func (r *RepoURI) IsValidGitHubURL() error
  • func (r *RepoURI) Metadata() []string
  • func (r *RepoURI) Path() string
  • func (r *RepoURI) RepoType() RepoType
  • func (r *RepoURI) Set(s string) error
  • func (r *RepoURI) SetMetadata(m []string) error
  • func (r *RepoURI) SetURL(u string) error
  • func (r *RepoURI) String() string
  • func (r *RepoURI) Type() string
  • func (r *RepoURI) URL() string

Variables

var (
	// ErrorUnsupportedhost indicates the repo's host is unsupported.
	ErrorUnsupportedhost = errors.New("unsupported host")
	// ErrorInvalidGithubURL indicates the repo's GitHub URL is not in the proper format.
	ErrorInvalidGithubURL = errors.New("invalid GitHub repo URL")
	// ErrorInvalidURL indicates the repo's full GitHub URL was not passed.
	ErrorInvalidURL = errors.New("invalid repo flag")
)

Types

type RepoType

type RepoType int

RepoType is the type of a file.

const (
	// RepoTypeURL is for URLs.
	RepoTypeURL RepoType = iota
	// RepoTypeLocalDir is for source code in directories.
	RepoTypeLocalDir
)

type RepoURI

type RepoURI struct {
	// contains filtered or unexported fields
}

RepoURI represents the URI for a repo.

func NewFromLocalDirectory

func NewFromLocalDirectory(path string) *RepoURI

NewFromLocalDirectory creates a RepoURI as a local directory.

func NewFromURL

func NewFromURL(u string) (*RepoURI, error)

NewFromURL creates a RepoURI from URL.

func (*RepoURI) AppendMetadata

func (r *RepoURI) AppendMetadata(m ...string) error

AppendMetadata appends metadata.

func (*RepoURI) Equal

func (r *RepoURI) Equal(o *RepoURI) bool

Equal checks objects for equality.

func (*RepoURI) IsValidGitHubURL

func (r *RepoURI) IsValidGitHubURL() error

IsValidGitHubURL checks whether Repo represents a valid GitHub repo and returns errors otherwise.

func (*RepoURI) Metadata

func (r *RepoURI) Metadata() []string

Metadata returns a valid url for Repo struct.

func (*RepoURI) Path

func (r *RepoURI) Path() string

Path retusn the path for a local directory.

func (*RepoURI) RepoType

func (r *RepoURI) RepoType() RepoType

RepoType gives the type of URI.

func (*RepoURI) Set

func (r *RepoURI) Set(s string) error

Set parses a URI string into Repo struct.

func (*RepoURI) SetMetadata

func (r *RepoURI) SetMetadata(m []string) error

SetMetadata sets metadata.

func (*RepoURI) SetURL

func (r *RepoURI) SetURL(u string) error

SetURL sets the URL.

func (*RepoURI) String

func (r *RepoURI) String() string

String returns a string representation of Repo struct.

func (*RepoURI) Type

func (r *RepoURI) Type() string

Type method is needed so that this struct can be used as cmd flag.

func (*RepoURI) URL

func (r *RepoURI) URL() string

URL returns a valid url for Repo struct.