feat: Add swaggo/swag formatter

Author: cooperbenson-qz

go.mod

@@ -109,6 +109,7 @@ require (
 	github.com/ssgreg/nlreturn/v2 v2.2.1
 	github.com/stbenjam/no-sprintf-host-port v0.2.0
 	github.com/stretchr/testify v1.10.0
+	github.com/swaggo/swag v1.16.4
 	github.com/tdakkota/asciicheck v0.4.1
 	github.com/tetafro/godot v1.5.0
 	github.com/timakin/bodyclose v0.0.0-20241222091800-1db5c5ca4d67
@@ -138,7 +139,10 @@ require (
 )
 
 require (
+	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/Masterminds/semver/v3 v3.3.1 // indirect
+	github.com/PuerkitoBio/purell v1.1.1 // indirect
+	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/ccojocar/zxcvbn-go v1.0.2 // indirect
@@ -156,6 +160,10 @@ require (
 	github.com/fatih/structtag v1.2.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/go-openapi/jsonpointer v0.19.5 // indirect
+	github.com/go-openapi/jsonreference v0.19.6 // indirect
+	github.com/go-openapi/spec v0.20.4 // indirect
+	github.com/go-openapi/swag v0.19.15 // indirect
 	github.com/go-toolsmith/astcast v1.1.0 // indirect
 	github.com/go-toolsmith/astcopy v1.1.0 // indirect
 	github.com/go-toolsmith/astequal v1.2.0 // indirect
@@ -173,9 +181,11 @@ require (
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/hexops/gotextdiff v1.0.3 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
 	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
@@ -209,6 +219,7 @@ require (
 	go.uber.org/zap v1.24.0 // indirect
 	golang.org/x/exp v0.0.0-20240909161429-701f63a606c0 // indirect
 	golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac // indirect
+	golang.org/x/net v0.39.0 // indirect
 	golang.org/x/sync v0.13.0 // indirect
 	golang.org/x/text v0.24.0 // indirect
 	google.golang.org/protobuf v1.36.6 // indirect

go.sum

@@ -836,7 +836,8 @@
         "gofmt",
         "gofumpt",
         "goimports",
-        "golines"
+        "golines",
+        "swaggo"
       ]
     },
     "settings": {

jsonschema/golangci.next.jsonschema.json

@@ -49,5 +49,5 @@ func (l *Linters) validateNoFormatters() error {
 }
 
 func getAllFormatterNames() []string {
-	return []string{"gci", "gofmt", "gofumpt", "goimports", "golines"}
+	return []string{"gci", "gofmt", "gofumpt", "goimports", "golines", "swaggo"}
 }

pkg/config/linters.go

@@ -12,6 +12,7 @@ import (
 	"github.com/golangci/golangci-lint/v2/pkg/goformatters/gofumpt"
 	"github.com/golangci/golangci-lint/v2/pkg/goformatters/goimports"
 	"github.com/golangci/golangci-lint/v2/pkg/goformatters/golines"
+	"github.com/golangci/golangci-lint/v2/pkg/goformatters/swaggo"
 	"github.com/golangci/golangci-lint/v2/pkg/logutils"
 )
 
@@ -41,6 +42,10 @@ func NewMetaFormatter(log logutils.Log, cfg *config.Formatters, runCfg *config.R
 		m.formatters = append(m.formatters, goimports.New(&cfg.Settings.GoImports))
 	}
 
+	if slices.Contains(cfg.Enable, swaggo.Name) {
+		m.formatters = append(m.formatters, swaggo.New())
+	}
+
 	// gci is a last because the only goal of gci is to handle imports.
 	if slices.Contains(cfg.Enable, gci.Name) {
 		formatter, err := gci.New(&cfg.Settings.Gci)
@@ -86,5 +91,5 @@ func (m *MetaFormatter) Format(filename string, src []byte) []byte {
 }
 
 func IsFormatter(name string) bool {
-	return slices.Contains([]string{gofmt.Name, gofumpt.Name, goimports.Name, gci.Name, golines.Name}, name)
+	return slices.Contains([]string{gofmt.Name, gofumpt.Name, goimports.Name, gci.Name, golines.Name, swaggo.Name}, name)
 }

pkg/goformatters/meta_formatter.go

@@ -0,0 +1,23 @@
+package swaggo
+
+import "github.com/swaggo/swag"
+
+const Name = "swaggo"
+
+type Formatter struct {
+	formatter *swag.Formatter
+}
+
+func New() *Formatter {
+	return &Formatter{
+		formatter: swag.NewFormatter(),
+	}
+}
+
+func (*Formatter) Name() string {
+	return Name
+}
+
+func (f *Formatter) Format(path string, src []byte) ([]byte, error) {
+	return f.formatter.Format(path, src)
+}

pkg/goformatters/swaggo/swaggo.go

@@ -0,0 +1,22 @@
+package swaggo
+
+import (
+	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
+	"github.com/golangci/golangci-lint/v2/pkg/goformatters"
+	"github.com/golangci/golangci-lint/v2/pkg/goformatters/swaggo"
+	"github.com/golangci/golangci-lint/v2/pkg/golinters/internal"
+	"golang.org/x/tools/go/analysis"
+)
+
+const linterName = "swaggo"
+
+func New() *goanalysis.Linter {
+	a := goformatters.NewAnalyzer(
+		internal.LinterLogger.Child(linterName),
+		"Checks if swaggo comments are formatted",
+		swaggo.New(),
+	)
+
+	return goanalysis.NewLinter(a.Name, a.Doc, []*analysis.Analyzer{a}, nil).
+		WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/swaggo/swaggo.go

@@ -0,0 +1,19 @@
+package swaggo
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/v2/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}
+
+func TestFix(t *testing.T) {
+	integration.RunFix(t)
+}
+
+func TestFixPathPrefix(t *testing.T) {
+	integration.RunFixPathPrefix(t)
+}

pkg/golinters/swaggo/swaggo_integration_test.go

@@ -0,0 +1,18 @@
+//golangcitest:config_path testdata/swaggo.yml
+//golangcitest:expected_exitcode 0
+package api
+
+import "net/http"
+
+// @Summary Add a new pet to the store
+// @Description get string by ID
+// @ID get-string-by-int
+// @Accept  json
+// @Produce  json
+// @Param   some_id      path   int     true  "Some ID" Format(int64)
+// @Param   some_id      body web.Pet true  "Some ID"
+// @Success 200 {string} string	"ok"
+// @Failure 400 {object} web.APIError "We need ID!!"
+// @Failure 404 {object} web.APIError "Can not find ID"
+// @Router /testapi/get-string-by-int/{some_id} [get]
+func GetStringByInt(w http.ResponseWriter, r *http.Request) {}

pkg/golinters/swaggo/testdata/fix/in/swaggo.go

@@ -0,0 +1,18 @@
+//golangcitest:config_path testdata/swaggo.yml
+//golangcitest:expected_exitcode 0
+package api
+
+import "net/http"
+
+//	@Summary		Add a new pet to the store
+//	@Description	get string by ID
+//	@ID				get-string-by-int
+//	@Accept			json
+//	@Produce		json
+//	@Param			some_id	path		int				true	"Some ID"	Format(int64)
+//	@Param			some_id	body		web.Pet			true	"Some ID"
+//	@Success		200		{string}	string			"ok"
+//	@Failure		400		{object}	web.APIError	"We need ID!!"
+//	@Failure		404		{object}	web.APIError	"Can not find ID"
+//	@Router			/testapi/get-string-by-int/{some_id} [get]
+func GetStringByInt(w http.ResponseWriter, r *http.Request) {}