feat: add GoParser.ExcludeCustom method (#39)

Author: toqueteos

convert.go

@@ -28,6 +28,7 @@ type GoParser struct {
 	Pkgs      map[string]*packages.Package
 	Reference map[string]bool
 	Prefix    map[string]string
+	Skips     map[string]struct{}
 
 	// referencedTypes is a map of all types that are referenced by the generated
 	// packages. This is to generated referenced types on demand.
@@ -66,9 +67,10 @@ func NewGolangParser() (*GoParser, error) {
 		fileSet:         fileSet,
 		config:          config,
 		Pkgs:            make(map[string]*packages.Package),
-		Reference:       map[string]bool{},
+		Reference:       make(map[string]bool),
 		referencedTypes: newReferencedTypes(),
-		Prefix:          map[string]string{},
+		Prefix:          make(map[string]string),
+		Skips:           make(map[string]struct{}),
 		typeOverrides: map[string]TypeOverride{
 			// Some hard coded defaults
 			"error": func() bindings.ExpressionType {
@@ -116,6 +118,14 @@ func (p *GoParser) IncludeCustom(mappings map[GolangType]GolangType) error {
 	return nil
 }
 
+// ExcludeCustom flags golang types to not be generated in the Typescript output.
+func (p *GoParser) ExcludeCustom(fqnames ...string) error {
+	for _, fqname := range fqnames {
+		p.Skips[fqname] = struct{}{}
+	}
+	return nil
+}
+
 // IncludeGenerate parses a directory and adds the parsed package to the list of packages.
 // These package's types will be generated.
 func (p *GoParser) IncludeGenerate(directory string) error {
@@ -166,6 +176,7 @@ func (p *GoParser) ToTypescript() (*Typescript, error) {
 	typescript := &Typescript{
 		typescriptNodes: make(map[string]*typescriptNode),
 		parsed:          p,
+		skip:            p.Skips,
 	}
 
 	// Parse all go types to the typescript AST
@@ -200,6 +211,7 @@ type Typescript struct {
 	// TODO: the key "string" should be replaced with "Identifier"
 	typescriptNodes map[string]*typescriptNode
 	parsed          *GoParser
+	skip            map[string]struct{}
 	// Do not allow calling serialize more than once.
 	// The call affects the state.
 	serialized bool
@@ -251,6 +263,11 @@ func (ts *Typescript) parseGolangIdentifiers() error {
 				continue
 			}
 
+			// Skip by qualified name
+			if _, ok := ts.skip[obj.Type().String()]; ok {
+				continue
+			}
+
 			if ts.parsed.Reference[pkg.PkgPath] {
 				if !ts.parsed.referencedTypes.IsReferenced(obj) {
 					continue

convert_test.go

@@ -84,6 +84,9 @@ func TestGeneration(t *testing.T) {
 			case "testdata/anyreference":
 				err = gen.IncludeReference("github.com/coder/guts/testdata/prefix", "Prefix")
 				require.NoErrorf(t, err, "include %q", dir)
+			case "testdata/excludecustom":
+				err = gen.ExcludeCustom("github.com/coder/guts/testdata/excludecustom.Secret")
+				require.NoErrorf(t, err, "exclude %q", dir)
 			}
 
 			gen.IncludeCustomDeclaration(config.StandardMappings())

example/simple/main.go

@@ -16,6 +16,10 @@ type SimpleType[T comparable] struct {
 	FieldTime       time.Time
 }
 
+type SecondaryType struct {
+	FieldString string
+}
+
 func main() {
 	golang, _ := guts.NewGolangParser()
 	// Generate the typescript types for this package
@@ -24,6 +28,8 @@ func main() {
 	_ = golang.IncludeCustom(map[string]string{
 		"time.Time": "string",
 	})
+	// Exclude SecondaryType from output
+	_ = golang.ExcludeCustom("github.com/coder/guts/example/simple.SecondaryType")
 
 	// Convert the golang types to typescript AST
 	ts, _ := golang.ToTypescript()

testdata/excludecustom/excludecustom.go

@@ -0,0 +1,10 @@
+package excludecustom
+
+type Secret struct {
+	SecretString string
+}
+
+type Public struct {
+	PublicString string
+	PublicInt    int
+}

testdata/excludecustom/excludecustom.ts

@@ -0,0 +1,7 @@
+// Code generated by 'guts'. DO NOT EDIT.
+
+// From excludecustom/excludecustom.go
+export interface Public {
+    readonly PublicString: string;
+    readonly PublicInt: number;
+}