gomodreplace -> gomoddirectives

Author: ldez

.golangci.example.yml

@@ -449,12 +449,16 @@ linters-settings:
     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
-  gomodreplace:
+  gomoddirectives:
     # Allow local `replace` directives. Default is false.
-    local: false
+    replace-local: false
     # List of allowed `replace` directives. Default is empty.
-    allow-list:
+    replace-allow-list:
       - launchpad.net/gocheck
+    # Allow to not explain why the version has been retracted in the `retract` directives. Default is false.
+    retract-allow-no-explanation: false
+    # Forbid the use of the `exclude` directives. Default is false.
+    exclude-forbidden: false
 
   # The custom section can be used to define linter plugins to be loaded at runtime. See README doc
   #  for more info.

go.mod

@@ -41,7 +41,7 @@ require (
 	github.com/kulti/thelper v0.4.0
 	github.com/kunwardeep/paralleltest v1.0.2
 	github.com/kyoh86/exportloopref v0.1.8
-	github.com/ldez/gomodreplace v0.2.0
+	github.com/ldez/gomoddirectives v0.1.0
 	github.com/maratori/testpackage v1.0.1
 	github.com/matoous/godox v0.0.0-20210227103229-6504466cf951 // v1.0
 	github.com/mattn/go-colorable v0.1.8

go.sum

@@ -276,7 +276,7 @@ type LintersSettings struct {
 	Predeclared      PredeclaredSettings
 	Cyclop           Cyclop
 	ImportAs         ImportAsSettings
-	GoModReplace     GoModReplaceSettings
+	GoModDirectives  GoModDirectivesSettings
 
 	Custom map[string]CustomLinterSettings
 }
@@ -465,9 +465,11 @@ type Cyclop struct {
 
 type ImportAsSettings map[string]string
 
-type GoModReplaceSettings struct {
-	AllowList []string `mapstructure:"allow-list"`
-	Local     bool     `mapstructure:"local"`
+type GoModDirectivesSettings struct {
+	ReplaceAllowList          []string `mapstructure:"replace-allow-list"`
+	ReplaceLocal              bool     `mapstructure:"replace-local"`
+	ExcludeForbidden          bool     `mapstructure:"exclude-forbidden"`
+	RetractAllowNoExplanation bool     `mapstructure:"retract-allow-no-explanation"`
 }
 
 var defaultLintersSettings = LintersSettings{

pkg/config/config.go

@@ -3,26 +3,28 @@ package golinters
 import (
 	"sync"
 
-	"github.com/golangci/golangci-lint/pkg/config"
-	"github.com/ldez/gomodreplace"
+	"github.com/ldez/gomoddirectives"
 	"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"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
-const goModReplaceName = "gomodreplace"
+const goModDirectivesName = "gomoddirectives"
 
-// NewGoModReplace returns a new gomodreplace linter.
-func NewGoModReplace(settings *config.GoModReplaceSettings) *goanalysis.Linter {
+// NewGoModDirectives returns a new gomoddirectives linter.
+func NewGoModDirectives(settings *config.GoModDirectivesSettings) *goanalysis.Linter {
 	var issues []goanalysis.Issue
 	var mu sync.Mutex
 
-	var opts gomodreplace.Options
+	var opts gomoddirectives.Options
 	if settings != nil {
-		opts.AllowLocal = settings.Local
-		opts.AllowList = settings.AllowList
+		opts.ReplaceAllowLocal = settings.ReplaceLocal
+		opts.ReplaceAllowList = settings.ReplaceAllowList
+		opts.RetractAllowNoExplanation = settings.RetractAllowNoExplanation
+		opts.ExcludeForbidden = settings.ExcludeForbidden
 	}
 
 	analyzer := &analysis.Analyzer{
@@ -31,24 +33,24 @@ func NewGoModReplace(settings *config.GoModReplaceSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		goModReplaceName,
-		"Manage the use of replace directives in go.mod.",
+		goModDirectivesName,
+		"Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.",
 		[]*analysis.Analyzer{analyzer},
 		nil,
 	).WithContextSetter(func(lintCtx *linter.Context) {
 		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
-			results, err := gomodreplace.Analyze(opts)
+			results, err := gomoddirectives.Analyze(opts)
 			if err != nil {
 				lintCtx.Log.Warnf("running %s failed: %s: "+
-					"if you are not using go modules it is suggested to disable this linter", goModReplaceName, err)
+					"if you are not using go modules it is suggested to disable this linter", goModDirectivesName, err)
 				return nil, nil
 			}
 
 			mu.Lock()
 
 			for _, p := range results {
 				issues = append(issues, goanalysis.NewIssue(&result.Issue{
-					FromLinter: goModReplaceName,
+					FromLinter: goModDirectivesName,
 					Pos:        p.Start,
 					Text:       p.Reason,
 				}, pass))

pkg/golinters/gomodreplace.go renamed to pkg/golinters/gomoddirectives.go

@@ -100,7 +100,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 	var reviveCfg *config.ReviveSettings
 	var cyclopCfg *config.Cyclop
 	var importAsCfg *config.ImportAsSettings
-	var goModReplaceCfg *config.GoModReplaceSettings
+	var goModDirectivesCfg *config.GoModDirectivesSettings
 	if m.cfg != nil {
 		govetCfg = &m.cfg.LintersSettings.Govet
 		testpackageCfg = &m.cfg.LintersSettings.Testpackage
@@ -113,7 +113,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		reviveCfg = &m.cfg.LintersSettings.Revive
 		cyclopCfg = &m.cfg.LintersSettings.Cyclop
 		importAsCfg = &m.cfg.LintersSettings.ImportAs
-		goModReplaceCfg = &m.cfg.LintersSettings.GoModReplace
+		goModDirectivesCfg = &m.cfg.LintersSettings.GoModDirectives
 	}
 	const megacheckName = "megacheck"
 	lcs := []*linter.Config{
@@ -396,10 +396,10 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetStyle).
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/gostaticanalysis/forcetypeassert"),
-		linter.NewConfig(golinters.NewGoModReplace(goModReplaceCfg)).
+		linter.NewConfig(golinters.NewGoModDirectives(goModDirectivesCfg)).
 			WithPresets(linter.PresetStyle).
 			WithLoadForGoAnalysis().
-			WithURL("https://github.com/ldez/gomodreplace"),
+			WithURL("https://github.com/ldez/gomoddirectives"),
 
 		// nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives
 		linter.NewConfig(golinters.NewNoLintLint()).