chore: update all tests with preserved comments

Author: Emyrk

bindings/comments.go

@@ -2,15 +2,13 @@ package bindings
 
 import (
 	"fmt"
-	"go/ast"
 	"go/token"
-	"strings"
 )
 
 // Commentable indicates if the AST node supports adding comments.
 // Any number of comments are supported and can be attached to a typescript AST node.
 type Commentable interface {
-	Comment(comment SyntheticComment)
+	AppendComment(comment SyntheticComment)
 	Comments() []SyntheticComment
 }
 
@@ -27,33 +25,9 @@ type SupportComments struct {
 	comments []SyntheticComment
 }
 
-func (s *SupportComments) ASTCommentGroup(grp *ast.CommentGroup) {
-	if grp == nil {
-		return
-	}
-	for _, cmt := range grp.List {
-		s.ASTComment(cmt)
-	}
-}
-
-func (s *SupportComments) ASTComment(cmt *ast.Comment) {
-	// TODO: Is there a better way to get just the text of the comment?
-	text := cmt.Text
-	text = strings.TrimPrefix(text, "//")
-	text = strings.TrimPrefix(text, "/*")
-	text = strings.TrimSuffix(text, "*/")
-
-	s.Comment(SyntheticComment{
-		Leading:         true,
-		SingleLine:      !strings.Contains(cmt.Text, "\n"),
-		Text:            text,
-		TrailingNewLine: true,
-	})
-}
-
 // LeadingComment is a helper function for the most common type of comment.
 func (s *SupportComments) LeadingComment(text string) {
-	s.Comment(SyntheticComment{
+	s.AppendComment(SyntheticComment{
 		Leading:    true,
 		SingleLine: true,
 		// All go comments are `// ` prefixed, so add a space.
@@ -62,7 +36,11 @@ func (s *SupportComments) LeadingComment(text string) {
 	})
 }
 
-func (s *SupportComments) Comment(comment SyntheticComment) {
+func (s *SupportComments) AppendComments(comments []SyntheticComment) {
+	s.comments = append(s.comments, comments...)
+}
+
+func (s *SupportComments) AppendComment(comment SyntheticComment) {
 	s.comments = append(s.comments, comment)
 }
 

comments.go

@@ -35,7 +35,7 @@ func CommentForObject(obj types.Object, pkg *packages.Package) []bindings.Synthe
 			continue
 		}
 
-		var found []*ast.CommentGroup
+		var found []bindings.SyntheticComment
 		ast.Inspect(f, func(n ast.Node) bool {
 			// The decl nodes "cover" the types they comment on. So we can check quickly if
 			// the node is relevant.
@@ -47,7 +47,7 @@ func CommentForObject(obj types.Object, pkg *packages.Package) []bindings.Synthe
 			case *ast.FuncDecl:
 				// Match function/method name token exactly.
 				if nd.Name != nil && nd.Name.Pos() == pos {
-					found = nd.Doc
+					found = syntheticComments(true, nd.Doc)
 					return false
 				}
 
@@ -63,9 +63,9 @@ func CommentForObject(obj types.Object, pkg *packages.Package) []bindings.Synthe
 						for _, name := range spec.Names {
 							if name.Pos() == pos {
 								if spec.Doc != nil {
-									found = spec.Doc
+									found = syntheticComments(true, nd.Doc)
 								} else {
-									found = nd.Doc
+									found = syntheticComments(true, spec.Doc)
 								}
 								return false
 							}
@@ -76,9 +76,9 @@ func CommentForObject(obj types.Object, pkg *packages.Package) []bindings.Synthe
 						if spec.Name != nil && spec.Name.Pos() == pos {
 							// comment on the type itself
 							if spec.Doc != nil {
-								found = spec.Doc
+								found = syntheticComments(true, spec.Doc)
 							} else {
-								found = nd.Doc
+								found = syntheticComments(true, nd.Doc)
 							}
 							return false
 						}
@@ -107,10 +107,7 @@ func CommentForObject(obj types.Object, pkg *packages.Package) []bindings.Synthe
 			return true
 		})
 
-		if len(found) > 0 {
-			return found[0]
-		}
-		return nil
+		return found
 	}
 
 	return nil
@@ -130,15 +127,15 @@ func commentForFieldList(fl *ast.FieldList, pos token.Pos) []bindings.SyntheticC
 			for _, nm := range fld.Names {
 				if nm.Pos() == pos {
 					cmts = append(cmts, syntheticComments(true, fld.Doc)...)
-					cmts = append(cmts, syntheticComments(true, fld.Doc)...)
+					cmts = append(cmts, syntheticComments(false, fld.Comment)...)
 					return cmts
 				}
 			}
 		} else {
 			// Embedded field (anonymous): no Names; match on the Type span.
 			if covers(fld.Type, pos) {
 				cmts = append(cmts, syntheticComments(true, fld.Doc)...)
-				cmts = append(cmts, syntheticComments(true, fld.Doc)...)
+				cmts = append(cmts, syntheticComments(false, fld.Comment)...)
 				return cmts
 			}
 		}
@@ -152,6 +149,9 @@ func covers(n ast.Node, p token.Pos) bool {
 
 func syntheticComments(leading bool, grp *ast.CommentGroup) []bindings.SyntheticComment {
 	cmts := []bindings.SyntheticComment{}
+	if grp == nil {
+		return cmts
+	}
 	for _, c := range grp.List {
 		cmts = append(cmts, bindings.SyntheticComment{
 			Leading:         leading,

convert.go

@@ -449,7 +449,7 @@ func (ts *Typescript) parse(obj types.Object) error {
 
 			if ts.preserveComments {
 				cmts := ts.parsed.CommentForObject(obj)
-				node.ASTCommentGroup(cmts)
+				node.AppendComments(cmts)
 			}
 			return ts.setNode(objectIdentifier.Ref(), typescriptNode{
 				Node: node,
@@ -807,7 +807,7 @@ func (ts *Typescript) buildStruct(obj types.Object, st *types.Struct) (*bindings
 
 		if ts.preserveComments {
 			cmts := ts.parsed.CommentForObject(field)
-			tsField.ASTCommentGroup(cmts)
+			tsField.AppendComments(cmts)
 		}
 		tsi.Fields = append(tsi.Fields, tsField)
 	}

testdata/comments/comments.ts

@@ -13,13 +13,12 @@ export interface BlockComment {
 // It actually has 2 comments?!
 // TODO: Maybe add a third comment!
 export interface CommentedStructure {
-    // Field comment
-    readonly Inline: string;
+    readonly Inline: string; // Field comment
     // Leading comment
     readonly Leading: string;
     readonly Trailing: string;
     // Leading comment
-    readonly All: string;
+    readonly All: string; // Inline comment
     //  Another leading comment 
     readonly Block: string;
 }

testdata/generics/generics.ts

@@ -25,6 +25,7 @@ export interface Complex<C extends Comparable, S extends Single, T extends Custo
 export type Custom = string | boolean | number | number | string[] | (number | null);
 
 // From codersdk/generics.go
+// Dynamic has some dynamic fields.
 export interface Dynamic<A extends any, S extends Single> {
     readonly dynamic: Fields<boolean, A, string, S>;
     readonly comparable: boolean | null;
@@ -48,6 +49,7 @@ export interface FieldsDiffOrder<A extends any, C extends Comparable, S extends
 export type Single = string;
 
 // From codersdk/generics.go
+// Static has all generic fields defined in the field
 export interface Static {
     readonly static: Fields<string, number, number, string>;
 }

testdata/inheritance/inheritance.ts

@@ -21,8 +21,10 @@ export interface FooBarPtr extends Bar, GenBar<string> {
 }
 
 // From codersdk/inheritance.go
+// FooBuzz has a json tag for the embedded
+// See: https://go.dev/play/p/-p6QYmY8mtR
 export interface FooBuzz {
-    readonly foo: Buzz;
+    readonly foo: Buzz; // Json tag changes the inheritance
     readonly bazz: string;
 }
 

testdata/nonids/nonids.ts

@@ -2,6 +2,7 @@
 
 // From nonids/nonids.go
 export interface Foo {
+    // Hyphen is an odd case, but this field is not ignored
     readonly "-": string;
     readonly "hyphenated-string": string;
     readonly "1numbered": number;

testdata/union/union.ts

@@ -1,6 +1,7 @@
 // Code generated by 'guts'. DO NOT EDIT.
 
 // From union/union.go
+// Repeated constraints are redundant
 export interface Repeated<T extends string | number> {
     readonly Value: T;
 }