Handle extended anonymous structs. (#13)

* Handle extended anonymous structs

* deal with linter

Author: davidnewhall

.github/workflows/codetests.yml

@@ -42,7 +42,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v8
         with:
-          version: v2.1
+          version: v2.4
   # Runs golangci-lint on linux against linux and windows.
   golangci-linux:
     strategy:
@@ -60,4 +60,4 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v8
         with:
-          version: v2.1
+          version: v2.4

.golangci.yml

@@ -1,10 +1,15 @@
-version: "2"
+version: '2'
 linters:
   default: all
   disable:
     - nlreturn
     - exhaustruct
+    - wsl
   settings:
+    wsl_v5:
+      allow-first-in-block: true
+      allow-whole-block: false
+      branch-max-lines: 2
     errcheck:
       disable-default-exclusions: true
       exclude-functions:

builder.go

@@ -68,6 +68,8 @@ type StructMember struct {
 	Type string
 	// Members is a list of members in this member if it's an anonymous struct.
 	Members []*StructMember
+	// Extends is a list of struct names that this member extends if it's a struct with anonymous members.
+	Extends []string
 	// Member is the struct field that we are building the typescript interface for.
 	Member reflect.StructField
 	// Optional is true if the member is optional.
@@ -304,6 +306,8 @@ func (g *Goty) checkStruct(field reflect.Type, member *StructMember) string {
 	structMember := g.parseStruct(field)
 	if structMember.Name == "" { // Embedded struct.
 		member.Members = append(member.Members, structMember.Members...)
+		member.Extends = append(member.Extends, structMember.Extends...)
+
 		return "" // embedded structs don't have names; deal with it.
 	}
 

entry.go

@@ -33,13 +33,14 @@ const (
 
 // Config is the input config for the builder.
 type Config struct {
+	// DocHandler is the handler for go/doc comments. Comments are off by default.
+	gotyface.Docs `json:"-" toml:"-" xml:"-" yaml:"-"`
+
 	// Overrides is a map of go types to their typescript type and name.
 	// These override the global overrides.
 	Overrides Overrides `json:"overrides" toml:"overrides" xml:"overrides" yaml:"overrides"`
 	// GlobalOverrides are applied to all structs unless a type-specific override exists.
 	GlobalOverrides Override `json:"globalOverrides" toml:"global_overrides" xml:"global-override" yaml:"globalOverrides"`
-	// DocHandler is the handler for go/doc comments. Comments are off by default.
-	gotyface.Docs `json:"-" toml:"-" xml:"-" yaml:"-"`
 }
 
 // Overrides is a map of go types to their typescript override values.

gotydoc/docs.go

@@ -53,7 +53,8 @@ func (d *Docs) AddPkg(src string, pkg string) error {
 // AddPkgMust adds a package to the handler's index like AddPkg but panics if there is an error.
 // See AddPkg for more details.
 func (d *Docs) AddPkgMust(src string, pkg string) *Docs {
-	if err := d.AddPkg(src, pkg); err != nil {
+	err := d.AddPkg(src, pkg)
+	if err != nil {
 		panic(err)
 	}
 
@@ -66,7 +67,8 @@ func (d *Docs) AddPkgMust(src string, pkg string) *Docs {
 // Running `go mod vendor` is a good way to create this folder.
 func (d *Docs) Add(vendorFolder string, pkg ...string) error {
 	for _, p := range pkg {
-		if err := d.AddPkg(filepath.Join(vendorFolder, p), p); err != nil {
+		err := d.AddPkg(filepath.Join(vendorFolder, p), p)
+		if err != nil {
 			return err
 		}
 	}

printer.go

@@ -27,7 +27,8 @@ func (g *Goty) Write(fileName string, overwrite bool) error {
 		return ErrNoStructs
 	}
 
-	if _, err := os.Stat(fileName); !os.IsNotExist(err) && !overwrite {
+	_, err := os.Stat(fileName)
+	if !os.IsNotExist(err) && !overwrite {
 		return fmt.Errorf("file exists: %s: %w", fileName, os.ErrExist)
 	}
 
@@ -85,16 +86,21 @@ func (m *StructMember) Print(indent string, output io.Writer) {
 
 	doc := formatDocs(true, indent, m.doc.Member(m.parent.Type, m.Member.Name), m.ovr.Comment)
 
+	extends := ""
+	if len(m.Extends) > 0 {
+		extends = strings.Join(m.Extends, ` & `) + ` & `
+	}
+
 	if m.Members == nil {
-		fmt.Fprintln(output, doc+indent+m.Name+optional+`: `+m.Type+`;`)
+		fmt.Fprintln(output, doc+indent+m.Name+optional+`: `+extends+m.Type+`;`)
 		return
 	}
 
 	if optional = ""; m.Optional {
 		optional = "null | "
 	}
 
-	fmt.Fprintln(output, indent+m.Name+`: `+optional+`{`)
+	fmt.Fprintln(output, indent+m.Name+`: `+optional+extends+`{`)
 
 	for _, m := range m.Members {
 		m.Print(indent+`  `, output)

printer_test.go

@@ -7,13 +7,24 @@ import (
 )
 
 type TestWrapper struct {
+	TestEndpoint
+
 	Profile TestLevel1
 	Level1  TestLevel1
-	TestEndpoint
-	EP   *TestEndpoint
-	Auth struct {
+	EP      *TestEndpoint
+	Auth    struct {
+		*TestEndpoint
+		TestLevel1
+
 		Username string `json:"username"`
 		Password string `json:"password"`
+		Decoy    struct {
+			TestEndpoint
+			*TestLevel1
+
+			Apple  string
+			Banana string
+		}
 	}
 	Config *goty.Config
 }
@@ -68,22 +79,18 @@ func ExampleGoty_Print() {
 	//   Profile: TestLevel1;
 	//   Level1: TestLevel1;
 	//   EP?: TestEndpoint;
-	//   Auth: {
+	//   Auth: TestEndpoint & TestLevel1 & {
 	//     username: string;
 	//     password: string;
+	//     Decoy: TestEndpoint & TestLevel1 & {
+	//       Apple: string;
+	//       Banana: string;
+	//     };
 	//   };
 	//   Config?: Config;
 	// };
 	//
 	// /**
-	//  * @see golang: <golift.io/goty_test.TestLevel1>
-	//  */
-	// export interface TestLevel1 {
-	//   name: string;
-	//   date: Date;
-	// };
-	//
-	// /**
 	//  * @see golang: <golift.io/goty_test.TestEndpoint>
 	//  */
 	// export interface TestEndpoint {
@@ -92,6 +99,14 @@ func ExampleGoty_Print() {
 	// };
 	//
 	// /**
+	//  * @see golang: <golift.io/goty_test.TestLevel1>
+	//  */
+	// export interface TestLevel1 {
+	//   name: string;
+	//   date: Date;
+	// };
+	//
+	// /**
 	//  * @see golang: <golift.io/goty.Config>
 	//  */
 	// export interface Config {