chore(internal/protoveneer): add removeOtherDoc config (#9438)

Add a config option to remove all documentation from a symbol except for the first line.
googleapis · Feb 20, 2024 · 7421626 · 7421626
1 parent 07f4c9f
commit 7421626
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/internal/protoveneer/cmd/protoveneer/config.go b/internal/protoveneer/cmd/protoveneer/config.go
@@ -55,7 +55,10 @@ type typeConfig struct {
 	// Custom conversion functions: "tofunc, fromfunc"
 	ConvertToFrom string `yaml:"convertToFrom"`
 	// Doc string for the type, omitting the initial type name.
+	// This replaces the first line of the doc.
 	Doc string
+	// Remove all but the first line of the doc.
+	RemoveOtherDoc bool `yaml:"removeOtherDoc"`
 	// Verb to place after type name in doc. Default: "is".
 	// Ignored if Doc is non-empty.
 	DocVerb string `yaml:"docVerb"`

diff --git a/internal/protoveneer/cmd/protoveneer/protoveneer.go b/internal/protoveneer/cmd/protoveneer/protoveneer.go
@@ -541,7 +541,7 @@ func processEnumValues(d *ast.GenDecl, tc *typeConfig) []string {
 		if tc != nil {
 			vs.Type.(*ast.Ident).Name = tc.Name
 		}
-		modifyCommentGroup(vs.Doc, protoName, veneerName, "means", "")
+		modifyCommentGroup(vs.Doc, protoName, veneerName, "means", "", false)
 	}
 	return valueNames
 }
@@ -568,9 +568,11 @@ func veneerValueName(protoValueName string, tc *typeConfig) string {
 func processDoc(gd *ast.GenDecl, protoName string, tc *typeConfig) {
 	doc := ""
 	verb := ""
+	remOther := false
 	if tc != nil {
 		doc = tc.Doc
 		verb = tc.DocVerb
+		remOther = tc.RemoveOtherDoc
 	}
 
 	spec := gd.Specs[0]
@@ -586,10 +588,10 @@ func processDoc(gd *ast.GenDecl, protoName string, tc *typeConfig) {
 	if tc != nil && name != tc.Name {
 		panic(fmt.Errorf("GenDecl name is %q, config name is %q", name, tc.Name))
 	}
-	modifyCommentGroup(gd.Doc, protoName, name, verb, doc)
+	modifyCommentGroup(gd.Doc, protoName, name, verb, doc, remOther)
 }
 
-func modifyCommentGroup(cg *ast.CommentGroup, protoName, veneerName, verb, doc string) {
+func modifyCommentGroup(cg *ast.CommentGroup, protoName, veneerName, verb, doc string, removeOther bool) {
 	if cg == nil {
 		return
 	}
@@ -598,6 +600,9 @@ func modifyCommentGroup(cg *ast.CommentGroup, protoName, veneerName, verb, doc s
 	}
 	c := cg.List[0]
 	c.Text = "// " + adjustDoc(strings.TrimPrefix(c.Text, "// "), protoName, veneerName, verb, doc)
+	if removeOther {
+		cg.List = cg.List[:1]
+	}
 }
 
 // adjustDoc takes a doc string with initial comment characters and whitespace removed, and returns