feat(.golangci.yaml): add godoclint linter (#3085)

Replace custom TestExportedSymbolsHaveDocs test with godoclint linter.

Author: julieqiu

.golangci.yaml

@@ -30,3 +30,20 @@ linters:
     - unparam
     - unused
     - usetesting
+  settings:
+    godoclint:
+      default: all
+      options:
+        max-len:
+          length: 120
+  exclusions:
+    rules:
+      - path: _test\.go$
+        linters:
+          - godoclint
+      - path: internal/sidekick/sample/
+        linters:
+          - godoclint
+      - path: internal/legacylibrarian/
+        linters:
+          - godoclint

all_test.go

@@ -17,9 +17,6 @@ package librarian
 import (
 	"bytes"
 	"errors"
-	"go/ast"
-	"go/parser"
-	"go/token"
 	"io"
 	"io/fs"
 	"os"
@@ -267,73 +264,3 @@ func rungo(t *testing.T, args ...string) {
 		t.Fatalf("%v: %v\n%s", cmd, err, output)
 	}
 }
-
-func TestExportedSymbolsHaveDocs(t *testing.T) {
-	packageHasComment := make(map[string]bool)
-	err := filepath.WalkDir(".", func(path string, d os.DirEntry, err error) error {
-		if err != nil || d.IsDir() || !strings.HasSuffix(path, ".go") ||
-			strings.HasSuffix(path, "_test.go") || strings.HasSuffix(path, ".pb.go") || strings.Contains(path, "testdata") {
-			return nil
-		}
-
-		fset := token.NewFileSet()
-		node, err := parser.ParseFile(fset, path, nil, parser.ParseComments)
-		if err != nil {
-			t.Errorf("failed to parse file %q: %v", path, err)
-			return nil
-		}
-
-		recordPackageCommentStatus(t, node, packageHasComment)
-
-		// Visit every top-level declaration in the file.
-		for _, decl := range node.Decls {
-			gen, ok := decl.(*ast.GenDecl)
-			if ok && (gen.Tok == token.TYPE || gen.Tok == token.VAR) {
-				for _, spec := range gen.Specs {
-					switch s := spec.(type) {
-					case *ast.TypeSpec:
-						checkDoc(t, s.Name, gen.Doc, path)
-					case *ast.ValueSpec:
-						for _, name := range s.Names {
-							checkDoc(t, name, gen.Doc, path)
-						}
-					}
-				}
-			}
-			if fn, ok := decl.(*ast.FuncDecl); ok {
-				checkDoc(t, fn.Name, fn.Doc, path)
-			}
-		}
-		return nil
-	})
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	for name, hasPkgComment := range packageHasComment {
-		if !hasPkgComment {
-			t.Errorf("package %s does not have package comment", name)
-		}
-	}
-}
-
-func checkDoc(t *testing.T, name *ast.Ident, doc *ast.CommentGroup, path string) {
-	t.Helper()
-	if !name.IsExported() {
-		return
-	}
-	if doc == nil {
-		t.Errorf("%s: %q is missing doc comment",
-			path, name.Name)
-	}
-}
-
-// recordPackageCommentStatus updates the seen map with the package comment status for a given package, processing each
-// package only once.
-func recordPackageCommentStatus(t *testing.T, file *ast.File, packageHasComment map[string]bool) {
-	t.Helper()
-	pkg := file.Name.String()
-	if !packageHasComment[pkg] {
-		packageHasComment[pkg] = file.Doc != nil
-	}
-}

cmd/sidekick/main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Command sidekick is a code generator for Google Cloud client libraries.
 package main
 
 import (

internal/config/config.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package config provides types and functions for reading and writing
+// librarian.yaml configuration files.
 package config
 
 import (

internal/language/generate.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package language provides library generation functionality for different
+// programming languages.
 package language
 
 import (

internal/sidekick/parser/httprule/http_rule_parser.go

@@ -299,7 +299,8 @@ const (
 	unreserved = alpha + digit + "-._~"
 )
 
-// parseLiteral validates that the provided string conforms to the LITERAL definition, and returns a Literal type if it does.
+// parseLiteral validates that the provided string conforms to the LITERAL
+// definition, and returns a Literal type if it does.
 func parseLiteral(literal string) (*Literal, int, error) {
 	var pos int
 	for pos < len(literal) {