Documentation ¶
Index ¶
- Variables
- func NewApp() *cli.App
- type Flags
- type GitHubFetcher
- func (g *GitHubFetcher) FetchReleases(nwo string) (releases []string, err error)
- 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
- type Linter
- type LocalProject
- func (l *LocalProject) CheckBootstrap() bool
- func (l *LocalProject) CheckChangelog() bool
- func (l *LocalProject) CheckCodeOfConduct() 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) CheckChangelog() bool
- func (l *RemoteProject) CheckCodeOfConduct() 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
Constants ¶
This section is empty.
Variables ¶
View Source
var BootstrapNotFoundError = &LintError{
1,
"Bootstrap script not found",
}
View Source
var BootstrapNotFoundInfo = &LintError{
0,
"A bootstrap script makes setup a snap. http://bit.ly/JZjVL6",
}
View Source
var ChangelogNotFoundError = &LintError{
1,
"CHANGELOG not found",
}
View Source
var ChangelogNotFoundInfo = &LintError{
0,
"Add a changelog to show what's new or improved with each release. http://keepachangelog.com/",
}
View Source
var CodeOfConductNotFoundError = &LintError{
1,
"CODE_OF_CONDUCT not found",
}
View Source
var CodeOfConductNotFoundInfo = &LintError{
0,
"Let people know what to expect when they participate in the project",
}
View Source
var ContributingNotFoundError = &LintError{
2,
"CONTRIBUTING guide not found",
}
View Source
var ContributingNotFoundInfo = &LintError{
0,
"Add a guide for potential contributors. http://git.io/z-TiGg",
}
View Source
var LicenseNotFoundError = &LintError{
2,
"LICENSE not found",
}
View Source
var LicenseNotFoundInfo = &LintError{
0,
"Add a license to protect yourself and your users. http://choosealicense.com/",
}
View Source
var ReadmeNotFoundError = &LintError{
2,
"README not found",
}
View Source
var ReadmeNotFoundInfo = &LintError{
0,
"Every project begins with a README. http://bit.ly/1dqUYQF",
}
View Source
var TestScriptNotFoundError = &LintError{
1,
"Test script not found",
}
View Source
var TestScriptNotFoundInfo = &LintError{
0,
"Make it easy to run the test suite regardless of project type. http://bit.ly/JZjVL6",
}
Functions ¶
Types ¶
type GitHubFetcher ¶ added in v0.0.4
func NewGitHubFetcher ¶ added in v0.0.4
func NewGitHubFetcher() *GitHubFetcher
func NewGitHubFetcherWithToken ¶ added in v0.0.4
func NewGitHubFetcherWithToken(token string) *GitHubFetcher
func (*GitHubFetcher) FetchReleases ¶ added in v0.1.0
func (g *GitHubFetcher) FetchReleases(nwo string) (releases []string, err error)
func (*GitHubFetcher) FetchRepository ¶ added in v0.0.4
func (g *GitHubFetcher) FetchRepository(nwo string) (repo *Repository, err error)
func (*GitHubFetcher) FetchTree ¶ added in v0.0.4
func (g *GitHubFetcher) FetchTree(nwo string) (paths []string, err error)
func (*GitHubFetcher) ParseFullName ¶ added in v0.0.4
func (g *GitHubFetcher) ParseFullName(nwo string) (owner, name string, err error)
type LocalProject ¶ added in v0.0.4
type LocalProject struct {
Path string
}
func (*LocalProject) CheckBootstrap ¶ added in v0.0.4
func (l *LocalProject) CheckBootstrap() bool
func (*LocalProject) CheckChangelog ¶ added in v0.1.0
func (l *LocalProject) CheckChangelog() bool
func (*LocalProject) CheckCodeOfConduct ¶ added in v0.1.0
func (l *LocalProject) CheckCodeOfConduct() bool
func (*LocalProject) CheckContributing ¶ added in v0.0.4
func (l *LocalProject) CheckContributing() bool
func (*LocalProject) CheckLicense ¶ added in v0.0.4
func (l *LocalProject) CheckLicense() bool
func (*LocalProject) CheckReadme ¶ added in v0.0.4
func (l *LocalProject) CheckReadme() bool
func (*LocalProject) CheckTestScript ¶ added in v0.0.4
func (l *LocalProject) CheckTestScript() bool
type RemoteProject ¶ added in v0.0.4
type RemoteProject struct { FullName string Repository // contains filtered or unexported fields }
func (*RemoteProject) CheckBootstrap ¶ added in v0.0.4
func (l *RemoteProject) CheckBootstrap() bool
func (*RemoteProject) CheckChangelog ¶ added in v0.1.0
func (l *RemoteProject) CheckChangelog() bool
func (*RemoteProject) CheckCodeOfConduct ¶ added in v0.1.0
func (l *RemoteProject) CheckCodeOfConduct() bool
func (*RemoteProject) CheckContributing ¶ added in v0.0.4
func (l *RemoteProject) CheckContributing() bool
func (*RemoteProject) CheckLicense ¶ added in v0.0.4
func (l *RemoteProject) CheckLicense() bool
func (*RemoteProject) CheckReadme ¶ added in v0.0.4
func (l *RemoteProject) CheckReadme() bool
func (*RemoteProject) CheckTestScript ¶ added in v0.0.4
func (l *RemoteProject) CheckTestScript() bool
func (*RemoteProject) Fetch ¶ added in v0.0.4
func (r *RemoteProject) Fetch(fetcher RemoteRepositoryFetcher) error
type RemoteRepositoryFetcher ¶ added in v0.0.4
type Repository ¶ added in v0.0.4
type Summary ¶ added in v0.0.4
type Summary struct {
Errors []*LintError
}
func (*Summary) AppendError ¶ added in v0.0.4
Click to show internal directories.
Click to hide internal directories.