rename to guts

Emyrk · Emyrk · commit 4e32b3201b6b · 2024-11-27T07:18:35.000-06:00
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# GoTs
+# Go Unto Ts (guts)
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/coder/gots.svg)](https://pkg.go.dev/github.com/coder/gots)
+[![Go Reference](https://pkg.go.dev/badge/github.com/coder/guts.svg)](https://pkg.go.dev/github.com/coder/guts)
 
-`GoTS` is a tool to convert golang types to typescript for enabling a consistent type definition across the frontend and backend. It is intended to be called and customized as a library, rather than as a command line tool.
+`guts` is a tool to convert golang types to typescript for enabling a consistent type definition across the frontend and backend. It is intended to be called and customized as a library, rather than as a command line tool.
 
 See the [simple example](./example/simple) for a basic usage of the library.
 ```go
@@ -30,7 +30,7 @@ interface SimpleType<T extends Comparable> {
 
 # How it works
 
-`GoTs` first parses a set of golang packages. The Go AST is traversed to find all the types defined in the packages. 
+`guts` first parses a set of golang packages. The Go AST is traversed to find all the types defined in the packages. 
 
 These types are placed into a simple AST that directly maps to the typescript AST.
 
diff --git a/bindings/vm.go b/bindings/vm.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/dop251/goja"
 
-	typescriptengine "github.com/coder/gots/typescript-engine"
+	typescriptengine "github.com/coder/guts/typescript-engine"
 )
 
 type Bindings struct {
@@ -25,7 +25,7 @@ func New() (*Bindings, error) {
 }
 
 func (b *Bindings) f(name string) (goja.Callable, error) {
-	f, ok := goja.AssertFunction(b.vm.Get("Gots").ToObject(b.vm).Get(name))
+	f, ok := goja.AssertFunction(b.vm.Get("guts").ToObject(b.vm).Get(name))
 	if !ok {
 		return nil, fmt.Errorf("%q is not a function", name)
 	}
diff --git a/bindings/walk/walk.go b/bindings/walk/walk.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 // Visitor mimics the golang ast visitor interface.
diff --git a/builtins.go b/builtins.go
@@ -1,6 +1,6 @@
-package gots
+package guts
 
-import "github.com/coder/gots/bindings"
+import "github.com/coder/guts/bindings"
 
 const (
 	builtInComparable = "Comparable"
diff --git a/cmd/gots/main.go b/cmd/gots/main.go
@@ -4,13 +4,13 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/coder/gots"
-	"github.com/coder/gots/config"
+	"github.com/coder/guts"
+	"github.com/coder/guts/config"
 )
 
 func main() {
 	//ctx := context.Background()
-	gen, err := gots.NewGolangParser()
+	gen, err := guts.NewGolangParser()
 	if err != nil {
 		panic(err)
 	}
diff --git a/config/mappings.go b/config/mappings.go
@@ -1,25 +1,25 @@
 package config
 
 import (
-	"github.com/coder/gots"
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts"
+	"github.com/coder/guts/bindings"
 )
 
-func OverrideLiteral(keyword bindings.LiteralKeyword) gots.TypeOverride {
+func OverrideLiteral(keyword bindings.LiteralKeyword) guts.TypeOverride {
 	return func() bindings.ExpressionType {
 		return ptr(keyword)
 	}
 }
 
-func OverrideNullable(t gots.TypeOverride) gots.TypeOverride {
+func OverrideNullable(t guts.TypeOverride) guts.TypeOverride {
 	return func() bindings.ExpressionType {
 		return bindings.Union(t(), &bindings.Null{})
 	}
 }
 
 // StandardMappings is a list of standard mappings for Go types to Typescript types.
-func StandardMappings() map[string]gots.TypeOverride {
-	return map[string]gots.TypeOverride{
+func StandardMappings() map[string]guts.TypeOverride {
+	return map[string]guts.TypeOverride{
 		"time.Time":     OverrideLiteral(bindings.KeywordString),
 		"time.Duration": OverrideLiteral(bindings.KeywordNumber),
 
diff --git a/config/mutations.go b/config/mutations.go
@@ -5,11 +5,11 @@ import (
 	"log/slog"
 	"reflect"
 
-	"github.com/coder/gots"
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts"
+	"github.com/coder/guts/bindings"
 )
 
-func ExportTypes(ts *gots.Typescript) {
+func ExportTypes(ts *guts.Typescript) {
 	ts.ForEach(func(key string, node bindings.Node) {
 		switch node := node.(type) {
 		case *bindings.Alias:
@@ -24,7 +24,7 @@ func ExportTypes(ts *gots.Typescript) {
 	})
 }
 
-func ReadOnly(ts *gots.Typescript) {
+func ReadOnly(ts *guts.Typescript) {
 	ts.ForEach(func(key string, node bindings.Node) {
 		switch node := node.(type) {
 		case *bindings.Alias:
@@ -47,7 +47,7 @@ func ReadOnly(ts *gots.Typescript) {
 // EnumBar = "bar"
 // )
 // const MyEnums: string = ["foo", "bar"] <-- this is added
-func EnumLists(ts *gots.Typescript) {
+func EnumLists(ts *guts.Typescript) {
 	addNodes := make(map[string]bindings.Node)
 	ts.ForEach(func(key string, node bindings.Node) {
 		switch node := node.(type) {
diff --git a/convert.go b/convert.go
@@ -1,4 +1,4 @@
-package gots
+package guts
 
 import (
 	"context"
@@ -16,7 +16,7 @@ import (
 	"golang.org/x/tools/go/packages"
 	"golang.org/x/xerrors"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 type TypeOverride func() bindings.ExpressionType
@@ -46,7 +46,7 @@ func NewGolangParser() (*GoParser, error) {
 			packages.NeedTypesSizes | packages.NeedSyntax | packages.NeedDeps,
 		Tests: false,
 		Fset:  fileSet,
-		//Dir:     "/home/steven/go/src/github.com/coder/gots",
+		//Dir:     "/home/steven/go/src/github.com/coder/guts",
 		Context: context.Background(),
 	}
 
@@ -269,7 +269,7 @@ func (ts *Typescript) SerializeInOrder(sort func(nodes map[string]bindings.Node)
 	order := sort(nodes)
 
 	var str strings.Builder
-	str.WriteString("// Code generated by 'gots'. DO NOT EDIT.\n\n")
+	str.WriteString("// Code generated by 'guts'. DO NOT EDIT.\n\n")
 
 	for k, v := range order {
 		obj, err := vm.ToTypescriptNode(v)
diff --git a/convert_test.go b/convert_test.go
@@ -4,7 +4,7 @@
 // Windows tests fail because the \n\r vs \n. It's not worth trying
 // to replace newlines for os tests. If people start using this tool on windows
 // and are seeing problems, then we can add build tags and figure it out.
-package gots_test
+package guts_test
 
 import (
 	"flag"
@@ -15,8 +15,8 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/coder/gots"
-	"github.com/coder/gots/config"
+	"github.com/coder/guts"
+	"github.com/coder/guts/config"
 )
 
 // updateGoldenFiles is a flag that can be set to update golden files.
@@ -36,7 +36,7 @@ func TestGeneration(t *testing.T) {
 		t.Run(f.Name(), func(t *testing.T) {
 			t.Parallel()
 
-			gen, err := gots.NewGolangParser()
+			gen, err := guts.NewGolangParser()
 			require.NoError(t, err, "new convert")
 
 			dir := filepath.Join(".", "testdata", f.Name())
diff --git a/example/simple/main.go b/example/simple/main.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/coder/gots"
+	"github.com/coder/guts"
 )
 
 // SimpleType is a simple struct with a generic type
@@ -16,9 +16,9 @@ type SimpleType[T comparable] struct {
 }
 
 func main() {
-	golang, _ := gots.NewGolangParser()
+	golang, _ := guts.NewGolangParser()
 	// Generate the typescript types for this package
-	_ = golang.Include("github.com/coder/gots/example/simple", true)
+	_ = golang.Include("github.com/coder/guts/example/simple", true)
 	// Map time.Time to string
 	_ = golang.IncludeCustom(map[string]string{
 		"time.Time": "string",
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/coder/gots
+module github.com/coder/guts
 
 go 1.23.0
 
diff --git a/go.sum b/go.sum
@@ -1,5 +1,7 @@
 github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0=
 github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
+github.com/coder/gots v0.0.0-20241126224224-c1756e1dd126 h1:uTQ2599jfTEBWOVGuHnM2o7xOlxi0ClT5PcaXbbh46o=
+github.com/coder/gots v0.0.0-20241126224224-c1756e1dd126/go.mod h1:zH5CGux/eew1rvjjoKKQloiiQMTu2qdx7xIgmPzCRbg=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dlclark/regexp2 v1.11.4 h1:rPYF9/LECdNymJufQKmri9gV604RvvABwgOA8un7yAo=
diff --git a/lookup.go b/lookup.go
@@ -1,11 +1,11 @@
-package gots
+package guts
 
 import (
 	"go/types"
 	"path"
 	"path/filepath"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 func (ts *Typescript) location(obj types.Object) bindings.Source {
diff --git a/node.go b/node.go
@@ -1,9 +1,9 @@
-package gots
+package guts
 
 import (
 	"fmt"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 type typescriptNode struct {
diff --git a/single.go b/single.go
@@ -1,4 +1,4 @@
-package gots
+package guts
 
 import (
 	"fmt"
@@ -9,7 +9,7 @@ import (
 
 	"golang.org/x/xerrors"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 // parseExpression is kinda janky, but it allows you to send in Golang types
diff --git a/single_internal_test.go b/single_internal_test.go
@@ -1,11 +1,11 @@
-package gots
+package guts
 
 import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/coder/gots/bindings"
+	"github.com/coder/guts/bindings"
 )
 
 func TestParseSingle(t *testing.T) {
diff --git a/testdata/alias/alias.ts b/testdata/alias/alias.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From alias/alias.go
 export type Alias = string;
diff --git a/testdata/basicgenerics/basicgenerics.ts b/testdata/basicgenerics/basicgenerics.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From basicgenerics/basicgenerics.go
 export interface Basic<A extends Constraint> {
diff --git a/testdata/constants/constants.ts b/testdata/constants/constants.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From constants/constants.go
 export const High = "five";
diff --git a/testdata/enums/enums.ts b/testdata/enums/enums.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/enums.go
 export type EnumInt = 10 | 5;
diff --git a/testdata/external/external.ts b/testdata/external/external.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From external/external.go
 export interface ExternalField {
diff --git a/testdata/genericmap/genericmap.ts b/testdata/genericmap/genericmap.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/genericmap.go
 export interface Buzz {
diff --git a/testdata/generics/generics.ts b/testdata/generics/generics.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/generics.go
 export interface BasicGeneric<A extends any> {
diff --git a/testdata/genericslice/genericslice.ts b/testdata/genericslice/genericslice.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/genericslice.go
 export interface Bar {
diff --git a/testdata/genericstruct/genericstruct.ts b/testdata/genericstruct/genericstruct.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From genericstruct/genericstruct.go
 export interface Baz<S extends Foo<string, string>, I extends Comparable, X extends Foo<I, I>> {
diff --git a/testdata/inheritance/inheritance.ts b/testdata/inheritance/inheritance.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/inheritance.go
 export interface Bar {
diff --git a/testdata/interface/interface.ts b/testdata/interface/interface.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From codersdk/interface.go
 export interface Bar {
diff --git a/testdata/maps/maps.ts b/testdata/maps/maps.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From maps/map.go
 export interface Bar<T extends any> {
diff --git a/testdata/nullable/nullable.ts b/testdata/nullable/nullable.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From nullable/nullable.go
 export interface EmptyFields {
diff --git a/testdata/override/override.ts b/testdata/override/override.ts
@@ -1,4 +1,4 @@
-// Code generated by 'gots'. DO NOT EDIT.
+// Code generated by 'guts'. DO NOT EDIT.
 
 // From override/override.go
 export interface OverrideTypes {
diff --git a/typescript-engine/dist/main.js b/typescript-engine/dist/main.js
diff --git a/typescript-engine/webpack.config.js b/typescript-engine/webpack.config.js
@@ -13,7 +13,7 @@ const config = {
         path: path.resolve(__dirname, 'dist'),
         filename: "main.js",
         libraryTarget: 'var',
-        library: 'Gots'
+        library: 'guts'
     },
     plugins: [
         // Add your plugins here

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/dop251/goja"`
`7`	`7`
`8`		`- typescriptengine "github.com/coder/gots/typescript-engine"`
	`8`	`+ typescriptengine "github.com/coder/guts/typescript-engine"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`type Bindings struct {`
`@@ -25,7 +25,7 @@ func New() (*Bindings, error) {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`func (b *Bindings) f(name string) (goja.Callable, error) {`
`28`		`- f, ok := goja.AssertFunction(b.vm.Get("Gots").ToObject(b.vm).Get(name))`
	`28`	`+ f, ok := goja.AssertFunction(b.vm.Get("guts").ToObject(b.vm).Get(name))`
`29`	`29`	`if !ok {`
`30`	`30`	`return nil, fmt.Errorf("%q is not a function", name)`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import (`
`4`	`4`	`"fmt"`
`5`	`5`	`"strings"`
`6`	`6`
`7`		`- "github.com/coder/gots/bindings"`
	`7`	`+ "github.com/coder/guts/bindings"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`// Visitor mimics the golang ast visitor interface.`
Original file line number	Diff line number	Diff line change
`@@ -1,25 +1,25 @@`
`1`	`1`	`package config`
`2`	`2`
`3`	`3`	`import (`
`4`		`- "github.com/coder/gots"`
`5`		`- "github.com/coder/gots/bindings"`
	`4`	`+ "github.com/coder/guts"`
	`5`	`+ "github.com/coder/guts/bindings"`
`6`	`6`	`)`
`7`	`7`
`8`		`-func OverrideLiteral(keyword bindings.LiteralKeyword) gots.TypeOverride {`
	`8`	`+func OverrideLiteral(keyword bindings.LiteralKeyword) guts.TypeOverride {`
`9`	`9`	`return func() bindings.ExpressionType {`
`10`	`10`	`return ptr(keyword)`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`
`14`		`-func OverrideNullable(t gots.TypeOverride) gots.TypeOverride {`
	`14`	`+func OverrideNullable(t guts.TypeOverride) guts.TypeOverride {`
`15`	`15`	`return func() bindings.ExpressionType {`
`16`	`16`	`return bindings.Union(t(), &bindings.Null{})`
`17`	`17`	`}`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`// StandardMappings is a list of standard mappings for Go types to Typescript types.`
`21`		`-func StandardMappings() map[string]gots.TypeOverride {`
`22`		`- return map[string]gots.TypeOverride{`
	`21`	`+func StandardMappings() map[string]guts.TypeOverride {`
	`22`	`+ return map[string]guts.TypeOverride{`
`23`	`23`	`"time.Time": OverrideLiteral(bindings.KeywordString),`
`24`	`24`	`"time.Duration": OverrideLiteral(bindings.KeywordNumber),`
`25`	`25`