Add unit test readme

Emyrk · Emyrk · commit 66a456c20170 · 2022-10-19T23:46:27.000-05:00
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -510,14 +510,6 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
 	return data.String(), nil
 }
 
-c := TypescriptType {
-	  ValueType: "comparable",
-	  GenericValue: "C",
-	  GenericTypes: map[string]string{
-		  "C":"comparable"
-	  }
-}
-
 type TypescriptType struct {
 	// GenericTypes is a map of generic name to actual constraint.
 	// We return these, so we can bubble them up if we are recursively traversing
@@ -543,7 +535,7 @@ type TypescriptType struct {
 	GenericValue string
 	// ValueType is the typescript value type. This is the actual type or
 	// generic constraint. This can **always** be used without special handling.
-	ValueType    string
+	ValueType string
 	// AboveTypeLine lets you put whatever text you want above the typescript
 	// type line.
 	AboveTypeLine string
diff --git a/scripts/apitypings/testdata/README.md b/scripts/apitypings/testdata/README.md
@@ -0,0 +1,5 @@
+# How to add a unit test
+
+1. Create a new directory in `testdata`
+2. Name a go file `<directory_name>.go`. This file will generate the typescript.
+3. Name the expected typescript file `<directory_name>.ts`. This is the unit test's expected output.
diff --git a/scripts/apitypings/testdata/enums/enums.go b/scripts/apitypings/testdata/enums/enums.go
@@ -0,0 +1,10 @@
+package enums
+
+type Enum string
+
+const (
+	EnumFoo Enum = "foo"
+	EnumBar Enum = "bar"
+	EnumBaz Enum = "baz"
+	EnumQux Enum = "qux"
+)
diff --git a/scripts/apitypings/testdata/enums/enums.ts b/scripts/apitypings/testdata/enums/enums.ts
@@ -0,0 +1,4 @@
+// Code generated by 'make coder/scripts/apitypings/main.go'. DO NOT EDIT.
+
+// From codersdk/enums.go
+export type Enum = "bar" | "baz" | "foo" | "qux"
