Skip to content

feat: Add support for json omitempty and embedded structs in apitypings #1318

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 6 commits into from
May 10, 2022
Merged

feat: Add support for json omitempty and embedded structs in apitypings #1318

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f0be885
feat: Add support for json omitempty to apitypings
mafredri May 6, 2022
a723e32
feat: Express embedded structs via extends in TypeScript
mafredri May 6, 2022
5cc68c9
Mark typesGenerated.ts as PHONY in Makefile
mafredri May 6, 2022
b832fdb
Handle unembedding via json field in apitypings
mafredri May 6, 2022
0e0395d
Add scripts/apitypings/main.go to Makefile instead of using .PHONY
mafredri May 6, 2022
3650ed7
Run make gen
mafredri May 10, 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
feat: Express embedded structs via extends in TypeScript
  • Loading branch information
@mafredri
mafredri committed May 10, 2022
commit a723e32395f75bfec3e0cce4814f776f1951a4a6
22 changes: 20 additions & 2 deletions scripts/apitypings/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,28 @@ func (g *Generator) posLine(obj types.Object) string {
func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, error) {
var s strings.Builder
_, _ = s.WriteString(g.posLine(obj))
_, _ = s.WriteString(fmt.Sprintf("export interface %s ", obj.Name()))

_, _ = s.WriteString(fmt.Sprintf("export interface %s {\n", obj.Name()))
// Handle named embedded structs in the codersdk package via extension.
var extends []string
extendedFields := make(map[int]bool)
for i := 0; i < st.NumFields(); i++ {
field := st.Field(i)
if field.Embedded() && field.Pkg().Name() == "codersdk" {
extendedFields[i] = true
extends = append(extends, field.Name())
}
}
if len(extends) > 0 {
_, _ = s.WriteString(fmt.Sprintf("extends %s ", strings.Join(extends, ", ")))
}

_, _ = s.WriteString("{\n")
// For each field in the struct, we print 1 line of the typescript interface
for i := 0; i < st.NumFields(); i++ {
if extendedFields[i] {
continue
}
field := st.Field(i)
tag := reflect.StructTag(st.Tag(i))

Expand Down Expand Up @@ -326,7 +344,7 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
return TypescriptType{
ValueType: "any",
AboveTypeLine: fmt.Sprintf("%s\n%s",
indentedComment("Embedded struct, please fix by naming it"),
indentedComment("Embedded anonymous struct, please fix by naming it"),
indentedComment("eslint-disable-next-line @typescript-eslint/no-explicit-any"),
),
}, nil
Expand Down