Skip to content

feat: Switch packages for typescript generation code #1196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Apr 28, 2022
Merged

feat: Switch packages for typescript generation code #1196

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
ee71acd
feat: Switch packages for typescript generation code
Emyrk Apr 27, 2022
b0b17d0
Add enum functionality
Emyrk Apr 28, 2022
28c2811
Handle reused types
Emyrk Apr 28, 2022
710b427
Add comment
Emyrk Apr 28, 2022
071026d
Allow ignoring types for autogen
Emyrk Apr 28, 2022
2741efa
Fix ignore, add optional fields
Emyrk Apr 28, 2022
c62feeb
Add map support
Emyrk Apr 28, 2022
462ebeb
Handle unknown types better
Emyrk Apr 28, 2022
21d1687
Add comments, run gen
Emyrk Apr 28, 2022
9a3d7e3
Add basic readme
Emyrk Apr 28, 2022
1afaa5d
Merge remote-tracking branch 'origin/main' into stevenmasley/redo_typ…
Emyrk Apr 28, 2022
7cfba41
Reorder imports
Emyrk Apr 28, 2022
0127e6d
Sort all output
Emyrk Apr 28, 2022
0d943f1
Add 'DO NOT EDIT' to the top
Emyrk Apr 28, 2022
2379c21
Go linting
Emyrk Apr 28, 2022
3865f36
Fix typescript linter
Emyrk Apr 28, 2022
176b481
Use correct array size for allocation
Emyrk Apr 28, 2022
0d37eeb
Update readme
Emyrk Apr 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add map support
  • Loading branch information
@Emyrk
Emyrk committed Apr 28, 2022
commit c62feebc09772b363879b4a55664a75fcefe5d30
25 changes: 19 additions & 6 deletions scripts/apitypings/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
tsType.ValueType = typescriptTag
} else {
var err error
tsType, err = g.typescriptType(obj, field.Type())
tsType, err = g.typescriptType(field.Type())
if err != nil {
return "", xerrors.Errorf("typescript type: %w", err)
}
Expand Down Expand Up @@ -288,7 +288,7 @@ type TypescriptType struct {
// golang type.
// Eg:
// []byte returns "string"
func (g *Generator) typescriptType(obj types.Object, ty types.Type) (TypescriptType, error) {
func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
switch ty.(type) {
case *types.Basic:
bs := ty.(*types.Basic)
Expand All @@ -312,7 +312,20 @@ func (g *Generator) typescriptType(obj types.Object, ty types.Type) (TypescriptT
return TypescriptType{ValueType: ty.String(), Comment: "Unknown struct, this might not work"}, nil
case *types.Map:
// TODO: Typescript dictionary??? Object?
return TypescriptType{ValueType: "map_not_implemented"}, nil
// map[string][string] -> Record<string, string>
m := ty.(*types.Map)
keyType, err := g.typescriptType(m.Key())
if err != nil {
return TypescriptType{}, xerrors.Errorf("map key: %w", err)
}
valueType, err := g.typescriptType(m.Elem())
if err != nil {
return TypescriptType{}, xerrors.Errorf("map key: %w", err)
}

return TypescriptType{
ValueType: fmt.Sprintf("Record<%s, %s>", keyType.ValueType, valueType.ValueType),
}, nil
case *types.Slice, *types.Array:
// Slice/Arrays are pretty much the same.
type hasElem interface {
Expand All @@ -329,7 +342,7 @@ func (g *Generator) typescriptType(obj types.Object, ty types.Type) (TypescriptT
return TypescriptType{ValueType: "string"}, nil
default:
// By default, just do an array of the underlying type.
underlying, err := g.typescriptType(obj, arr.Elem())
underlying, err := g.typescriptType(arr.Elem())
if err != nil {
return TypescriptType{}, xerrors.Errorf("array: %w", err)
}
Expand Down Expand Up @@ -362,13 +375,13 @@ func (g *Generator) typescriptType(obj types.Object, ty types.Type) (TypescriptT
}

// Defer to the underlying type.
return g.typescriptType(obj, ty.Underlying())
return g.typescriptType(ty.Underlying())
case *types.Pointer:
// Dereference pointers.
// TODO: Nullable fields? We could say these fields can be null in the
// typescript.
pt := ty.(*types.Pointer)
resp, err := g.typescriptType(obj, pt.Elem())
resp, err := g.typescriptType(pt.Elem())
if err != nil {
return TypescriptType{}, xerrors.Errorf("pointer: %w", err)
}
Expand Down
Loading