Add pkgname linter

Author: uudashr

.golangci.next.reference.yml

@@ -97,6 +97,7 @@ linters:
     - nosprintfhostport
     - paralleltest
     - perfsprint
+    - pkgname
     - prealloc
     - predeclared
     - promlinter
@@ -207,6 +208,7 @@ linters:
     - nosprintfhostport
     - paralleltest
     - perfsprint
+    - pkgname
     - prealloc
     - predeclared
     - promlinter
@@ -2092,6 +2094,11 @@ linters:
       # Default: true
       hex-format: false
 
+    pkgname:
+      # Include import alias in checks.
+      # Default: false
+      import-alias: true
+
     prealloc:
       # IMPORTANT: we don't recommend using this linter before doing performance profiling.
       # For most programs usage of prealloc will be a premature optimization.

go.mod

@@ -121,6 +121,7 @@ require (
 	github.com/ultraware/whitespace v0.2.0
 	github.com/uudashr/gocognit v1.2.0
 	github.com/uudashr/iface v1.4.0
+	github.com/uudashr/pkgname v1.0.0
 	github.com/valyala/quicktemplate v1.8.0
 	github.com/xen0n/gosmopolitan v1.3.0
 	github.com/yagipy/maintidx v1.0.0

go.sum

@@ -1512,6 +1512,17 @@
             }
           }
         },
+        "pkgnameSettings": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "import-alias": {
+              "description": "Include import alias in the checks.",
+              "type": "boolean",
+              "default": false
+            }
+          }
+        },
         "goconstSettings": {
           "type": "object",
           "additionalProperties": false,
@@ -4523,6 +4534,9 @@
             "perfsprint": {
               "$ref": "#/definitions/settings/definitions/perfsprintSettings"
             },
+            "pkgname": {
+              "$ref": "#/definitions/settings/definitions/pkgnameSettings"
+            },
             "prealloc": {
               "$ref": "#/definitions/settings/definitions/preallocSettings"
             },

jsonschema/golangci.next.jsonschema.json

@@ -259,6 +259,7 @@ type LintersSettings struct {
 	NoNamedReturns           NoNamedReturnsSettings           `mapstructure:"nonamedreturns"`
 	ParallelTest             ParallelTestSettings             `mapstructure:"paralleltest"`
 	PerfSprint               PerfSprintSettings               `mapstructure:"perfsprint"`
+	Pkgname                  PkgnameSettings                  `mapstructure:"pkgname"`
 	Prealloc                 PreallocSettings                 `mapstructure:"prealloc"`
 	Predeclared              PredeclaredSettings              `mapstructure:"predeclared"`
 	Promlinter               PromlinterSettings               `mapstructure:"promlinter"`
@@ -738,6 +739,10 @@ type PerfSprintSettings struct {
 	HexFormat  bool `mapstructure:"hex-format"`
 }
 
+type PkgnameSettings struct {
+	ImportAlias bool `mapstructure:"import-alias"`
+}
+
 type PreallocSettings struct {
 	Simple     bool `mapstructure:"simple"`
 	RangeLoops bool `mapstructure:"range-loops"`

pkg/config/linters_settings.go

@@ -0,0 +1,22 @@
+package pkgname
+
+import (
+	"github.com/golangci/golangci-lint/v2/pkg/config"
+	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
+	"github.com/uudashr/pkgname"
+)
+
+func New(settings *config.PkgnameSettings) *goanalysis.Linter {
+	var cfg map[string]any
+
+	if settings != nil {
+		cfg = map[string]any{
+			"include-import-alias": settings.ImportAlias,
+		}
+	}
+
+	return goanalysis.
+		NewLinterFromAnalyzer(pkgname.Analyzer).
+		WithConfig(cfg).
+		WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/golinters/pkgname/pkgname.go

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

pkg/golinters/pkgname/pkgname_integration_test.go

@@ -0,0 +1,15 @@
+//golangcitest:args -Epkgname
+//golangcitest:config_path importalias.yml
+package hello
+
+import (
+	go_format "fmt" // want "found import 'fmt' with alias 'go_format', should not use under_score in package alias name"
+	"log"
+	structLog "log/slog" // want "found import 'log/slog' with alias 'structLog', should not use mixedCaps in package alias name"
+)
+
+func Hello() {
+	go_format.Println("Hello, World!")
+	structLog.Info("Hello, World!")
+	log.Println("Hello, World!")
+}

pkg/golinters/pkgname/testdata/importalias.go

@@ -0,0 +1,6 @@
+version: "2"
+
+linters:
+  settings:
+    pkgname:
+      import-alias: true

pkg/golinters/pkgname/testdata/importalias.yml

@@ -0,0 +1,3 @@
+//golangcitest:args -Epkgname
+
+package helloWorld // want "found package 'helloWorld', should not use mixedCaps in package name"