Integrate ImportAs linter (#1783)

* Integrate ImportAs linter

* review: don't panic :)

Co-authored-by: Fernandez Ludovic <[email protected]>

.golangci.example.yml

@@ -444,6 +444,11 @@ linters-settings:
       - ginkgo\\.F.* # these are used just for local development
     # Exclude godoc examples from forbidigo checks.  Default is true.
     exclude_godoc_examples: false
+  importas:
+    # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
+    servingv1: knative.dev/serving/pkg/apis/serving/v1
+    # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
+    autoscalingv1alpha1: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
 
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.

go.mod

@@ -34,6 +34,7 @@ require (
 	github.com/jgautheron/goconst v1.4.0
 	github.com/jingyugao/rowserrcheck v0.0.0-20210130005344-c6a0c12dd98d
 	github.com/jirfag/go-printf-func-name v0.0.0-20191110105641-45db9963cdd3
+	github.com/julz/importas v0.0.0-20210226073942-60b4fa260dd0
 	github.com/kisielk/errcheck v1.6.0
 	github.com/kulti/thelper v0.4.0
 	github.com/kunwardeep/paralleltest v1.0.2

pkg/config/config.go

@@ -275,6 +275,7 @@ type LintersSettings struct {
 	Ifshort          IfshortSettings
 	Predeclared      PredeclaredSettings
 	Cyclop           Cyclop
+	ImportAs         ImportAsSettings
 
 	Custom map[string]CustomLinterSettings
 }
@@ -461,6 +462,8 @@ type Cyclop struct {
 	SkipTests      bool    `mapstructure:"skip-tests"`
 }
 
+type ImportAsSettings map[string]string
+
 var defaultLintersSettings = LintersSettings{
 	Lll: LllSettings{
 		LineLength: 120,

pkg/golinters/importas.go

@@ -0,0 +1,34 @@
+package golinters
+
+import (
+	"fmt"
+
+	"github.com/julz/importas" // nolint: misspell
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
+)
+
+func NewImportAs(settings *config.ImportAsSettings) *goanalysis.Linter {
+	analyzer := importas.Analyzer
+
+	return goanalysis.NewLinter(
+		analyzer.Name,
+		analyzer.Doc,
+		[]*analysis.Analyzer{analyzer},
+		nil,
+	).WithContextSetter(func(lintCtx *linter.Context) {
+		if settings == nil {
+			return
+		}
+
+		for alias, pkg := range *settings {
+			err := analyzer.Flags.Set("alias", fmt.Sprintf("%s:%s", pkg, alias))
+			if err != nil {
+				lintCtx.Log.Errorf("failed to parse configuration: %v", err)
+			}
+		}
+	}).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/lint/lintersdb/manager.go

@@ -99,6 +99,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 	var ifshortCfg *config.IfshortSettings
 	var reviveCfg *config.ReviveSettings
 	var cyclopCfg *config.Cyclop
+	var importAsCfg *config.ImportAsSettings
 	if m.cfg != nil {
 		govetCfg = &m.cfg.LintersSettings.Govet
 		testpackageCfg = &m.cfg.LintersSettings.Testpackage
@@ -110,6 +111,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		ifshortCfg = &m.cfg.LintersSettings.Ifshort
 		reviveCfg = &m.cfg.LintersSettings.Revive
 		cyclopCfg = &m.cfg.LintersSettings.Cyclop
+		importAsCfg = &m.cfg.LintersSettings.ImportAs
 	}
 	const megacheckName = "megacheck"
 	lcs := []*linter.Config{
@@ -380,6 +382,10 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetStyle).
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/sanposhiho/wastedassign"),
+		linter.NewConfig(golinters.NewImportAs(importAsCfg)).
+			WithPresets(linter.PresetStyle).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/julz/importas"),
 
 		// nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives
 		linter.NewConfig(golinters.NewNoLintLint()).

test/testdata/configs/importas.yml

@@ -0,0 +1,4 @@
+linters-settings:
+    importas:
+      fff: fmt
+      std_os: os

test/testdata/importas.go

@@ -0,0 +1,13 @@
+//args: -Eimportas
+//config_path: testdata/configs/importas.yml
+package testdata
+
+import (
+	wrong_alias "fmt"      // ERROR `import "fmt" imported as "wrong_alias" but must be "fff" according to config`
+	wrong_alias_again "os" // ERROR `import "os" imported as "wrong_alias_again" but must be "std_os" according to config`
+)
+
+func ImportAsWrongAlias() {
+	wrong_alias.Println("foo")
+	wrong_alias_again.Stdout.WriteString("bar")
+}