add icon and tag parsing

coder · f0ssel · Dec 9, 2022 · Dec 6, 2022 · Dec 7, 2022 · Dec 7, 2022
commit 85266d017679b5fcdfd336e8d836dc75cdc0ebf3
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -83,11 +83,13 @@ type UpdateTemplateMeta struct {
 }
 
 type TemplateExample struct {
-	ID          string `json:"id"`
-	URL         string `json:"url"`
-	Name        string `json:"name"`
-	Description string `json:"description"`
-	Markdown    string `json:"markdown"`
+	ID          string   `json:"id"`
+	URL         string   `json:"url"`
+	Name        string   `json:"name"`
+	Description string   `json:"description"`
+	Icon        string   `json:"icon"`
+	Tags        []string `json:"tags"`
+	Markdown    string   `json:"markdown"`
 }
 
 // Template returns a single template.

diff --git a/examples/examples.go b/examples/examples.go
@@ -87,11 +87,41 @@ func List() ([]codersdk.TemplateExample, error) {
 				return
 			}
 
+			tags := []string{}
+			tagsRaw, exists := frontMatter.FrontMatter["tags"]
+			if exists {
+				tagsI, valid := tagsRaw.([]interface{})
+				if !valid {
+					returnError = xerrors.Errorf("example %q tags isn't a slice: type %T", exampleID, tagsRaw)
+					return
+				}
+				for _, tagI := range tagsI {
+					tag, valid := tagI.(string)
+					if !valid {
+						returnError = xerrors.Errorf("example %q tag isn't a string: type %T", exampleID, tagI)
+						return
+					}
+					tags = append(tags, tag)
+				}
+			}
+
+			var icon string
+			iconRaw, exists := frontMatter.FrontMatter["icon"]
+			if exists {
+				icon, valid = iconRaw.(string)
+				if !valid {
+					returnError = xerrors.Errorf("example %q icon isn't a string", exampleID)
+					return
+				}
+			}
+
 			examples = append(examples, codersdk.TemplateExample{
 				ID:          exampleID,
 				URL:         exampleURL,
 				Name:        name,
 				Description: description,
+				Icon:        icon,
+				Tags:        tags,
 				Markdown:    string(frontMatter.Content),
 			})
 		}

diff --git a/examples/examples_test.go b/examples/examples_test.go
@@ -27,6 +27,7 @@ func TestTemplate(t *testing.T) {
 			assert.NotEmpty(t, eg.Name, "example name should not be empty")
 			assert.NotEmpty(t, eg.Description, "example description should not be empty")
 			assert.NotEmpty(t, eg.Markdown, "example markdown should not be empty")
+			assert.NotNil(t, eg.Tags, "example tags should not be nil, should be empty array if no tags")
 			_, err := examples.Archive(eg.ID)
 			assert.NoError(t, err, "error archiving example")
 		})

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -675,6 +675,8 @@ export interface TemplateExample {
   readonly url: string
   readonly name: string
   readonly description: string
+  readonly icon: string
+  readonly tags: string[]
   readonly markdown: string
 }