Add 'DO NOT EDIT' to the top

Emyrk · Emyrk · commit 0d943f1b8cde · 2022-04-28T09:59:03.000-05:00
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 	"reflect"
 	"regexp"
+	"sort"
 	"strings"
 
 	"golang.org/x/tools/go/packages"
@@ -19,6 +20,7 @@ import (
 
 const (
 	baseDir = "./codersdk"
+	indent  = "  "
 )
 
 // TODO: Handle httpapi.Response and other types
@@ -44,6 +46,8 @@ type TypescriptTypes struct {
 // String just combines all the codeblocks.
 func (t TypescriptTypes) String() string {
 	var s strings.Builder
+	s.WriteString("// Code generated by 'make coder/scripts/apitypings/main.go'. DO NOT EDIT.\n\n")
+
 	sortedTypes := make([]string, 0, len(t.Types))
 	sortedEnums := make([]string, 0, len(t.Types))
 
@@ -54,6 +58,9 @@ func (t TypescriptTypes) String() string {
 		sortedEnums = append(sortedEnums, k)
 	}
 
+	sort.Strings(sortedTypes)
+	sort.Strings(sortedEnums)
+
 	for _, k := range sortedTypes {
 		v := t.Types[k]
 		s.WriteString(v)
@@ -65,7 +72,8 @@ func (t TypescriptTypes) String() string {
 		s.WriteString(v)
 		s.WriteRune('\n')
 	}
-	return s.String()
+
+	return strings.TrimRight(s.String(), "\n")
 }
 
 // GenerateFromDirectory will return all the typescript code blocks for a directory
@@ -265,13 +273,13 @@ func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, err
 		}
 
 		if tsType.Comment != "" {
-			s.WriteString(fmt.Sprintf("\t// %s\n", tsType.Comment))
+			s.WriteString(fmt.Sprintf("%s// %s\n", indent, tsType.Comment))
 		}
 		optional := ""
 		if tsType.Optional {
 			optional = "?"
 		}
-		s.WriteString(fmt.Sprintf("\treadonly %s%s: %s\n", jsonName, optional, tsType.ValueType))
+		s.WriteString(fmt.Sprintf("%sreadonly %s%s: %s\n", indent, jsonName, optional, tsType.ValueType))
 	}
 	s.WriteString("}\n")
 	return s.String(), nil
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -1,3 +1,5 @@
+// Code generated by 'make coder/scripts/apitypings/main.go'. DO NOT EDIT.
+
 // From codersdk/workspaceagents.go:35:6
 export interface AWSInstanceIdentityToken {
   readonly signature: string
@@ -420,5 +422,3 @@ export type UserStatus = "active" | "suspended"
 
 // From codersdk/workspaceresources.go:15:6
 export type WorkspaceAgentStatus = "connected" | "connecting" | "disconnected"
-
-
