Do not expose “Code generated by” block in package comments

uber-go · Mar 26, 2024 · de80859 · de80859
1 parent c9ae04c
commit de80859
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 4 deletions.
diff --git a/mockgen/internal/tests/package_comment/input.go b/mockgen/internal/tests/package_comment/input.go
@@ -0,0 +1,5 @@
+package empty_interface
+
+//go:generate mockgen -package empty_interface -destination mock.go -source input.go -write_package_comment=false
+
+type Empty interface{}
diff --git a/mockgen/internal/tests/package_comment/mock.go b/mockgen/internal/tests/package_comment/mock.go
diff --git a/mockgen/mockgen.go b/mockgen/mockgen.go
@@ -395,11 +395,13 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac
 		localNames[pkgName] = true
 	}
 
-	if *writePkgComment {
-		// Ensure there's an empty line before the package to follow the recommendations:
-		// https://github.com/golang/go/wiki/CodeReviewComments#package-comments
-		g.p("")
+	// Ensure there is an empty line between “generated by” block and
+	// package documentation comments to follow the recommendations:
+	// https://go.dev/wiki/CodeReviewComments#package-comments
+	// That is, “generated by” should not be a package comment.
+	g.p("")
 
+	if *writePkgComment {
 		g.p("// Package %v is a generated GoMock package.", outputPkgName)
 	}
 	g.p("package %v", outputPkgName)