feat: Switch packages for typescript generation code (#1196)

Emyrk · web-flow · commit e330dc1321d1 · 2022-04-28T16:59:14.000Z
* feat: Switch packages for typescript generation code

Supports a larger set of types
  - [x] Basics (string/int/etc) 
  - [x] Maps
  - [x] Slices
  - [x] Enums
  - [x] Pointers
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -26,6 +26,7 @@ func New(serverURL *url.URL) *Client {
 }
 
 // Client is an HTTP caller for methods to the Coder API.
+// @typescript-ignore Client
 type Client struct {
 	HTTPClient   *http.Client
 	SessionToken string
@@ -113,6 +114,7 @@ func readBodyAsError(res *http.Response) error {
 }
 
 // Error represents an unaccepted or invalid request to the API.
+// @typescript-ignore Error
 type Error struct {
 	httpapi.Response
 
diff --git a/go.mod b/go.mod
@@ -109,6 +109,7 @@ require (
 	golang.org/x/sys v0.0.0-20220412211240-33da011f77ad
 	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211
 	golang.org/x/text v0.3.7
+	golang.org/x/tools v0.1.10
 	golang.org/x/xerrors v0.0.0-20220411194840-2f41105eb62f
 	google.golang.org/api v0.75.0
 	google.golang.org/protobuf v1.28.0
diff --git a/go.sum b/go.sum
@@ -2287,6 +2287,7 @@ golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.6-0.20210726203631-07bc1bf47fb2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.10 h1:QjFRCZxdOhBJ/UNgnBZLbNV13DlbnK0quyivTnXJM20=
+golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E=
 golang.org/x/xerrors v0.0.0-20190410155217-1f06c39b4373/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20190513163551-3ee3066db522/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
diff --git a/scripts/apitypings/README.md b/scripts/apitypings/README.md
@@ -0,0 +1,40 @@
+# APITypings
+
+This main.go generates typescript types from the codersdk types in Go.
+
+# Features
+
+- Supports Go types
+  - [x] Basics (string/int/etc) 
+  - [x] Maps
+  - [x] Slices
+  - [x] Enums
+  - [x] Pointers
+  - [ ] External Types (uses `any` atm)
+    - Some custom external types are hardcoded in (eg: time.Time)
+
+
+## Type overrides
+
+```golang
+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.
+
+```golang
+// @typescript-ignore InternalType
+type InternalType struct {
+	// ...
+}
+```
+
+# Future Ideas
+
+- Should `omitempty` in the `json` tag indicate optional?
+- Use a yaml config for overriding certain types
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ func New(serverURL url.URL) Client {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`// Client is an HTTP caller for methods to the Coder API.`
	`29`	`+// @typescript-ignore Client`
`29`	`30`	`type Client struct {`
`30`	`31`	`HTTPClient *http.Client`
`31`	`32`	`SessionToken string`
`@@ -113,6 +114,7 @@ func readBodyAsError(res *http.Response) error {`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`// Error represents an unaccepted or invalid request to the API.`
	`117`	`+// @typescript-ignore Error`
`116`	`118`	`type Error struct {`
`117`	`119`	`httpapi.Response`
`118`	`120`