build(deps): bump github.com/godoc-lint/godoc-lint from 0.10.2 to 0.11.1 (#6282)

Co-authored-by: Fernandez Ludovic <[email protected]>

Author: babakks

.golangci.next.reference.yml

@@ -1320,6 +1320,9 @@ linters:
         # Assert no unused link in godocs.
         # https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#no-unused-link
         - no-unused-link
+        # Require proper doc links to standard library declarations where applicable.
+        # https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#require-stdlib-doclink
+        - require-stdlib-doclink
 
       # List of rules to disable.
       # Default: empty
@@ -1332,12 +1335,13 @@ linters:
         - deprecated
         - max-len
         - no-unused-link
+        - require-stdlib-doclink
 
       # A map for fine-tuning individual rules.
       # All subkeys are optional.
       options:
         max-len:
-          # Maximum line length for godocs, not including the `// `, or `/*` or `*/` tokens.
+          # Maximum line length for godocs, not including the `//`, `/*` or `*/` tokens.
           # Default: 77
           length: 127
 

go.mod

@@ -48,7 +48,7 @@ require (
 	github.com/go-critic/go-critic v0.14.2
 	github.com/go-viper/mapstructure/v2 v2.4.0
 	github.com/go-xmlfmt/xmlfmt v1.1.3
-	github.com/godoc-lint/godoc-lint v0.10.2
+	github.com/godoc-lint/godoc-lint v0.11.1
 	github.com/gofrs/flock v0.13.0
 	github.com/golangci/asciicheck v0.5.0
 	github.com/golangci/dupl v0.0.0-20250308024227-f665c8d69b32

go.sum

@@ -487,7 +487,8 @@
         "require-doc",
         "deprecated",
         "max-len",
-        "no-unused-link"
+        "no-unused-link",
+        "require-stdlib-doclink"
       ]
     },
     "gosec-rules": {
@@ -1937,7 +1938,7 @@
                   "properties": {
                     "length": {
                       "type": "integer",
-                      "description": "Maximum line length for godocs, not including the `// `, or `/*` or `*/` tokens.",
+                      "description": "Maximum line length for godocs, not including the `//`, `/*` or `*/` tokens.",
                       "default": 77
                     }
                   }

jsonschema/golangci.next.jsonschema.json

@@ -35,25 +35,35 @@ func New(settings *config.GodoclintSettings) *goanalysis.Linter {
 		// - Options.RequireDocIncludeTests
 		// - Options.StartWithNameIncludeTests
 		// - Options.NoUnusedLinkIncludeTests
+		// - Options.RequireStdlibDoclinkIncludeTests
+
+		// Also, Options.MaxLenIgnorePatterns is ignored because the Golangci-lint's idiomatic way to ignore such issues
+		// is exclusion by source text patterns.
 
 		pcfg = glconfig.PlainConfig{
 			Default: settings.Default,
 			Enable:  settings.Enable,
 			Disable: settings.Disable,
 			Options: &glconfig.PlainRuleOptions{
-				MaxLenLength:                   settings.Options.MaxLen.Length,
-				MaxLenIncludeTests:             pointer(true),
-				PkgDocIncludeTests:             pointer(false),
-				SinglePkgDocIncludeTests:       pointer(true),
-				RequirePkgDocIncludeTests:      pointer(false),
-				RequireDocIncludeTests:         pointer(true),
-				RequireDocIgnoreExported:       settings.Options.RequireDoc.IgnoreExported,
-				RequireDocIgnoreUnexported:     settings.Options.RequireDoc.IgnoreUnexported,
-				StartWithNameIncludeTests:      pointer(false),
-				StartWithNameIncludeUnexported: settings.Options.StartWithName.IncludeUnexported,
-				NoUnusedLinkIncludeTests:       pointer(true),
+				MaxLenLength:                     settings.Options.MaxLen.Length,
+				MaxLenIncludeTests:               pointer(true),
+				MaxLenIgnorePatterns:             []string{`^\+kubebuilder:`},
+				PkgDocIncludeTests:               pointer(false),
+				SinglePkgDocIncludeTests:         pointer(true),
+				RequirePkgDocIncludeTests:        pointer(false),
+				RequireDocIncludeTests:           pointer(true),
+				RequireDocIgnoreExported:         settings.Options.RequireDoc.IgnoreExported,
+				RequireDocIgnoreUnexported:       settings.Options.RequireDoc.IgnoreUnexported,
+				StartWithNameIncludeTests:        pointer(false),
+				StartWithNameIncludeUnexported:   settings.Options.StartWithName.IncludeUnexported,
+				RequireStdlibDoclinkIncludeTests: pointer(true),
+				NoUnusedLinkIncludeTests:         pointer(true),
 			},
 		}
+
+		if err := pcfg.Validate(); err != nil {
+			internal.LinterLogger.Fatalf("godoclint: %v", err)
+		}
 	}
 
 	composition := glcompose.Compose(glcompose.CompositionConfig{

pkg/golinters/godoclint/godoclint.go

@@ -12,6 +12,7 @@ linters:
         - deprecated
         - max-len
         - no-unused-link
+        - require-stdlib-doclink
       options:
         start-with-name:
           include-unexported: true

pkg/golinters/godoclint/testdata/godoclint.yml

@@ -56,3 +56,7 @@ const DeprecatedConstB = 1
 //
 // DEPRECATED: invalid deprecation note but okay since the symbol is not exported
 const deprecatedConstC = 1
+
+// constWithStdlibDoclink has a potential doc link to encoding/json.Encoder but
+// should be ignored since the rule is not enabled by default.
+const constWithStdlibDoclink = 1

pkg/golinters/godoclint/testdata/godoclint_default_pass.go

@@ -105,3 +105,8 @@ const DeprecatedConstB = 1
 //
 // deprecated:do not use
 const DeprecatedConstC = 1
+
+// constWithStdlibDoclink has a potential doc link to encoding/json.Encoder. // want `text "encoding/json\.Encoder" should be replaced with "\[encoding/json\.Encoder\]" to link to stdlib type`
+//
+//godoclint:disable max-len
+const constWithStdlibDoclink = 1

pkg/golinters/godoclint/testdata/godoclint_full_fail.go

@@ -73,3 +73,6 @@ const DeprecatedConstB = 1
 //
 // DEPRECATED: invalid deprecation note but okay since the symbol is not exported
 const deprecatedConstC = 1
+
+// constWithStdlibDoclink has a doc link to [encoding/json.Encoder].
+const constWithStdlibDoclink = 1

pkg/golinters/godoclint/testdata/godoclint_full_pass.go

@@ -68,3 +68,6 @@ const DeprecatedConstA = 1
 
 // Deprecated: do not use
 const DeprecatedConstB = 1
+
+// constWithStdlibDoclink has a doc link to [encoding/json.Encoder].
+const constWithStdlibDoclink = 1