gitignore

package
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 22, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	GitHubGitignoresService
}

Client can fetch gitignore templates.

func NewClient

func NewClient(httpClient *http.Client) *Client

NewClient creates a new *Client which will use httpClient for making http requests. If httpClient is nil, http.DefaultClient will be used instead.

func (*Client) GetTemplate

func (c *Client) GetTemplate(ctx context.Context, query string) (*Template, error)

GetTemplate fetches the gitignore template for query. The query can be a comma-separated list of gitignore templates (e.g. "go,python") which are combined into a single gitignore template. Will return an error if the http connection fails or if the response status code is not 200. Will return ErrNotFound if any of the requested gitignore templates cannot be found.

func (*Client) ListTemplates

func (c *Client) ListTemplates(ctx context.Context) ([]string, error)

ListTemplates obtains a list of available gitignore templates.

type GitHubGitignoresService added in v0.3.0

type GitHubGitignoresService interface {
	Get(ctx context.Context, name string) (*github.Gitignore, *github.Response, error)
	List(ctx context.Context) ([]string, *github.Response, error)
}

GitHubGitignoresService is the interface of the GitHub Gitignores API Service.

type NotFoundError added in v0.3.0

type NotFoundError string

NotFoundError is returned if a gitignore template could not be found.

func (NotFoundError) Error added in v0.3.0

func (e NotFoundError) Error() string

type Template added in v0.1.1

type Template struct {
	Query   string
	Names   []string
	Content []byte
}

Template holds the content of a gitignore template and the query that was used to obtain it.

Jump to

Keyboard shortcuts

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