pikeman 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9bbf6e9cacc31c9a512e66104fe7943f0ba6c25
-  data.tar.gz: 0e7a8b7e2c3dea679a0a785332606fe5879913eb
+  metadata.gz: 057a1f0cc477bb4316783ce4dc996a87715c16a3
+  data.tar.gz: 17e49b302e8097fb73c68dfc56ad5f063fa281d3
 SHA512:
-  metadata.gz: dde570ed22b983773f42759688942d97d32674e05c741b53b4b4a2377a7fe2f2da210b37236df577b22c2b3b299500f515fbf9ed5ec83c4751bf53b0e96f655b
-  data.tar.gz: 0dbd6801118e61935afa61ec49b67f933e1a6b41f5989149b76c01d7a68fcf58d7419488919ae9975848a45998efd7746c908b71a67a94ccc2857d523230d317
+  metadata.gz: 202415699de652a837e0cba7948ba864a381a37ad9c8d782bf52b31c649ecafeb23e30db3d7c9d688c176c95465f127390eacaa338b771b1796a83fc18327a13
+  data.tar.gz: c0274d74155c6ddb3bdc66a388fdc477511cac887d46256eb5515bb288bd88910bc16e5fca9a4a08255cce57a45fe2002f9c45dc17bdfddb646ba3d7301b82ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pikeman (0.0.1)
+    pikeman (0.0.3)
       cli-kit (~> 3.0)
 
 GEM

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/config.go

@@ -0,0 +1,218 @@
+package lint
+
+import (
+	"bytes"
+	"io"
+	"os"
+	"path/filepath"
+
+	"gopkg.in/yaml.v2"
+)
+
+var defaultConfig = []byte(`
+Includes:
+  - ./**/*.go
+
+Excludes:
+  - ./vendor/**
+  - ./pkg/**
+
+PackageComment:
+  Enabled: true
+
+Imports:
+  Enabled: true
+
+BlankImports:
+  Enabled: true
+
+Exported:
+  Enabled: true
+
+Names:
+  Enabled: true
+
+VarDecls:
+  Enabled: true
+
+Elses:
+  Enabled: true
+
+IfError:
+  Enabled: true
+
+Ranges:
+  Enabled: true
+
+Errorf:
+  Enabled: true
+
+Errors:
+  Enabled: true
+
+ErrorStrings:
+  Enabled: true
+
+ReceiverNames:
+  Enabled: true
+
+IncDec:
+  Enabled: true
+
+ErrorReturn:
+  Enabled: true
+
+UnexportedReturn:
+  Enabled: true
+
+TimeNames:
+  Enabled: true
+
+ContextKeyTypes:
+  Enabled: true
+
+ContextArgs:
+  Enabled: true
+`)
+
+type Rule interface {
+	IsEnabled() bool
+}
+
+type rule struct {
+	Enabled bool `yaml:"Enabled"`
+}
+
+func (r rule) IsEnabled() bool { return r.Enabled }
+
+type PackageCommentRule struct {
+	rule `yaml:",inline"`
+}
+type ImportsRule struct {
+	rule `yaml:",inline"`
+}
+type BlankImportsRule struct {
+	rule `yaml:",inline"`
+}
+type ExportedRule struct {
+	rule `yaml:",inline"`
+}
+type NamesRule struct {
+	rule `yaml:",inline"`
+}
+type VarDeclsRule struct {
+	rule `yaml:",inline"`
+}
+type ElsesRule struct {
+	rule `yaml:",inline"`
+}
+type IfErrorRule struct {
+	rule `yaml:",inline"`
+}
+type RangesRule struct {
+	rule `yaml:",inline"`
+}
+type ErrorfRule struct {
+	rule `yaml:",inline"`
+}
+type ErrorsRule struct {
+	rule `yaml:",inline"`
+}
+type ErrorStringsRule struct {
+	rule `yaml:",inline"`
+}
+type ReceiverNamesRule struct {
+	rule `yaml:",inline"`
+}
+type IncDecRule struct {
+	rule `yaml:",inline"`
+}
+type ErrorReturnRule struct {
+	rule `yaml:",inline"`
+}
+type UnexportedReturnRule struct {
+	rule `yaml:",inline"`
+}
+type TimeNamesRule struct {
+	rule `yaml:",inline"`
+}
+type ContextKeyTypesRule struct {
+	rule `yaml:",inline"`
+}
+type ContextArgsRule struct {
+	rule `yaml:",inline"`
+}
+
+type Config struct {
+	Includes []string `yaml:"Includes"`
+	Excludes []string `yaml:"Excludes"`
+
+	PackageComment   PackageCommentRule   `yaml:"PackageComment"`
+	Imports          ImportsRule          `yaml:"Imports"`
+	BlankImports     BlankImportsRule     `yaml:"BlankImports"`
+	Exported         ExportedRule         `yaml:"Exported"`
+	Names            NamesRule            `yaml:"Names"`
+	VarDecls         VarDeclsRule         `yaml:"VarDecls"`
+	Elses            ElsesRule            `yaml:"Elses"`
+	IfError          IfErrorRule          `yaml:"IfError"`
+	Ranges           RangesRule           `yaml:"Ranges"`
+	Errorf           ErrorfRule           `yaml:"Errorf"`
+	Errors           ErrorsRule           `yaml:"Errors"`
+	ErrorStrings     ErrorStringsRule     `yaml:"ErrorStrings"`
+	ReceiverNames    ReceiverNamesRule    `yaml:"ReceiverNames"`
+	IncDec           IncDecRule           `yaml:"IncDec"`
+	ErrorReturn      ErrorReturnRule      `yaml:"ErrorReturn"`
+	UnexportedReturn UnexportedReturnRule `yaml:"UnexportedReturn"`
+	TimeNames        TimeNamesRule        `yaml:"TimeNames"`
+	ContextKeyTypes  ContextKeyTypesRule  `yaml:"ContextKeyTypes"`
+	ContextArgs      ContextArgsRule      `yaml:"ContextArgs"`
+}
+
+func ReadConfigFromWorkingDir() (*Config, error) {
+	wd, err := os.Getwd()
+	if err != nil {
+		return nil, err
+	}
+
+	reader, err := backtrackConfig(wd)
+	if err != nil {
+		return nil, err
+	}
+
+	return decodeConfig(reader)
+}
+
+func ReadConfig(path string) (*Config, error) {
+	reader, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+
+	return decodeConfig(reader)
+}
+
+func decodeConfig(reader io.Reader) (*Config, error) {
+	var config Config
+	err := yaml.NewDecoder(reader).Decode(&config)
+	if err != nil {
+		return nil, err
+	}
+	return &config, nil
+}
+
+func backtrackConfig(wd string) (io.Reader, error) {
+	configPath := filepath.Join(wd, ".pikeman.yml")
+	_, err := os.Stat(configPath)
+
+	switch {
+	case os.IsNotExist(err) && wd == "/":
+		return bytes.NewReader(defaultConfig), nil
+	case os.IsNotExist(err):
+		previousDir := filepath.Dir(filepath.Join(wd, ".."))
+		return backtrackConfig(previousDir)
+	case err == nil:
+		return os.Open(configPath)
+	default:
+		return nil, err
+	}
+}

data/golint/golint.go

@@ -17,15 +17,17 @@ import (
 	"path/filepath"
 	"strings"
 
-	"golang.org/x/lint"
+	"github.com/maximebedard/pikeman"
 )
 
 var (
 	minConfidence = flag.Float64("min_confidence", 0.8, "minimum confidence of a problem to print it")
 	setExitStatus = flag.Bool("set_exit_status", false, "set exit status to 1 if any issues are found")
 	formatterType = flag.String("format", "text", "set the format. Available: text, json.")
+	configPath    = flag.String("config_path", "", "set the configuration file.")
 	suggestions   int
 	formatter     problemFormatter
+	config        *lint.Config
 )
 
 func usage() {
@@ -50,6 +52,18 @@ func main() {
 		formatter = &textFormatter{}
 	}
 
+	var err error
+	if *configPath != "" {
+		config, err = lint.ReadConfig(*configPath)
+	} else {
+		config, err = lint.ReadConfigFromWorkingDir()
+	}
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "An error occured trying to read the config file: %s", err.Error())
+		os.Exit(1)
+	}
+
 	if flag.NArg() == 0 {
 		lintDir(".")
 	} else {
@@ -164,7 +178,7 @@ func lintFiles(filenames ...string) {
 		files[filename] = src
 	}
 
-	l := new(lint.Linter)
+	l := &lint.Linter{Config: config}
 	ps, err := l.LintFiles(files)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "%v\n", err)

data/golint/version.go

@@ -1,3 +1,3 @@
 package main
 
-const VERSION string = "0.0.3"
+const VERSION string = "0.0.4"

data/lib/pikeman/version.rb

@@ -1,3 +1,3 @@
 module Pikeman
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lint.go

@@ -30,6 +30,7 @@ const styleGuideBase = "https://golang.org/wiki/CodeReviewComments"
 
 // A Linter lints Go source code.
 type Linter struct {
+	Config *Config
 }
 
 // Problem represents a problem in some source code.
@@ -86,6 +87,36 @@ func (l *Linter) LintFiles(files map[string][]byte) ([]Problem, error) {
 		fset:  token.NewFileSet(),
 		files: make(map[string]*file),
 	}
+
+	rules := map[Rule]func(f *file){
+		l.Config.PackageComment:   lintPackageComment,
+		l.Config.Imports:          lintImports,
+		l.Config.BlankImports:     lintBlankImports,
+		l.Config.Exported:         lintExported,
+		l.Config.Names:            lintNames,
+		l.Config.VarDecls:         lintVarDecls,
+		l.Config.Elses:            lintElses,
+		l.Config.IfError:          lintIfError,
+		l.Config.Ranges:           lintRanges,
+		l.Config.Errorf:           lintErrorf,
+		l.Config.Errors:           lintErrors,
+		l.Config.ErrorStrings:     lintErrorStrings,
+		l.Config.ReceiverNames:    lintReceiverNames,
+		l.Config.IncDec:           lintIncDec,
+		l.Config.ErrorReturn:      lintErrorReturn,
+		l.Config.UnexportedReturn: lintUnexportedReturn,
+		l.Config.TimeNames:        lintTimeNames,
+		l.Config.ContextKeyTypes:  lintContextKeyTypes,
+		l.Config.ContextArgs:      lintContextArgs,
+	}
+
+	var enabledRules []func(f *file)
+	for rule, fn := range rules {
+		if rule.IsEnabled() {
+			enabledRules = append(enabledRules, fn)
+		}
+	}
+
 	var pkgName string
 	for filename, src := range files {
 		if isGenerated(src) {
@@ -106,6 +137,7 @@ func (l *Linter) LintFiles(files map[string][]byte) ([]Problem, error) {
 			fset:     pkg.fset,
 			src:      src,
 			filename: filename,
+			rules:    enabledRules,
 		}
 	}
 	if len(pkg.files) == 0 {
@@ -187,30 +219,15 @@ type file struct {
 	fset     *token.FileSet
 	src      []byte
 	filename string
+	rules    []func(*file)
 }
 
 func (f *file) isTest() bool { return strings.HasSuffix(f.filename, "_test.go") }
 
 func (f *file) lint() {
-	f.lintPackageComment()
-	f.lintImports()
-	f.lintBlankImports()
-	f.lintExported()
-	f.lintNames()
-	f.lintVarDecls()
-	f.lintElses()
-	f.lintIfError()
-	f.lintRanges()
-	f.lintErrorf()
-	f.lintErrors()
-	f.lintErrorStrings()
-	f.lintReceiverNames()
-	f.lintIncDec()
-	f.lintErrorReturn()
-	f.lintUnexportedReturn()
-	f.lintTimeNames()
-	f.lintContextKeyTypes()
-	f.lintContextArgs()
+	for _, rule := range f.rules {
+		rule(f)
+	}
 }
 
 type link string
@@ -377,7 +394,7 @@ func (f *file) isMain() bool {
 // This has a notable false positive in that a package comment
 // could rightfully appear in a different file of the same package,
 // but that's not easy to fix since this linter is file-oriented.
-func (f *file) lintPackageComment() {
+func lintPackageComment(f *file) {
 	if f.isTest() {
 		return
 	}
@@ -430,7 +447,7 @@ func (f *file) lintPackageComment() {
 
 // lintBlankImports complains if a non-main package has blank imports that are
 // not documented.
-func (f *file) lintBlankImports() {
+func lintBlankImports(f *file) {
 	// In package main and in tests, we don't complain about blank imports.
 	if f.pkg.main || f.isTest() {
 		return
@@ -461,7 +478,7 @@ func (f *file) lintBlankImports() {
 }
 
 // lintImports examines import blocks.
-func (f *file) lintImports() {
+func lintImports(f *file) {
 	for i, is := range f.f.Imports {
 		_ = i
 		if is.Name != nil && is.Name.Name == "." && !f.isTest() {
@@ -481,7 +498,7 @@ const docCommentsLink = styleGuideBase + "#doc-comments"
 // doc comments for constants to be on top of the const block.
 // It also complains if the names stutter when combined with
 // the package name.
-func (f *file) lintExported() {
+func lintExported(f *file) {
 	if f.isTest() {
 		return
 	}
@@ -542,7 +559,7 @@ var knownNameExceptions = map[string]bool{
 
 // lintNames examines all names in the file.
 // It complains if any use underscores or incorrect known initialisms.
-func (f *file) lintNames() {
+func lintNames(f *file) {
 	// Package names need slightly different handling than other names.
 	if strings.Contains(f.f.Name.Name, "_") && !strings.HasSuffix(f.f.Name.Name, "_test") {
 		f.errorf(f.f, 1, link("http://golang.org/doc/effective_go.html#package-names"), category("naming"), "don't use an underscore in package name")
@@ -957,7 +974,7 @@ var zeroLiteral = map[string]bool{
 
 // lintVarDecls examines variable declarations. It complains about declarations with
 // redundant LHS types that can be inferred from the RHS.
-func (f *file) lintVarDecls() {
+func lintVarDecls(f *file) {
 	var lastGen *ast.GenDecl // last GenDecl entered.
 
 	f.walk(func(node ast.Node) bool {
@@ -1034,7 +1051,7 @@ func validType(T types.Type) bool {
 }
 
 // lintElses examines else blocks. It complains about any else block whose if block ends in a return.
-func (f *file) lintElses() {
+func lintElses(f *file) {
 	// We don't want to flag if { } else if { } else { } constructions.
 	// They will appear as an IfStmt whose Else field is also an IfStmt.
 	// Record such a node so we ignore it when we visit it.
@@ -1078,7 +1095,7 @@ func (f *file) lintElses() {
 }
 
 // lintRanges examines range clauses. It complains about redundant constructions.
-func (f *file) lintRanges() {
+func lintRanges(f *file) {
 	f.walk(func(node ast.Node) bool {
 		rs, ok := node.(*ast.RangeStmt)
 		if !ok {
@@ -1109,7 +1126,7 @@ func (f *file) lintRanges() {
 }
 
 // lintErrorf examines errors.New and testing.Error calls. It complains if its only argument is an fmt.Sprintf invocation.
-func (f *file) lintErrorf() {
+func lintErrorf(f *file) {
 	f.walk(func(node ast.Node) bool {
 		ce, ok := node.(*ast.CallExpr)
 		if !ok || len(ce.Args) != 1 {
@@ -1147,7 +1164,7 @@ func (f *file) lintErrorf() {
 }
 
 // lintErrors examines global error vars. It complains if they aren't named in the standard way.
-func (f *file) lintErrors() {
+func lintErrors(f *file) {
 	for _, decl := range f.f.Decls {
 		gd, ok := decl.(*ast.GenDecl)
 		if !ok || gd.Tok != token.VAR {
@@ -1202,7 +1219,7 @@ func lintErrorString(s string) (isClean bool, conf float64) {
 
 // lintErrorStrings examines error strings.
 // It complains if they are capitalized or end in punctuation or a newline.
-func (f *file) lintErrorStrings() {
+func lintErrorStrings(f *file) {
 	f.walk(func(node ast.Node) bool {
 		ce, ok := node.(*ast.CallExpr)
 		if !ok {
@@ -1235,7 +1252,7 @@ func (f *file) lintErrorStrings() {
 
 // lintReceiverNames examines receiver names. It complains about inconsistent
 // names used for the same type and names such as "this".
-func (f *file) lintReceiverNames() {
+func lintReceiverNames(f *file) {
 	typeReceiver := map[string]string{}
 	f.walk(func(n ast.Node) bool {
 		fn, ok := n.(*ast.FuncDecl)
@@ -1268,7 +1285,7 @@ func (f *file) lintReceiverNames() {
 
 // lintIncDec examines statements that increment or decrement a variable.
 // It complains if they don't use x++ or x--.
-func (f *file) lintIncDec() {
+func lintIncDec(f *file) {
 	f.walk(func(n ast.Node) bool {
 		as, ok := n.(*ast.AssignStmt)
 		if !ok {
@@ -1296,7 +1313,7 @@ func (f *file) lintIncDec() {
 
 // lintErrorReturn examines function declarations that return an error.
 // It complains if the error isn't the last parameter.
-func (f *file) lintErrorReturn() {
+func lintErrorReturn(f *file) {
 	f.walk(func(n ast.Node) bool {
 		fn, ok := n.(*ast.FuncDecl)
 		if !ok || fn.Type.Results == nil {
@@ -1320,7 +1337,7 @@ func (f *file) lintErrorReturn() {
 
 // lintUnexportedReturn examines exported function declarations.
 // It complains if any return an unexported type.
-func (f *file) lintUnexportedReturn() {
+func lintUnexportedReturn(f *file) {
 	f.walk(func(n ast.Node) bool {
 		fn, ok := n.(*ast.FuncDecl)
 		if !ok {
@@ -1384,7 +1401,7 @@ var timeSuffixes = []string{
 	"MS", "Ms",
 }
 
-func (f *file) lintTimeNames() {
+func lintTimeNames(f *file) {
 	f.walk(func(node ast.Node) bool {
 		v, ok := node.(*ast.ValueSpec)
 		if !ok {
@@ -1420,7 +1437,7 @@ func (f *file) lintTimeNames() {
 // lintContextKeyTypes checks for call expressions to context.WithValue with
 // basic types used for the key argument.
 // See: https://golang.org/issue/17293
-func (f *file) lintContextKeyTypes() {
+func lintContextKeyTypes(f *file) {
 	f.walk(func(node ast.Node) bool {
 		switch node := node.(type) {
 		case *ast.CallExpr:
@@ -1460,7 +1477,7 @@ func (f *file) checkContextKeyType(x *ast.CallExpr) {
 // lintContextArgs examines function declarations that contain an
 // argument with a type of context.Context
 // It complains if that argument isn't the first parameter.
-func (f *file) lintContextArgs() {
+func lintContextArgs(f *file) {
 	f.walk(func(n ast.Node) bool {
 		fn, ok := n.(*ast.FuncDecl)
 		if !ok || len(fn.Type.Params.List) <= 1 {
@@ -1500,7 +1517,7 @@ func (f *file) containsComments(start, end token.Pos) bool {
 	return false
 }
 
-func (f *file) lintIfError() {
+func lintIfError(f *file) {
 	f.walk(func(node ast.Node) bool {
 		switch v := node.(type) {
 		case *ast.BlockStmt:

data/lint_test.go

@@ -26,7 +26,8 @@ import (
 var lintMatch = flag.String("lint.match", "", "restrict testdata matches to this pattern")
 
 func TestAll(t *testing.T) {
-	l := new(Linter)
+	config, _ := decodeConfig(bytes.NewBuffer(defaultConfig))
+	l := &Linter{Config: config}
 	rx, err := regexp.Compile(*lintMatch)
 	if err != nil {
 		t.Fatalf("Bad -lint.match value %q: %v", *lintMatch, err)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pikeman
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Maxime Bedard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-kit
@@ -90,6 +90,7 @@ files:
 - bin/setup
 - build/darwin-amd64/pikeman
 - build/linux-amd64/pikeman
+- config.go
 - golint/golint.go
 - golint/import.go
 - golint/version.go