xmlencoderclose: linter that checks xml.Encoder is closed

Author: adamdecaf

.golangci.reference.yml

@@ -2183,6 +2183,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - xmlencoderclose
     - zerologlint
 
   # Enable all available linters.
@@ -2297,6 +2298,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - xmlencoderclose
     - zerologlint
 
   # Enable presets.

go.mod

@@ -127,6 +127,7 @@ require (
 
 require (
 	github.com/Masterminds/semver v1.5.0 // indirect
+	github.com/adamdecaf/xmlencoderclose v0.0.0 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.1.2 // indirect
 	github.com/chavacava/garif v0.0.0-20230227094218-b8c73b2037b8 // indirect
@@ -147,6 +148,7 @@ require (
 	github.com/google/go-cmp v0.5.9 // indirect
 	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
 	github.com/gostaticanalysis/comment v1.4.2 // indirect
+	github.com/gostaticanalysis/sqlrows v0.0.0-20200307153552-ea5697937269 // indirect
 	github.com/hashicorp/errwrap v1.0.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect

go.sum

@@ -0,0 +1,19 @@
+package golinters
+
+import (
+	"github.com/adamdecaf/xmlencoderclose/pkg/analyzer"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewXMLEncoderClose() *goanalysis.Linter {
+	return goanalysis.NewLinter(
+		"xmlencoderclose",
+		"Checks that xml.Encoder is closed",
+		[]*analysis.Analyzer{
+			analyzer.NewAnalyzer(),
+		},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/golinters/xmlencoderclose.go

@@ -900,6 +900,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetStyle).
 			WithURL("https://github.com/bombsimon/wsl"),
 
+		linter.NewConfig(golinters.NewXMLEncoderClose()).
+			WithSince("v1.54.0").
+			WithPresets(linter.PresetBugs).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/adamdecaf/xmlencoderclose"),
+
 		// nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives
 		linter.NewConfig(golinters.NewNoLintLint(noLintLintCfg)).
 			WithSince("v1.26.0").

pkg/lint/lintersdb/manager.go

@@ -0,0 +1,22 @@
+//golangcitest:args -Exmlencoderclose
+package testdata
+
+import (
+	"bytes"
+	"encoding/xml"
+)
+
+func xmlEncoderClose() (string, error) {
+	type document struct {
+		A string `xml:"a"`
+	}
+
+	var buf bytes.Buffer
+	err := xml.NewEncoder(&buf).Encode(document{ // want "Encoder.Close must be called"
+		A: "abc123",
+	})
+	if err != nil {
+		return "", err
+	}
+	return buf.String(), nil
+}