Add docenv linter

.golangci.next.reference.yml

@@ -22,6 +22,7 @@ linters:
     - cyclop
     - decorder
     - depguard
+    - docenv
     - dogsled
     - dupl
     - dupword
@@ -138,6 +139,7 @@ linters:
     - cyclop
     - decorder
     - depguard
+    - docenv
     - dogsled
     - dupl
     - dupword
@@ -394,6 +396,11 @@ linters-settings:
           - pkg: "github.com/pkg/errors"
             desc: Should be replaced by standard lib errors package
 
+  docenv:
+    # Set custom env tag name.
+    # Default: env
+    tag-name: env
+
   dogsled:
     # Checks assignments with too many blank identifiers.
     # Default: 2

go.mod

@@ -145,6 +145,7 @@ require (
 	github.com/ettle/strcase v0.2.0 // indirect
 	github.com/fatih/structtag v1.2.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/g4s8/envdoc v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/go-toolsmith/astcast v1.1.0 // indirect
 	github.com/go-toolsmith/astcopy v1.1.0 // indirect

pkg/config/linters_settings.go

@@ -19,6 +19,9 @@ var defaultLintersSettings = LintersSettings{
 		DisableDecOrderCheck:      true,
 		DisableInitFuncFirstCheck: true,
 	},
+	Docenv: DocenvSettings{
+		TagName: "env",
+	},
 	Dogsled: DogsledSettings{
 		MaxBlankIdentifiers: 2,
 	},
@@ -206,6 +209,7 @@ type LintersSettings struct {
 	Cyclop          Cyclop
 	Decorder        DecorderSettings
 	Depguard        DepGuardSettings
+	Docenv          DocenvSettings
 	Dogsled         DogsledSettings
 	Dupl            DuplSettings
 	DupWord         DupWordSettings
@@ -355,6 +359,10 @@ type DecorderSettings struct {
 	DisableInitFuncFirstCheck bool     `mapstructure:"disable-init-func-first-check"`
 }
 
+type DocenvSettings struct {
+	TagName string `mapstructure:"tag-name"`
+}
+
 type DogsledSettings struct {
 	MaxBlankIdentifiers int `mapstructure:"max-blank-identifiers"`
 }

pkg/golinters/docenv/docenv.go

@@ -0,0 +1,25 @@
+package docenv
+
+import (
+	"github.com/g4s8/envdoc/linter"
+
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/goanalysis"
+)
+
+func New(cfg *config.DocenvSettings) *goanalysis.Linter {
+	opts := []linter.Option{linter.WithNoComments()}
+	if cfg != nil {
+		opts = append(opts, linter.WithEnvName(cfg.TagName))
+	}
+
+	a := linter.NewAnlyzer(false, opts...)
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/docenv/docenv_integration_test.go

@@ -0,0 +1,11 @@
+package docenv
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/docenv/testdata/docenv.go

@@ -0,0 +1,14 @@
+//golangcitest:args -Edocenv
+package testdata
+
+type Config struct {
+	// Host name.
+	Host string `env:"HOST"`
+
+	// Port number.
+	Port int `env:"PORT"`
+
+	Undocumented string `env:"UNDOCUMENTED"` // want "field `Undocumented` with `env` tag should have a documentation comment"
+
+	NotEnv string
+}

pkg/golinters/docenv/testdata/docenv_custom.go

@@ -0,0 +1,15 @@
+//golangcitest:args -Edocenv
+//golangcitest:config_path testdata/docenv_custom.yml
+package testdata
+
+type Config struct {
+	// Host name.
+	Host string `foo:"HOST"`
+
+	// Port number.
+	Port int `foo:"PORT"`
+
+	Undocumented string `foo:"UNDOCUMENTED"` // want "field `Undocumented` with `foo` tag should have a documentation comment"
+
+	NotEnv string
+}

pkg/golinters/docenv/testdata/docenv_custom.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  docenv:
+    tag-name: foo

pkg/lint/lintersdb/builder_linter.go

@@ -14,6 +14,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/cyclop"
 	"github.com/golangci/golangci-lint/pkg/golinters/decorder"
 	"github.com/golangci/golangci-lint/pkg/golinters/depguard"
+	"github.com/golangci/golangci-lint/pkg/golinters/docenv"
 	"github.com/golangci/golangci-lint/pkg/golinters/dogsled"
 	"github.com/golangci/golangci-lint/pkg/golinters/dupl"
 	"github.com/golangci/golangci-lint/pkg/golinters/dupword"
@@ -203,6 +204,11 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithPresets(linter.PresetStyle, linter.PresetImport, linter.PresetModule).
 			WithURL("https://github.com/OpenPeeDeeP/depguard"),
 
+		linter.NewConfig(docenv.New(&cfg.LintersSettings.Docenv)).
+			WithSince("v1.63.0").
+			WithPresets(linter.PresetComment).
+			WithURL("https://github.com/g4s8/envdoc/tree/master/docenv"),
+
 		linter.NewConfig(dogsled.New(&cfg.LintersSettings.Dogsled)).
 			WithSince("v1.19.0").
 			WithPresets(linter.PresetStyle).