feat: add iotamixing linter

Author: AdminBenni

.golangci.next.reference.yml

@@ -68,6 +68,7 @@ linters:
     - ineffassign
     - interfacebloat
     - intrange
+    - iotamixing
     - ireturn
     - lll
     - loggercheck
@@ -184,6 +185,7 @@ linters:
     - ineffassign
     - interfacebloat
     - intrange
+    - iotamixing
     - ireturn
     - lll
     - loggercheck
@@ -2032,6 +2034,11 @@ linters-settings:
     # Default: 10
     max: 5
 
+  iotamixing:
+    # Whether to report individual consts rather than just the const block.
+    # Default: false
+    report-individual: true
+
   ireturn:
     # List of interfaces to allow.
     # Lists of the keywords and regular expressions matched to interface or package names can be used.

go.mod

@@ -1,12 +1,15 @@
 module github.com/golangci/golangci-lint
 
-go 1.23.0
+go 1.23.3
+
+toolchain go1.23.11
 
 require (
 	4d63.com/gocheckcompilerdirectives v1.3.0
 	4d63.com/gochecknoglobals v0.2.2
 	github.com/4meepo/tagalign v1.4.2
 	github.com/Abirdcfly/dupword v0.1.3
+	github.com/AdminBenni/iota-mixing v0.0.5
 	github.com/Antonboom/errname v1.0.0
 	github.com/Antonboom/nilnil v1.0.1
 	github.com/Antonboom/testifylint v1.5.2

go.sum

@@ -387,6 +387,7 @@
             "ineffassign",
             "interfacebloat",
             "intrange",
+            "iotamixing",
             "ireturn",
             "lll",
             "loggercheck",
@@ -2084,6 +2085,17 @@
             }
           }
         },
+        "iotamixing": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "report-individual": {
+              "description": "Whether to report individual consts rather than just the const block.",
+              "type": "boolean",
+              "default": false
+            }
+          }
+        },
         "ireturn": {
           "type": "object",
           "additionalProperties": false,

jsonschema/golangci.next.jsonschema.json

@@ -255,6 +255,7 @@ type LintersSettings struct {
 	ImportAs        ImportAsSettings
 	Inamedparam     INamedParamSettings
 	InterfaceBloat  InterfaceBloatSettings
+	IotaMixing      IotaMixingSettings
 	Ireturn         IreturnSettings
 	Lll             LllSettings
 	LoggerCheck     LoggerCheckSettings
@@ -704,6 +705,10 @@ type InterfaceBloatSettings struct {
 	Max int `mapstructure:"max"`
 }
 
+type IotaMixingSettings struct {
+	ReportIndividual bool `mapstructure:"report-individual"`
+}
+
 type IreturnSettings struct {
 	Allow  []string `mapstructure:"allow"`
 	Reject []string `mapstructure:"reject"`

pkg/config/linters_settings.go

@@ -0,0 +1,29 @@
+package iotamixing
+
+import (
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/AdminBenni/iota-mixing/pkg/analyzer"
+	"github.com/AdminBenni/iota-mixing/pkg/analyzer/flags"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/goanalysis"
+)
+
+func New(settings *config.IotaMixingSettings) *goanalysis.Linter {
+	a := analyzer.GetIotaMixingAnalyzer()
+
+	flags.SetupFlags(&a.Flags)
+
+	cfg := map[string]map[string]any{}
+	if settings != nil {
+		cfg[a.Name] = map[string]any{flags.ReportIndividualFlagName: settings.ReportIndividual}
+	}
+
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		cfg,
+	).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/iotamixing/iotamixing.go

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

pkg/golinters/iotamixing/iotamixing_integration_test.go

@@ -0,0 +1,50 @@
+//golangcitest:args -Eiotamixing
+//golangcitest:config_path testdata/iotamixing-report-individual.yml
+package testdata
+
+import "fmt"
+
+const (
+	InvalidPerIndividualIotaDeclAboveAnything = "anything" // want "InvalidPerIndividualIotaDeclAboveAnything is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+	InvalidPerIndividualIotaDeclAboveNotZero  = iota
+	InvalidPerIndividualIotaDeclAboveNotOne
+	InvalidPerIndividualIotaDeclAboveNotTwo
+)
+
+const (
+	InvalidPerIndividualIotaDeclBelowZero = iota
+	InvalidPerIndividualIotaDeclBelowOne
+	InvalidPerIndividualIotaDeclBelowTwo
+	InvalidPerIndividualIotaDeclBelowAnything = "anything" // want "InvalidPerIndividualIotaDeclBelowAnything is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+)
+
+const (
+	InvalidPerIndividualIotaDeclBetweenZero = iota
+	InvalidPerIndividualIotaDeclBetweenOne
+	InvalidPerIndividualIotaDeclBetweenAnything = "anything" // want "InvalidPerIndividualIotaDeclBetweenAnything is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+	InvalidPerIndividualIotaDeclBetweenNotTwo
+)
+
+const (
+	InvalidPerIndividualIotaDeclMultipleAbove   = "above" // want "InvalidPerIndividualIotaDeclMultipleAbove is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+	InvalidPerIndividualIotaDeclMultipleNotZero = iota
+	InvalidPerIndividualIotaDeclMultipleNotOne
+	InvalidPerIndividualIotaDeclMultipleBetween = "between" // want "InvalidPerIndividualIotaDeclMultipleBetween is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+	InvalidPerIndividualIotaDeclMultipleNotTwo
+	InvalidPerIndividualIotaDeclMultipleBelow = "below" // want "InvalidPerIndividualIotaDeclMultipleBelow is a const with r-val in same const block as iota. keep iotas in separate const blocks"
+)
+
+const (
+	ValidPerIndividualIotaZero = iota
+	ValidPerIndividualIotaOne
+	ValidPerIndividualIotaTwo
+)
+
+const (
+	ValidPerIndividualRegularSomething = "something"
+	ValidPerIndividualRegularAnything  = "anything"
+)
+
+func _() {
+	fmt.Println("using the std import so goland doesn't nuke it")
+}

pkg/golinters/iotamixing/testdata/iotamixing-report-individual.go

@@ -0,0 +1,3 @@
+linters-settings:
+  iotamixing:
+    report-individual: true

pkg/golinters/iotamixing/testdata/iotamixing-report-individual.yml

@@ -0,0 +1,55 @@
+//golangcitest:args -Eiotamixing
+package testdata
+
+import "fmt"
+
+// iota mixing in const block containing an iota and r-val declared above.
+const ( // want "iota mixing. keep iotas in separate blocks to consts with r-val"
+	InvalidPerBlockIotaDeclAboveAnything = "anything"
+	InvalidPerBlockIotaDeclAboveNotZero  = iota
+	InvalidPerBlockIotaDeclAboveNotOne
+	InvalidPerBlockIotaDeclAboveNotTwo
+)
+
+// iota mixing in const block containing an iota and r-val declared below.
+const ( // want "iota mixing. keep iotas in separate blocks to consts with r-val"
+	InvalidPerBlockIotaDeclBelowZero = iota
+	InvalidPerBlockIotaDeclBelowOne
+	InvalidPerBlockIotaDeclBelowTwo
+	InvalidPerBlockIotaDeclBelowAnything = "anything"
+)
+
+// iota mixing in const block containing an iota and r-val declared between consts.
+const ( // want "iota mixing. keep iotas in separate blocks to consts with r-val"
+	InvalidPerBlockIotaDeclBetweenZero = iota
+	InvalidPerBlockIotaDeclBetweenOne
+	InvalidPerBlockIotaDeclBetweenAnything = "anything"
+	InvalidPerBlockIotaDeclBetweenNotTwo
+)
+
+// iota mixing in const block containing an iota and r-vals declared above, between, and below consts.
+const ( // want "iota mixing. keep iotas in separate blocks to consts with r-val"
+	InvalidPerBlockIotaDeclMultipleAbove   = "above"
+	InvalidPerBlockIotaDeclMultipleNotZero = iota
+	InvalidPerBlockIotaDeclMultipleNotOne
+	InvalidPerBlockIotaDeclMultipleBetween = "between"
+	InvalidPerBlockIotaDeclMultipleNotTwo
+	InvalidPerBlockIotaDeclMultipleBelow = "below"
+)
+
+// no iota mixing in a const block containing an iota and no r-vals.
+const (
+	ValidPerBlockIotaZero = iota
+	ValidPerBlockIotaOne
+	ValidPerBlockIotaTwo
+)
+
+// no iota mixing in a const block containing r-vals and no iota.
+const (
+	ValidPerBlockRegularSomething = "something"
+	ValidPerBlockRegularAnything  = "anything"
+)
+
+func _() {
+	fmt.Println("using the std import so goland doesn't nuke it")
+}