flint

Documentation

Index

• Variables
• func NewApp() *cli.App
• type Flags
• type GitHubFetcher
  • func NewGitHubFetcher() *GitHubFetcher
  • func NewGitHubFetcherWithToken(token string) *GitHubFetcher
  • func (g *GitHubFetcher) FetchRepository(nwo string) (repo *Repository, err error)
  • func (g *GitHubFetcher) FetchTree(nwo string) (paths []string, err error)
  • func (g *GitHubFetcher) ParseFullName(nwo string) (owner, name string, err error)
• type LintError
  • func (e *LintError) Error() (out string)
• type Linter
  • func (l *Linter) Run(p Project, flags *Flags) (summary *Summary, err error)
• type LocalProject
  • func (l *LocalProject) CheckBootstrap() bool
  • func (l *LocalProject) CheckContributing() bool
  • func (l *LocalProject) CheckLicense() bool
  • func (l *LocalProject) CheckReadme() bool
  • func (l *LocalProject) CheckTestScript() bool
• type Project
• type RemoteProject
  • func (l *RemoteProject) CheckBootstrap() bool
  • func (l *RemoteProject) CheckContributing() bool
  • func (l *RemoteProject) CheckLicense() bool
  • func (l *RemoteProject) CheckReadme() bool
  • func (l *RemoteProject) CheckTestScript() bool
  • func (r *RemoteProject) Fetch(fetcher RemoteRepositoryFetcher) error
• type RemoteRepositoryFetcher
• type Repository
• type Summary
  • func (list *Summary) AppendError(err *LintError)
  • func (l *Summary) Print(out io.Writer, colored bool)
  • func (list *Summary) Severity() int

Variables

var BootstrapNotFoundError = &LintError{
	1,
	"Bootstrap script not found",
}

var BootstrapNotFoundInfo = &LintError{
	0,
	"A bootstrap script makes setup a snap. http://bit.ly/JZjVL6",
}

var ContributingNotFoundError = &LintError{
	2,
	"CONTRIBUTING guide not found",
}

var ContributingNotFoundInfo = &LintError{
	0,
	"Add a guide for potential contributors. http://git.io/z-TiGg",
}

var LicenseNotFoundError = &LintError{
	2,
	"LICENSE not found",
}

var LicenseNotFoundInfo = &LintError{
	0,
	"Add a license to protect yourself and your users. http://choosealicense.com/",
}

var ReadmeNotFoundError = &LintError{
	2,
	"README not found",
}

var ReadmeNotFoundInfo = &LintError{
	0,
	"Every project begins with a README. http://bit.ly/1dqUYQF",
}

var TestScriptNotFoundError = &LintError{
	1,
	"Test script not found",
}

var TestScriptNotFoundInfo = &LintError{
	0,
	"Make it easy to run the test suite regardless of project type. http://bit.ly/JZjVL6",
}

Functions

func NewApp

func NewApp() *cli.App

Types

type Flags

type Flags struct {
	RunReadme       bool
	RunContributing bool
	RunLicense      bool
	RunBootstrap    bool
	RunTestScript   bool
}

type GitHubFetcher

type GitHubFetcher struct {
	*octokit.Client
}

func NewGitHubFetcher

func NewGitHubFetcher() *GitHubFetcher

func NewGitHubFetcherWithToken

func NewGitHubFetcherWithToken(token string) *GitHubFetcher

func (*GitHubFetcher) FetchRepository

func (g *GitHubFetcher) FetchRepository(nwo string) (repo *Repository, err error)

func (*GitHubFetcher) FetchTree

func (g *GitHubFetcher) FetchTree(nwo string) (paths []string, err error)

func (*GitHubFetcher) ParseFullName

func (g *GitHubFetcher) ParseFullName(nwo string) (owner, name string, err error)

type LintError

type LintError struct {
	Level   int
	Message string
}

func (*LintError) Error

func (e *LintError) Error() (out string)

type Linter

type Linter struct{}

func (*Linter) Run

func (l *Linter) Run(p Project, flags *Flags) (summary *Summary, err error)

type LocalProject

type LocalProject struct {
	Path string
}

func (*LocalProject) CheckBootstrap

func (l *LocalProject) CheckBootstrap() bool

func (*LocalProject) CheckContributing

func (l *LocalProject) CheckContributing() bool

func (*LocalProject) CheckLicense

func (l *LocalProject) CheckLicense() bool

func (*LocalProject) CheckReadme

func (l *LocalProject) CheckReadme() bool

func (*LocalProject) CheckTestScript

func (l *LocalProject) CheckTestScript() bool

type Project

type Project interface {
	CheckReadme() bool
	CheckContributing() bool
	CheckLicense() bool
	CheckBootstrap() bool
	CheckTestScript() bool
}

type RemoteProject

type RemoteProject struct {
	FullName string

	Repository
	// contains filtered or unexported fields
}

func (*RemoteProject) CheckBootstrap

func (l *RemoteProject) CheckBootstrap() bool

func (*RemoteProject) CheckContributing

func (l *RemoteProject) CheckContributing() bool

func (*RemoteProject) CheckLicense

func (l *RemoteProject) CheckLicense() bool

func (*RemoteProject) CheckReadme

func (l *RemoteProject) CheckReadme() bool

func (*RemoteProject) CheckTestScript

func (l *RemoteProject) CheckTestScript() bool

func (*RemoteProject) Fetch

func (r *RemoteProject) Fetch(fetcher RemoteRepositoryFetcher) error

type RemoteRepositoryFetcher

type RemoteRepositoryFetcher interface {
	FetchRepository(string) (*Repository, error)
	FetchTree(string) ([]string, error)
}

type Repository

type Repository struct {
	Description string
	Homepage    string
}

type Summary

type Summary struct {
	Errors []*LintError
}

func (*Summary) AppendError

func (list *Summary) AppendError(err *LintError)

func (*Summary) Print

func (l *Summary) Print(out io.Writer, colored bool)

func (*Summary) Severity

func (list *Summary) Severity() int