Skip to content

feat: generate typescript types from codersdk structs #1047

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 24 commits into from
Apr 19, 2022
Merged

feat: generate typescript types from codersdk structs #1047

Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
175e9c2
feat: experiment: generate typescript types from codersdk structs
f0ssel Apr 15, 2022
670e7b7
Add support for bool and number
f0ssel Apr 15, 2022
1a04052
generate missing types
f0ssel Apr 18, 2022
e25d5af
Add optional fields
f0ssel Apr 18, 2022
7f93018
Add to make gen
f0ssel Apr 18, 2022
23e36fc
make lint
f0ssel Apr 18, 2022
1db1432
remove gomod changes
f0ssel Apr 18, 2022
c430a2d
Add code line docs
f0ssel Apr 18, 2022
a511f6a
Cleanup error handle
f0ssel Apr 18, 2022
e31f2af
move to scripts
f0ssel Apr 18, 2022
b5c2f27
overwrite types.ts
f0ssel Apr 18, 2022
733a17e
Generate better enums
f0ssel Apr 18, 2022
3b11dc3
generate separate file
f0ssel Apr 18, 2022
4e65142
revert changes to other files
f0ssel Apr 18, 2022
3ddbf42
another
f0ssel Apr 18, 2022
4d97ec4
space
f0ssel Apr 18, 2022
fdedb03
fix
f0ssel Apr 18, 2022
a1f5044
Add readonly flags
f0ssel Apr 18, 2022
0bc5e2b
fix make gen
f0ssel Apr 18, 2022
a7e1dcb
fix make
f0ssel Apr 18, 2022
64e3102
Fix yarn format:types
f0ssel Apr 19, 2022
89c8b2b
Add node steps to gen step
f0ssel Apr 19, 2022
ae2940f
update make gen
f0ssel Apr 19, 2022
7b63673
fix make gen
f0ssel Apr 19, 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
make lint
  • Loading branch information
@f0ssel
f0ssel committed Apr 18, 2022
commit 23e36fcec67a5592eb09bf5557bdff7137be6719
103 changes: 45 additions & 58 deletions coderts/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,48 +25,43 @@ func main() {
}

func run() error {
var astFiles []*ast.File
fset := token.NewFileSet()
entries, err := os.ReadDir(baseDir)
if err != nil {
return err
return xerrors.Errorf("reading dir %s: %w", baseDir, err)
}

// loop each file in directory
for _, entry := range entries {
goFile, err := parser.ParseFile(fset, filepath.Join(baseDir, entry.Name()), nil, 0)
astFile, err := parser.ParseFile(fset, filepath.Join(baseDir, entry.Name()), nil, 0)
if err != nil {
return err
return xerrors.Errorf("parsing file %s: %w", filepath.Join(baseDir, entry.Name()), err)
}

astFiles = append(astFiles, goFile)
}

for _, astFile := range astFiles {
// loop each declaration in file
for _, node := range astFile.Decls {
switch node.(type) {
case *ast.GenDecl:
genDecl := node.(*ast.GenDecl)
for _, spec := range genDecl.Specs {
switch spec.(type) {
case *ast.TypeSpec:
typeSpec := spec.(*ast.TypeSpec)
s, err := handleTypeSpec(typeSpec)
if err != nil {
break
}

fmt.Printf(s)
genDecl, ok := node.(*ast.GenDecl)
if !ok {
continue
}
for _, spec := range genDecl.Specs {
switch s := spec.(type) {
// TypeSpec case for structs and type alias
case *ast.TypeSpec:
out, err := handleTypeSpec(s)
if err != nil {
break
case *ast.ValueSpec:
valueSpec := spec.(*ast.ValueSpec)
s, err := handleValueSpec(valueSpec)
if err != nil {
break
}

fmt.Printf(s)
}

_, _ = fmt.Printf(out)
// ValueSpec case for const "enums"
case *ast.ValueSpec:
out, err := handleValueSpec(s)
if err != nil {
break
}

_, _ = fmt.Printf(out)
}
}
}
Expand All @@ -78,29 +73,17 @@ func run() error {
func handleTypeSpec(typeSpec *ast.TypeSpec) (string, error) {
jsonFields := 0
s := ""
switch typeSpec.Type.(type) {
switch t := typeSpec.Type.(type) {
// Struct declaration
case *ast.StructType:
s = fmt.Sprintf("export interface %s {\n", typeSpec.Name.Name)
structType := typeSpec.Type.(*ast.StructType)
for _, field := range structType.Fields.List {
var i *ast.Ident
optional := ""
switch field.Type.(type) {
case *ast.Ident:
i = field.Type.(*ast.Ident)
case *ast.StarExpr:
var ok bool
se := field.Type.(*ast.StarExpr)
i, ok = se.X.(*ast.Ident)
if !ok {
continue
}
optional = "?"
default:
for _, field := range t.Fields.List {
i, optional, err := getIdent(field.Type)
if err != nil {
continue
}

fieldType := toTsType(i)
fieldType := toTsType(i.Name)
if fieldType == "" {
continue
}
Expand All @@ -114,15 +97,15 @@ func handleTypeSpec(typeSpec *ast.TypeSpec) (string, error) {
jsonFields++
}

// Do not print struct if it has no json fields
if jsonFields == 0 {
return "", xerrors.New("no json fields")
}

return fmt.Sprintf("%s}\n\n", s), nil
// Type alias declaration
case *ast.Ident:
ident := typeSpec.Type.(*ast.Ident)

return fmt.Sprintf("type %s = %s\n\n", typeSpec.Name.Name, ident.Name), nil
return fmt.Sprintf("type %s = %s\n\n", typeSpec.Name.Name, t.Name), nil
default:
return "", xerrors.New("not struct or alias")
}
Expand Down Expand Up @@ -159,18 +142,22 @@ func handleValueSpec(valueSpec *ast.ValueSpec) (string, error) {
return fmt.Sprintf("%s %s: %s = %s\n\n", valueDecl, valueName, valueType, valueValue), nil
}

func toTsType(e ast.Expr) string {
fieldType := ""
switch e.(type) {
func getIdent(e ast.Expr) (*ast.Ident, string, error) {
switch t := e.(type) {
case *ast.Ident:
i := e.(*ast.Ident)
fieldType = i.Name
return t, "", nil
case *ast.StarExpr:
se := e.(*ast.StarExpr)
i := se.X.(*ast.Ident)
fieldType = i.Name
i, ok := t.X.(*ast.Ident)
if !ok {
return nil, "", xerrors.New("failed to cast star expr to indent")
}
return i, "?", nil
default:
return nil, "", xerrors.New("unknown expr type")
}
}

func toTsType(fieldType string) string {
switch fieldType {
case "bool":
return "boolean"
Expand Down