mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00

Files

Joe Previte ffe461ae58 chore(site): enable eslint-plugin-eslint-comments (#4799 )

* chore(site): enable eslint-plugin-eslint-comments

* chore: add descriptions to eslint-disable comments

* chore: update eslint-disable comments in main.go

2022-10-28 17:46:51 -03:00

testdata

chore: Add generics to typescript generator (#4664 )

2022-10-20 08:15:24 -05:00

main_test.go

chore: Add generics to typescript generator (#4664 )

2022-10-20 08:15:24 -05:00

main.go

chore(site): enable eslint-plugin-eslint-comments (#4799 )

2022-10-28 17:46:51 -03:00

README.md

chore: switch to generated types (#1394 )

2022-05-12 10:01:28 -05:00

README.md

APITypings

This main.go generates typescript types from the codersdk types in Go.

Features

Supports Go types
- Basics (string/int/etc)
- Maps
- Slices
- Enums
- Pointers
- External Types (uses any atm)
  - Some custom external types are hardcoded in (eg: time.Time)

Type overrides

type Foo struct {
	// Force the typescript type to be a number
	CreatedAt time.Duration `json:"created_at" typescript:"number"`
}

Ignore Types

Do not generate ignored types.

// @typescript-ignore InternalType
type InternalType struct {
	// ...
}

Future Ideas

Use a yaml config for overriding certain types