Clean typescript generation (#125)

* Move typescrip gen into its own package

* Refactor union generation [ts]

* Refactor string generation [ts]

* Refactor object generation [ts]

* Refactor number generation [ts]

* Refactor enum generation [ts]

* Refactor boolean generation [ts]

* Refactor array generation [ts]

* Use raw value for interface key [ts]

* Refactor main generation [ts]

* Add ordered map struct [utils]

* Add keys method [utils]

* Use new ordered map stuff

* Apply Claude's suggestions (#126)

* Fix up ai stuff

* Clean up comment and line indentation

---------

Co-authored-by: Christian Nunciato <[email protected]>

Author: zchase

internal/gen/go.go

@@ -3,7 +3,6 @@ package main
 import (
 	"fmt"
 
-	"github.com/buildkite/buildkite-sdk/internal/gen/schema"
 	"github.com/buildkite/buildkite-sdk/internal/gen/types"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 )
@@ -13,8 +12,10 @@ func generateGoTypes(
 	outDir string,
 ) error {
 	for _, name := range generator.Definitions.Keys() {
-		val, _ := generator.Definitions.Get(name)
-		prop := val.(schema.PropertyDefinition)
+		prop, err := generator.Definitions.Get(name)
+		if err != nil {
+			return err
+		}
 
 		property, _, err := generator.PropertyDefinitionToValue(name, prop)
 		if err != nil {

internal/gen/main.go

@@ -4,11 +4,9 @@ import (
 	"fmt"
 	"os"
 	"path"
-	"sort"
 
 	"github.com/buildkite/buildkite-sdk/internal/gen/schema"
 	"github.com/buildkite/buildkite-sdk/internal/gen/types"
-	"github.com/iancoleman/orderedmap"
 )
 
 func generateTypes(outDir, language string) error {
@@ -17,32 +15,13 @@ func generateTypes(outDir, language string) error {
 		return fmt.Errorf("reading pipeline schema: %v", err)
 	}
 
-	definitions := orderedmap.New()
-	for key, prop := range pipelineSchema.Definitions {
-		definitions.Set(key, prop)
-	}
-	definitions.SortKeys(sort.Strings)
-
-	properties := orderedmap.New()
-	for key, prop := range pipelineSchema.Properties {
-		properties.Set(key, prop)
-	}
-	properties.SortKeys(sort.Strings)
-
-	generator := types.PipelineSchemaGenerator{
-		Definitions: definitions,
-		Properties:  properties,
-	}
-
-	if language == "ts" {
+	generator := types.NewPipelineSchemaGenerator(pipelineSchema)
+	switch language {
+	case "ts":
 		return generateTypeScriptTypes(generator, outDir)
-	}
-
-	if language == "py" {
+	case "py":
 		return generatePythonTypes(generator, outDir)
-	}
-
-	if language == "go" {
+	case "go":
 		return generateGoTypes(generator, outDir)
 	}
 

internal/gen/python.go

@@ -5,7 +5,6 @@ import (
 	"path"
 	"strings"
 
-	"github.com/buildkite/buildkite-sdk/internal/gen/schema"
 	"github.com/buildkite/buildkite-sdk/internal/gen/types"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 	"github.com/iancoleman/orderedmap"
@@ -85,8 +84,10 @@ func generatePythonTypes(
 	}
 
 	for _, name := range typeNames {
-		val, _ := generator.Definitions.Get(name)
-		prop := val.(schema.PropertyDefinition)
+		prop, err := generator.Definitions.Get(name)
+		if err != nil {
+			return err
+		}
 
 		property, dependencies, err := generator.PropertyDefinitionToValue(name, prop)
 		if err != nil {

internal/gen/types/array.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/buildkite/buildkite-sdk/internal/gen/typescript"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 )
 
@@ -22,7 +23,7 @@ func (a Array) IsReference() bool {
 	return a.Reference
 }
 
-func (Array) IsPrimative() bool {
+func (Array) IsPrimitive() bool {
 	return false
 }
 
@@ -101,23 +102,18 @@ func (a Array) Go() (string, error) {
 }
 
 // TypeScript
-func (a Array) TypeScript() (string, error) {
-	block := utils.NewCodeBlock()
-
-	if a.Description != "" {
-		block.AddLines(utils.NewTypeDocComment(a.Description))
+func (a Array) TypeScript() string {
+	arrayType := a.Type.TypeScriptInterfaceType()
+	if _, ok := a.Type.(Union); ok {
+		arrayType = fmt.Sprintf("(%s)", arrayType)
 	}
 
-	if union, ok := a.Type.(Union); ok {
-		block.AddLines(
-			fmt.Sprintf("export type %s = (%s)[]", a.Name.ToTitleCase(), union.TypeScriptInterfaceType()),
-		)
-
-		return block.String(), nil
-	}
-
-	block.AddLines(fmt.Sprintf("export type %s = %s[]", a.Name.ToTitleCase(), a.Type.TypeScriptInterfaceType()))
-	return block.String(), nil
+	typ := typescript.NewType(
+		a.Name.ToTitleCase(),
+		a.Description,
+		fmt.Sprintf("%s[]", arrayType),
+	)
+	return typ.String()
 }
 
 func (a Array) TypeScriptInterfaceType() string {
@@ -138,7 +134,7 @@ func (a Array) TypeScriptInterfaceType() string {
 }
 
 func (a Array) TypeScriptInterfaceKey() string {
-	return a.Name.ToTitleCase()
+	return a.Name.Value
 }
 
 // Python

internal/gen/types/boolean.go

@@ -3,6 +3,7 @@ package types
 import (
 	"fmt"
 
+	"github.com/buildkite/buildkite-sdk/internal/gen/typescript"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 )
 
@@ -19,7 +20,7 @@ func (b Boolean) IsReference() bool {
 	return false
 }
 
-func (Boolean) IsPrimative() bool {
+func (Boolean) IsPrimitive() bool {
 	return true
 }
 
@@ -47,16 +48,13 @@ func (b Boolean) Go() (string, error) {
 }
 
 // TypeScript
-
-func (b Boolean) TypeScript() (string, error) {
-	block := utils.NewCodeBlock()
-
-	if b.Description != "" {
-		block.AddLines(utils.NewTypeDocComment(b.Description))
-	}
-
-	block.AddLines(fmt.Sprintf("type %s = boolean", b.Name.ToTitleCase()))
-	return block.String(), nil
+func (b Boolean) TypeScript() string {
+	typ := typescript.NewType(
+		b.Name.ToTitleCase(),
+		b.Description,
+		"boolean",
+	)
+	return typ.String()
 }
 
 func (b Boolean) TypeScriptInterfaceKey() string {

internal/gen/types/enum.go

@@ -5,6 +5,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/buildkite/buildkite-sdk/internal/gen/typescript"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 	"github.com/iancoleman/orderedmap"
 )
@@ -56,7 +57,7 @@ func (e Enum) IsReference() bool {
 	return false
 }
 
-func (Enum) IsPrimative() bool {
+func (Enum) IsPrimitive() bool {
 	return false
 }
 
@@ -147,25 +148,14 @@ func (e Enum) Go() (string, error) {
 }
 
 // TypeScript
-func (e Enum) TypeScript() (string, error) {
-	parts := make([]string, len(e.Values))
-	for i, val := range e.Values {
-		if _, ok := val.(string); ok {
-			parts[i] = fmt.Sprintf("'%v'", val)
-			continue
-		}
-
-		parts[i] = fmt.Sprintf("%v", val)
-	}
-	values := strings.Join(parts, " | ")
-
-	block := utils.NewCodeBlock()
-	if e.Description != "" {
-		block.AddLines(utils.NewTypeDocComment(e.Description))
-	}
+func (e Enum) TypeScript() string {
+	typ := typescript.NewType(
+		e.Name.ToTitleCase(),
+		e.Description,
+		e.TypeScriptInterfaceType(),
+	)
 
-	block.AddLines(fmt.Sprintf("export type %s = %s", e.Name.ToTitleCase(), values))
-	return block.String(), nil
+	return typ.String()
 }
 
 func (e Enum) TypeScriptInterfaceKey() string {

internal/gen/types/number.go

@@ -3,6 +3,7 @@ package types
 import (
 	"fmt"
 
+	"github.com/buildkite/buildkite-sdk/internal/gen/typescript"
 	"github.com/buildkite/buildkite-sdk/internal/gen/utils"
 )
 
@@ -19,7 +20,7 @@ func (Number) IsReference() bool {
 	return false
 }
 
-func (Number) IsPrimative() bool {
+func (Number) IsPrimitive() bool {
 	return true
 }
 
@@ -47,14 +48,13 @@ func (n Number) GoStructKey(isUnion bool) string {
 }
 
 // TypeScript
-func (n Number) TypeScript() (string, error) {
-	block := utils.NewCodeBlock()
-	if n.Description != "" {
-		block.AddLines(utils.NewTypeDocComment(n.Description))
-	}
-
-	block.AddLines(fmt.Sprintf("type %s = number", n.Name.ToTitleCase()))
-	return block.String(), nil
+func (n Number) TypeScript() string {
+	typ := typescript.NewType(
+		n.Name.ToTitleCase(),
+		n.Description,
+		"number",
+	)
+	return typ.String()
 }
 
 func (n Number) TypeScriptInterfaceKey() string {