state

package module

v0.0.0-...-d0b6730 Latest Latest Go to latest Published: Mar 31, 2019 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

Repository

github.com/demosdemon/update-gitignore

Links

Open Source Insights

README ¶

Update Gitignore

Documentation ¶

Index ¶

Constants
Variables
type Client
type Command
type ExitStatus
type State
type Template
- func NewTemplate(entry github.TreeEntry) *Template

Constants ¶

View Source

const (
	// Suffix is the file suffix to grok.
	Suffix = ".gitignore"
)

Variables ¶

View Source

var (
	// ErrActionRequired is returned when no command action is provided
	ErrActionRequired = errors.New("need an action")
	// ErrInvalidRepo is returned if the repo provided on the command line does not look like <owner>/<name>.
	ErrInvalidRepo = errors.New("invalid repo")
)

View Source

var (
	// ErrTokenNotFound is returned if the client was unable to locate a GITHUB_TOKEN environment variable
	ErrTokenNotFound = errors.New("token not found")
)

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func (*Client) GetBlob ¶

func (c *Client) GetBlob(sha string) (*github.Blob, error)

func (*Client) GetBranch ¶

func (c *Client) GetBranch(branch string) (*github.Branch, error)

func (*Client) GetRateLimits ¶

func (c *Client) GetRateLimits() (*github.RateLimits, error)

func (*Client) GetRepository ¶

func (c *Client) GetRepository() (*github.Repository, error)

func (*Client) GetTree ¶

func (c *Client) GetTree(sha string) (*github.Tree, error)

func (*Client) GetUser ¶

func (c *Client) GetUser() (*github.User, error)

func (*Client) GitHubClient ¶

func (c *Client) GitHubClient() *github.Client

func (*Client) HTTPClient ¶

func (c *Client) HTTPClient() *http.Client

func (*Client) SetHTTPClient ¶

func (c *Client) SetHTTPClient(httpClient *http.Client)

func (*Client) Token ¶

func (c *Client) Token() (*oauth2.Token, error)

type Command ¶

type Command interface {
	GetName() string
	Run() ExitStatus
}

type ExitStatus ¶

type ExitStatus uint8

type State ¶

type State struct {
	*app.App
	// contains filtered or unexported fields
}

The State of the application.

func (*State) Client ¶

func (s *State) Client() (*Client, error)

func (*State) Command ¶

func (s *State) Command() (Command, error)

func (*State) Debug ¶

func (s *State) Debug() bool

func (*State) ParseArguments ¶

func (s *State) ParseArguments() error

func (*State) Repo ¶

func (s *State) Repo() string

func (*State) SetDebug ¶

func (s *State) SetDebug(debug bool)

func (*State) SetRepo ¶

func (s *State) SetRepo(repo string)

func (*State) SetTimeout ¶

func (s *State) SetTimeout(timeout time.Duration)

func (*State) Timeout ¶

func (s *State) Timeout() time.Duration

type Template ¶

type Template struct {
	Name string
	Size uint64
	Path string
	Tags []string
	SHA  string
}

Template represents a gitignore template from the repository

func NewTemplate ¶

func NewTemplate(entry github.TreeEntry) *Template

New builds a new Template struct from a GitHub TreeEntry. Returns nil if the entry doesn't point to a Gitignore template.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
record
update-gitignore

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