Merge pull request #47 from dixonwille/feature/add-depguard

Add Depguard to supported linters

Author: golangci

.golangci.example.yml

@@ -31,6 +31,11 @@ linters-settings:
   goconst:
     min-len: 3
     min-occurrences: 3
+  depguard:
+    list-type: blacklist
+    include-go-root: false
+    packages:
+      - github.com/davecgh/go-spew/spew
 
 linters:
   enable:

Gopkg.lock

@@ -112,3 +112,7 @@
 [[override]]
   branch = "master"
   name = "github.com/golangci/lint"
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/OpenPeeDeeP/depguard"

Gopkg.toml

@@ -104,6 +104,7 @@ gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s
 goimports: Goimports does everything that gofmt does. Additionally it checks unused imports
 maligned: Tool to detect Go structs that would take less memory if their fields were sorted
 megacheck: 3 sub-linters in one: unused, gosimple and staticcheck
+depguard: Go linter that checks if package imports are in a list of acceptable packages
 ```
 
 Pass `-E/--enable` to enable linter and `-D/--disable` to disable:
@@ -196,6 +197,7 @@ golangci-lint linters
 - [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports): Goimports does everything that gofmt does. Additionally it checks unused imports
 - [maligned](https://github.com/mdempsky/maligned): Tool to detect Go structs that would take less memory if their fields were sorted
 - [megacheck](https://github.com/dominikh/go-tools/tree/master/cmd/megacheck): 3 sub-linters in one: unused, gosimple and staticcheck
+- [depguard](https://github.com/OpenPeeDeeP/depguard): Go linter that checks if package imports are in a list of acceptable packages
 
 # Configuration
 ## Command-Line Options
@@ -231,7 +233,7 @@ Linters presets:
 bugs: govet, errcheck, staticcheck, gas, megacheck
 unused: unused, structcheck, varcheck, ineffassign, deadcode, megacheck
 format: gofmt, goimports
-style: golint, gosimple, interfacer, unconvert, dupl, goconst, megacheck
+style: golint, gosimple, interfacer, unconvert, dupl, goconst, megacheck, depguard
 complexity: gocyclo
 performance: maligned
 ```
@@ -427,6 +429,7 @@ Thanks to developers and authors of used linters:
 - [golang/x/tools/goimports](https://godoc.org/golang.org/x/tools/cmd/goimports)
 - [mdempsky/maligned](https://github.com/mdempsky/maligned)
 - [dominikh/go-tools/megacheck](https://github.com/dominikh/go-tools/tree/master/cmd/megacheck)
+- [OpenPeeDeeP/depguard](https://github.com/OpenPeeDeeP/depguard)
 
 # Future Plans
 1. Upstream all changes of forked linters.

README.md

@@ -88,6 +88,18 @@ func (e *Executor) initRun() {
 	runCmd.Flags().IntVar(&lsc.Goconst.MinOccurrencesCount, "goconst.min-occurrences",
 		3, "Goconst: minimum occurrences of constant string count to trigger issue")
 
+	// (@dixonwille) These flag is only used for testing purposes.
+	runCmd.Flags().StringSliceVar(&lsc.Depguard.Packages, "depguard.packages", nil,
+		"Depguard: packages to add to the list")
+	if err := runCmd.Flags().MarkHidden("depguard.packages"); err != nil {
+		panic(err) //Considering The only time this is called is if name does not exist
+	}
+	runCmd.Flags().BoolVar(&lsc.Depguard.IncludeGoRoot, "depguard.include-go-root", false,
+		"Depguard: check list against standard lib")
+	if err := runCmd.Flags().MarkHidden("depguard.include-go-root"); err != nil {
+		panic(err) //Considering The only time this is called is if name does not exist
+	}
+
 	// Linters config
 	lc := &e.cfg.Linters
 	runCmd.Flags().StringSliceVarP(&lc.Enable, "enable", "E", []string{}, "Enable specific linter")

pkg/commands/run.go

@@ -91,6 +91,11 @@ type LintersSettings struct {
 		MinStringLen        int `mapstructure:"min-len"`
 		MinOccurrencesCount int `mapstructure:"min-occurrences"`
 	}
+	Depguard struct {
+		ListType      string `mapstructure:"list-type"`
+		Packages      []string
+		IncludeGoRoot bool `mapstructure:"inlude-go-root"`
+	}
 }
 
 type Linters struct {

pkg/config/config.go

@@ -125,6 +125,7 @@ func GetAllSupportedLinterConfigs() []LinterConfig {
 		newLinterConfig(golinters.Maligned{}).WithFullImport().WithPresets(PresetPerformance).WithSpeed(10),
 		newLinterConfig(golinters.Megacheck{GosimpleEnabled: true, UnusedEnabled: true, StaticcheckEnabled: true}).
 			WithSSA().WithPresets(PresetStyle, PresetBugs, PresetUnused).WithSpeed(1),
+		newLinterConfig(golinters.Depguard{}).WithFullImport().WithPresets(PresetStyle).WithSpeed(6),
 	}
 
 	if os.Getenv("GOLANGCI_COM_RUN") == "1" {

pkg/enabled_linters.go

@@ -100,6 +100,8 @@ func testOneSource(t *testing.T, sourcePath string) {
 		"--out-format=line-number",
 		"--print-welcome=false",
 		"--govet.check-shadowing=true",
+		"--depguard.include-go-root",
+		"--depguard.packages='log'",
 		sourcePath)
 	runGoErrchk(cmd, t)
 }

pkg/enabled_linters_test.go

@@ -0,0 +1,57 @@
+package golinters
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	depguardAPI "github.com/OpenPeeDeeP/depguard"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+type Depguard struct{}
+
+func (Depguard) Name() string {
+	return "depguard"
+}
+
+func (Depguard) Desc() string {
+	return "Go linter that checks if package imports are in a list of acceptable packages"
+}
+
+func (d Depguard) Run(ctx context.Context, lintCtx *Context) ([]result.Issue, error) {
+	dg := &depguardAPI.Depguard{
+		Packages:      lintCtx.Settings().Depguard.Packages,
+		IncludeGoRoot: lintCtx.Settings().Depguard.IncludeGoRoot,
+	}
+	listType := lintCtx.Settings().Depguard.ListType
+	var found bool
+	dg.ListType, found = depguardAPI.StringToListType[strings.ToLower(listType)]
+	if !found {
+		if listType != "" {
+			return nil, fmt.Errorf("unsure what list type %s is", listType)
+		}
+		dg.ListType = depguardAPI.LTBlacklist
+	}
+
+	issues, err := dg.Run(lintCtx.LoaderConfig, lintCtx.Program)
+	if err != nil {
+		return nil, err
+	}
+	if len(issues) == 0 {
+		return nil, nil
+	}
+	msgSuffix := "is in the blacklist"
+	if dg.ListType == depguardAPI.LTWhitelist {
+		msgSuffix = "is not in the whitelist"
+	}
+	res := make([]result.Issue, 0, len(issues))
+	for _, i := range issues {
+		res = append(res, result.Issue{
+			Pos:        i.Position,
+			Text:       fmt.Sprintf("%s %s", formatCode(i.PackageName, lintCtx.Cfg), msgSuffix),
+			FromLinter: d.Name(),
+		})
+	}
+	return res, nil
+}

pkg/golinters/depguard.go

@@ -0,0 +1,9 @@
+package testdata
+
+import (
+	"log" // ERROR "`log` is in the blacklist"
+)
+
+func SpewDebugInfo() {
+	log.Println("Debug info")
+}