Apr 15, 2024 · Apr 11, 2024 · Apr 11, 2024 · Apr 11, 2024 · Apr 12, 2024 · Apr 12, 2024
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
 return TypescriptType{}, xerrors.Errorf("array: %w", err)
 }
 genValue := ""

 // Always wrap in parentheses for proper scoped types.
 // Running prettier on this output will remove redundant parenthesis,
 // so this makes our decision-making easier.
 // The example that breaks without this is:
 //readonly readonly string[][]
 if underlying.GenericValue != "" {
 genValue = underlying.GenericValue + "[]"
 genValue ="(readonly " +underlying.GenericValue + "[])"
 }
 return TypescriptType{
 ValueType:     underlying.ValueType + "[]",
 ValueType:"(readonly " +underlying.ValueType + "[])",
 GenericValue:  genValue,
 AboveTypeLine: underlying.AboveTypeLine,
 GenericTypes:  underlying.GenericTypes,
diff --git a/scripts/apitypings/main_test.go b/scripts/apitypings/main_test.go
 package main

 import (
 "flag"
 "os"
 "path/filepath"
 "strings"
 "github.com/stretchr/testify/require"
 )

 // updateGoldenFiles is a flag that can be set to update golden files.
 var updateGoldenFiles = flag.Bool("update", false, "Update golden files")

 func TestGeneration(t *testing.T) {
 t.Parallel()
 files, err := os.ReadDir("testdata")
 require.NoErrorf(t, err, "read file %s", golden)
 expectedString := strings.TrimSpace(string(expected))
 output = strings.TrimSpace(output)
 require.Equal(t, expectedString, output, "matched output")
 if *updateGoldenFiles {
 // nolint:gosec
 err := os.WriteFile(golden, []byte(output), 0o644)
 require.NoError(t, err, "write golden file")
 } else {
 require.Equal(t, expectedString, output, "matched output")
 }
 })
 }
 }
diff --git a/scripts/apitypings/testdata/enums/enums.go b/scripts/apitypings/testdata/enums/enums.go
 package codersdk

 type (
 Enum  string
 Enums []Enum
 Enumstring
 EnumSliceType []Enum
 )

 const (
diff --git a/scripts/apitypings/testdata/enums/enums.ts b/scripts/apitypings/testdata/enums/enums.ts
 // From codersdk/enums.go
 export typeEnums = Enum[]
 export typeEnumSliceType =(readonlyEnum[])

 // From codersdk/enums.go
 export type Enum = "bar" | "baz" | "foo" | "qux"
diff --git a/scripts/apitypings/testdata/genericmap/genericmap.go b/scripts/apitypings/testdata/genericmap/genericmap.go
 package codersdk

 type Foo struct {
 Bar string `json:"bar"`
 }

 type Buzz struct {
 Foo  `json:"foo"`
 Bazz string `json:"bazz"`
 }

 typeCustom interface {
 Foo | Buzz
 typeFoo struct {
 Bar string `json:"bar"`
 }

 type FooBuzz[R Custom] struct {
 Something []R `json:"something"`
 }

 type Custom interface {
 Foo | Buzz
 }

 // Not yet supported
 //type FooBuzzMap[R Custom] struct {
 //Something map[string]R `json:"something"`
diff --git a/scripts/apitypings/testdata/genericmap/genericmap.ts b/scripts/apitypings/testdata/genericmap/genericmap.ts

 // From codersdk/genericmap.go
 export interface FooBuzz<R extends Custom> {
  readonly something: R[]
  readonly something:(readonlyR[])
 }

 // From codersdk/genericmap.go
 export type Custom = Foo | Buzz
 export type Custom = Foo | Buzz
diff --git a/scripts/apitypings/testdata/generics/generics.ts b/scripts/apitypings/testdata/generics/generics.ts
 }

 // From codersdk/generics.go
 export type Custom = string | boolean | number | string[] | null
 export type Custom = string | boolean | number |(readonlystring[]) | null

 // From codersdk/generics.go
 export type Single = string

 export type comparable = boolean | number | string | any
 export type comparable = boolean | number | string | any
diff --git a/scripts/apitypings/testdata/genericslice/genericslice.go b/scripts/apitypings/testdata/genericslice/genericslice.go
 package codersdk

 type Bar struct {
 Bar string
 }

 type Foo[R any] struct {
 Slice []R
 TwoD  [][]R
 }
diff --git a/scripts/apitypings/testdata/genericslice/genericslice.ts b/scripts/apitypings/testdata/genericslice/genericslice.ts
 // From codersdk/genericslice.go
 export interface Bar {
  readonly Bar: string
 }

 // From codersdk/genericslice.go
 export interface Foo<R extends any> {
  readonly Slice: (readonly R[])
  readonly TwoD: (readonly (readonly R[])[])
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -814,11 +814,17 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
		return TypescriptType{}, xerrors.Errorf("array: %w", err)
		}
		genValue := ""

		// Always wrap in parentheses for proper scoped types.
		// Running prettier on this output will remove redundant parenthesis,
		// so this makes our decision-making easier.
		// The example that breaks without this is:
		//readonly readonly string[][]
		if underlying.GenericValue != "" {
		genValue = underlying.GenericValue + "[]"
		genValue ="(readonly " +underlying.GenericValue + "[])"
		}
		return TypescriptType{
		ValueType: underlying.ValueType + "[]",
		ValueType:"(readonly " +underlying.ValueType + "[])",
		GenericValue: genValue,
		AboveTypeLine: underlying.AboveTypeLine,
		GenericTypes: underlying.GenericTypes,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,7 @@
		package main

		import (
		"flag"
		"os"
		"path/filepath"
		"strings"
Expand All		@@ -15,6 +16,9 @@ import (
		"github.com/stretchr/testify/require"
		)

		// updateGoldenFiles is a flag that can be set to update golden files.
		var updateGoldenFiles = flag.Bool("update", false, "Update golden files")

		func TestGeneration(t *testing.T) {
		t.Parallel()
		files, err := os.ReadDir("testdata")
Expand All		@@ -37,7 +41,13 @@ func TestGeneration(t *testing.T) {
		require.NoErrorf(t, err, "read file %s", golden)
		expectedString := strings.TrimSpace(string(expected))
		output = strings.TrimSpace(output)
		require.Equal(t, expectedString, output, "matched output")
		if *updateGoldenFiles {
		// nolint:gosec
		err := os.WriteFile(golden, []byte(output), 0o644)
		require.NoError(t, err, "write golden file")
		} else {
		require.Equal(t, expectedString, output, "matched output")
		}
		})
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -1,8 +1,8 @@
		package codersdk

		type (
		Enum string
		Enums []Enum
		Enumstring
		EnumSliceType []Enum
		)

		const (
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,5 +1,5 @@
		// From codersdk/enums.go
		export typeEnums = Enum[]
		export typeEnumSliceType =(readonlyEnum[])

		// From codersdk/enums.go
		export type Enum = "bar" \| "baz" \| "foo" \| "qux"
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,22 +1,22 @@
		package codersdk

		type Foo struct {
		Bar string `json:"bar"`
		}

		type Buzz struct {
		Foo `json:"foo"`
		Bazz string `json:"bazz"`
		}

		typeCustom interface {
		Foo \| Buzz
		typeFoo struct {
		Bar string `json:"bar"`
		}

		type FooBuzz[R Custom] struct {
		Something []R `json:"something"`
		}

		type Custom interface {
		Foo \| Buzz
		}

		// Not yet supported
		//type FooBuzzMap[R Custom] struct {
		//Something map[string]R `json:"something"`
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,8 +11,8 @@ export interface Foo {

		// From codersdk/genericmap.go
		export interface FooBuzz<R extends Custom> {
		readonly something: R[]
		readonly something:(readonlyR[])
		}

		// From codersdk/genericmap.go
		export type Custom = Foo \| Buzz
		export type Custom = Foo \| Buzz
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,9 +33,9 @@ export interface Static {
		}

		// From codersdk/generics.go
		export type Custom = string \| boolean \| number \| string[] \| null
		export type Custom = string \| boolean \| number \|(readonlystring[]) \| null

		// From codersdk/generics.go
		export type Single = string

		export type comparable = boolean \| number \| string \| any
		export type comparable = boolean \| number \| string \| any
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,10 @@
		package codersdk

		type Bar struct {
		Bar string
		}

		type Foo[R any] struct {
		Slice []R
		TwoD [][]R
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,10 @@
		// From codersdk/genericslice.go
		export interface Bar {
		readonly Bar: string
		}

		// From codersdk/genericslice.go
		export interface Foo<R extends any> {
Copy link Member ParkreinerApr 15, 2024• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Not for the future:`R extends any` actually doesn't do anything at all. Since`any` is a top type, everything in TypeScript extends`any`, so the type constraint provides zero protection At some point, we'd probably want to turn this into exportinterfaceFoo<R=unknown>{// Stuff}
		readonly Slice: (readonly R[])
		readonly TwoD: (readonly (readonly R[])[])
		}