add promlinter to lint metrics name

Signed-off-by: Ben Ye <[email protected]>

Author: yeya24

go.sum

@@ -277,6 +277,7 @@ type LintersSettings struct {
 	Cyclop           Cyclop
 	ImportAs         ImportAsSettings
 	GoModDirectives  GoModDirectivesSettings
+	Promlinter       PromlinterSettings
 
 	Custom map[string]CustomLinterSettings
 }
@@ -457,6 +458,10 @@ type PredeclaredSettings struct {
 	Qualified bool   `mapstructure:"q"`
 }
 
+type PromlinterSettings struct {
+	Strict bool `mapstructure:"strict"`
+}
+
 type Cyclop struct {
 	MaxComplexity  int     `mapstructure:"max-complexity"`
 	PackageAverage float64 `mapstructure:"package-average"`

pkg/config/config.go

@@ -0,0 +1,70 @@
+package golinters
+
+import (
+	"fmt"
+	"go/ast"
+	"strings"
+	"sync"
+
+	"github.com/yeya24/promlinter"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+func NewPromlinter() *goanalysis.Linter {
+	var mu sync.Mutex
+	var resIssues []goanalysis.Issue
+
+	const linterName = "promlinter"
+	analyzer := &analysis.Analyzer{
+		Name: linterName,
+		Doc:  goanalysis.TheOnlyanalyzerDoc,
+	}
+	return goanalysis.NewLinter(
+		linterName,
+		"Check Prometheus metrics naming via promlint",
+		[]*analysis.Analyzer{analyzer},
+		nil,
+	).WithContextSetter(func(lintCtx *linter.Context) {
+		strict := lintCtx.Cfg.LintersSettings.Promlinter.Strict
+
+		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
+			files := make([]*ast.File, 0)
+
+			for _, f := range pass.Files {
+				if strings.HasSuffix(pass.Fset.Position(f.Pos()).Filename, "_test.go") {
+					continue
+				}
+
+				files = append(files, f)
+			}
+			issues := promlinter.Run(pass.Fset, files, strict)
+
+			if len(issues) == 0 {
+				return nil, nil
+			}
+
+			res := make([]goanalysis.Issue, len(issues))
+			for k, i := range issues {
+				issue := result.Issue{
+					Pos:        i.Pos,
+					Text:       fmt.Sprintf("Metric: %s Error: %s", i.Metric, i.Text),
+					FromLinter: linterName,
+				}
+
+				res[k] = goanalysis.NewIssue(&issue, pass)
+			}
+
+			mu.Lock()
+			resIssues = append(resIssues, res...)
+			mu.Unlock()
+
+			return nil, nil
+		}
+	}).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
+		return resIssues
+	}).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/promlinter.go

@@ -479,7 +479,10 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithSince("v1.39.0").
 			WithPresets(linter.PresetStyle, linter.PresetModule).
 			WithURL("https://github.com/ldez/gomoddirectives"),
-
+		linter.NewConfig(golinters.NewPromlinter()).
+			WithPresets(linter.PresetStyle).
+			WithAutoFix().
+			WithURL("https://github.com/yeya24/promlinter"),
 		// nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives
 		linter.NewConfig(golinters.NewNoLintLint()).
 			WithSince("v1.26.0").