simplify manifest API

pomdtr · pomdtr · commit ac28eaa5b0c0 · 2024-01-22T17:45:42.000+01:00
diff --git a/extensions/bitwarden.sh b/extensions/bitwarden.sh
@@ -7,7 +7,7 @@ if [ $# -eq 0 ]; then
         preferences: [
             {
                 name: "session",
-                description: "Bitwarden Session",
+                title: "Bitwarden Session",
                 type: "string"
             }
         ],
diff --git a/extensions/brew.sh b/extensions/brew.sh
@@ -16,7 +16,7 @@ if [ $# -eq 0 ]; then
                 params: [
                     {
                         name: "package",
-                        description: "Package Name",
+                        title: "Package Name",
                         type: "string"
                     }
                 ]
diff --git a/extensions/deno-deploy.ts b/extensions/deno-deploy.ts
@@ -9,7 +9,7 @@ const manifest = {
   preferences: [
     {
       name: "token",
-      description: "Access Token",
+      title: "Access Token",
       type: "string",
     },
   ],
@@ -29,14 +29,14 @@ const manifest = {
       title: "List Deployments",
       hidden: true,
       mode: "filter",
-      params: [{ name: "project", description: "Project", type: "string" }],
+      params: [{ name: "project", title: "Project", type: "string" }],
     },
     {
       name: "playground",
       title: "View Playground",
       hidden: true,
       mode: "detail",
-      params: [{ name: "project", description: "Project", type: "string" }],
+      params: [{ name: "project", title: "Project", type: "string" }],
     },
   ],
 } as const satisfies sunbeam.Manifest;
diff --git a/extensions/devdocs.sh b/extensions/devdocs.sh
@@ -18,7 +18,7 @@ if [ $# -eq 0 ]; then
         title: "List Entries from Docset",
         mode: "filter",
         params: [
-          { name: "slug", description: "Slug", type: "string" }
+          { name: "slug", title: "Slug", type: "string" }
         ]
       }
     ]
diff --git a/extensions/files.py b/extensions/files.py
@@ -10,7 +10,7 @@
     "preferences": [
         {
             "name": "show-hidden",
-            "description": "Show Hidden Files",
+            "title": "Show Hidden Files",
             "type": "boolean",
             "optional": True,
         }
@@ -23,7 +23,7 @@
             "params": [
                 {
                     "name": "dir",
-                    "description": "Directory",
+                    "title": "Directory",
                     "type": "string",
                     "optional": True,
                 },
diff --git a/extensions/gists.ts b/extensions/gists.ts
@@ -10,7 +10,7 @@ const manifest = {
   preferences: [
     {
       name: "token",
-      description: "GitHub Personal Access Token",
+      title: "GitHub Personal Access Token",
       type: "string",
     },
   ],
@@ -27,18 +27,18 @@ const manifest = {
       params: [
         {
           name: "filename",
-          description: "Gist Filename",
+          title: "Gist Filename",
           type: "string",
         },
         {
           name: "description",
-          description: "Gist Description",
+          title: "Gist Description",
           optional: true,
           type: "string",
         },
         {
           name: "public",
-          description: "Public",
+          title: "Public",
           type: "boolean",
         },
       ],
@@ -48,16 +48,16 @@ const manifest = {
       title: "Browse Gist Files",
       hidden: true,
       mode: "filter",
-      params: [{ name: "id", description: "Gist ID", type: "string" }],
+      params: [{ name: "id", title: "Gist ID", type: "string" }],
     },
     {
       name: "view",
       title: "View Gist File",
       hidden: true,
       mode: "detail",
       params: [
-        { name: "id", description: "Gist ID", type: "string" },
-        { name: "filename", description: "Filename", type: "string" },
+        { name: "id", title: "Gist ID", type: "string" },
+        { name: "filename", title: "Filename", type: "string" },
       ],
     },
     {
@@ -66,16 +66,16 @@ const manifest = {
       hidden: true,
       mode: "tty",
       params: [
-        { name: "id", description: "Gist ID", type: "string" },
-        { name: "filename", description: "Filename", type: "string" },
+        { name: "id", title: "Gist ID", type: "string" },
+        { name: "filename", title: "Filename", type: "string" },
       ],
     },
     {
       name: "delete",
       hidden: true,
       title: "Delete Gist",
       mode: "silent",
-      params: [{ name: "id", description: "Gist ID", type: "string" }],
+      params: [{ name: "id", title: "Gist ID", type: "string" }],
     },
   ],
 } as const satisfies sunbeam.Manifest;
diff --git a/extensions/github.ts b/extensions/github.ts
@@ -9,7 +9,7 @@ const manifest = {
   preferences: [
     {
       name: "token",
-      description: "Personal Access Token",
+      title: "Personal Access Token",
       type: "string",
     },
   ],
@@ -27,7 +27,7 @@ const manifest = {
       params: [
         {
           name: "repo",
-          description: "Repository Name",
+          title: "Repository Name",
           type: "string",
         },
       ],
@@ -40,7 +40,7 @@ const manifest = {
       params: [
         {
           name: "repo",
-          description: "Repository Name",
+          title: "Repository Name",
           type: "string",
         },
       ],
@@ -53,7 +53,7 @@ const manifest = {
       params: [
         {
           name: "repo",
-          description: "Repository Name",
+          title: "Repository Name",
           type: "string",
         },
       ],
diff --git a/extensions/hackernews.ts b/extensions/hackernews.ts
@@ -12,7 +12,7 @@ const manifest = {
       name: "browse",
       title: "Show a feed",
       mode: "filter",
-      params: [{ name: "topic", description: "Topic", type: "string" }],
+      params: [{ name: "topic", title: "Topic", type: "string" }],
     },
   ],
 } as const satisfies sunbeam.Manifest;
diff --git a/extensions/nixpkgs.ts b/extensions/nixpkgs.ts
@@ -4,6 +4,7 @@ import * as sunbeam from "https://deno.land/x/sunbeam/mod.ts";
 
 const manifest = {
   title: "Nixpkgs Search",
+  description: "Search Nixpkgs packages",
   commands: [
     {
       name: "search",
diff --git a/extensions/npm.ts b/extensions/npm.ts
@@ -3,6 +3,7 @@ import * as sunbeam from "https://deno.land/x/sunbeam/mod.ts";
 
 const manifest: sunbeam.Manifest = {
   title: "NPM Search",
+  description: "Search NPM packages",
   commands: [
     {
       name: "search",
diff --git a/extensions/raindrop.ts b/extensions/raindrop.ts
@@ -7,7 +7,7 @@ const manifest = {
   preferences: [
     {
       name: "token",
-      description: "Raindrop API Token",
+      title: "Raindrop API Token",
       type: "string",
     },
   ],
diff --git a/extensions/rss.ts b/extensions/rss.ts
@@ -15,7 +15,7 @@ const manifest = {
       params: [
         {
           name: "url",
-          description: "URL",
+          title: "URL",
           type: "string",
         },
       ],
diff --git a/extensions/tailscale.ts b/extensions/tailscale.ts
@@ -17,7 +17,7 @@ const manifest = {
       params: [
         {
           name: "ip",
-          description: "Device IP",
+          title: "Device IP",
           type: "string",
         },
       ],
diff --git a/extensions/tldr.sh b/extensions/tldr.sh
@@ -13,7 +13,7 @@ if [ $# -eq 0 ]; then
     # each command can be called through the cli
     commands: [
         { name: "list", mode: "filter", title: "Search Pages" },
-        { name: "view", mode: "detail", hidden: true, title: "View page", params: [{ name: "page", type: "string", description: "page to show" }] },
+        { name: "view", mode: "detail", hidden: true, title: "View page", params: [{ name: "page", type: "string", title: "Page to show" }] },
         { name: "update", mode: "silent", title: "Update cache" }
     ]
 }'
diff --git a/extensions/valtown.ts b/extensions/valtown.ts
@@ -8,7 +8,7 @@ const manifest = {
   preferences: [
     {
       name: "token",
-      description: "Access Token",
+      title: "Access Token",
       type: "string",
     },
   ],
@@ -19,7 +19,7 @@ const manifest = {
       mode: "filter",
       params: [{
         name: "user",
-        description: "User",
+        title: "User",
         optional: true,
         type: "string",
       }],
@@ -34,14 +34,14 @@ const manifest = {
       name: "edit",
       hidden: true,
       mode: "tty",
-      params: [{ name: "id", description: "Val ID", type: "string" }],
+      params: [{ name: "id", title: "Val ID", type: "string" }],
     },
     {
       title: "View Readme",
       name: "readme",
       hidden: true,
       mode: "detail",
-      params: [{ name: "id", description: "Val ID", type: "string" }],
+      params: [{ name: "id", title: "Val ID", type: "string" }],
     },
   ],
 } as const satisfies sunbeam.Manifest;
diff --git a/internal/cli/custom.go b/internal/cli/custom.go
@@ -163,11 +163,11 @@ func NewSubCmdCustom(alias string, extension extensions.Extension, extensionConf
 	for _, input := range command.Params {
 		switch input.Type {
 		case sunbeam.InputString:
-			cmd.Flags().String(input.Name, "", input.Description)
+			cmd.Flags().String(input.Name, "", input.Title)
 		case sunbeam.InputBoolean:
-			cmd.Flags().Bool(input.Name, false, input.Description)
+			cmd.Flags().Bool(input.Name, false, input.Title)
 		case sunbeam.InputNumber:
-			cmd.Flags().Int(input.Name, 0, input.Description)
+			cmd.Flags().Int(input.Name, 0, input.Title)
 		}
 
 		if !input.Optional {
diff --git a/internal/schemas/manifest.schema.json b/internal/schemas/manifest.schema.json
@@ -65,27 +65,21 @@
             "type": "object",
             "required": [
                 "name",
-                "description",
+                "title",
                 "type"
             ],
             "properties": {
                 "name": {
                     "type": "string"
                 },
-                "description": {
+                "title": {
                     "type": "string"
                 },
                 "type": {
-                    "oneOf": [
-                        {
-                            "type": "string"
-                        },
-                        {
-                            "type": "boolean"
-                        },
-                        {
-                            "type": "number"
-                        }
+                    "enum": [
+                        "string",
+                        "boolean",
+                        "number"
                     ]
                 },
                 "optional": {
diff --git a/internal/tui/input.go b/internal/tui/input.go
@@ -56,7 +56,7 @@ func NewTextField(input sunbeam.Input, secure bool) *TextField {
 		name:        input.Name,
 		title:       input.Name,
 		Model:       ti,
-		placeholder: input.Description,
+		placeholder: input.Title,
 	}
 }
 
@@ -140,11 +140,11 @@ func NewTextArea(input sunbeam.Input) Input {
 		}
 	}
 
-	ta.Placeholder = input.Description
+	ta.Placeholder = input.Title
 	ta.SetHeight(5)
 
 	return &TextArea{
-		title: input.Description,
+		title: input.Title,
 		name:  input.Name,
 		Model: ta,
 	}
@@ -205,7 +205,7 @@ type Checkbox struct {
 func NewCheckbox(param sunbeam.Input) *Checkbox {
 	checkbox := Checkbox{
 		name:  param.Name,
-		title: param.Description,
+		title: param.Title,
 	}
 
 	if param.Default != nil {
@@ -214,7 +214,7 @@ func NewCheckbox(param sunbeam.Input) *Checkbox {
 		}
 	}
 
-	checkbox.label = param.Description
+	checkbox.label = param.Title
 
 	return &checkbox
 }
diff --git a/pkg/sunbeam/manifest.go b/pkg/sunbeam/manifest.go
@@ -46,9 +46,9 @@ const (
 )
 
 type Input struct {
-	Type        InputType `json:"type"`
-	Name        string    `json:"name"`
-	Description string    `json:"description"`
-	Optional    bool      `json:"optional,omitempty"`
-	Default     any       `json:"default,omitempty"`
+	Type     InputType `json:"type"`
+	Name     string    `json:"name"`
+	Title    string    `json:"title"`
+	Optional bool      `json:"optional,omitempty"`
+	Default  any       `json:"default,omitempty"`
 }
diff --git a/pkg/typescript/src/manifest.ts b/pkg/typescript/src/manifest.ts
diff --git a/scripts/build-catalog.ts b/scripts/build-catalog.ts
diff --git a/scripts/build-config.ts b/scripts/build-config.ts
diff --git a/www/website/catalog/index.md b/www/website/catalog/index.md
diff --git a/www/website/docs/developer-guide/examples/devdocs.md b/www/website/docs/developer-guide/examples/devdocs.md
diff --git a/www/website/docs/reference/schemas/manifest.md b/www/website/docs/reference/schemas/manifest.md

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ if [ $# -eq 0 ]; then`
`7`	`7`	`preferences: [`
`8`	`8`	`{`
`9`	`9`	`name: "session",`
`10`		`- description: "Bitwarden Session",`
	`10`	`+ title: "Bitwarden Session",`
`11`	`11`	`type: "string"`
`12`	`12`	`}`
`13`	`13`	`],`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ if [ $# -eq 0 ]; then`
`16`	`16`	`params: [`
`17`	`17`	`{`
`18`	`18`	`name: "package",`
`19`		`- description: "Package Name",`
	`19`	`+ title: "Package Name",`
`20`	`20`	`type: "string"`
`21`	`21`	`}`
`22`	`22`	`]`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ if [ $# -eq 0 ]; then`
`18`	`18`	`title: "List Entries from Docset",`
`19`	`19`	`mode: "filter",`
`20`	`20`	`params: [`
`21`		`- { name: "slug", description: "Slug", type: "string" }`
	`21`	`+ { name: "slug", title: "Slug", type: "string" }`
`22`	`22`	`]`
`23`	`23`	`}`
`24`	`24`	`]`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"preferences": [`
`11`	`11`	`{`
`12`	`12`	`"name": "show-hidden",`
`13`		`- "description": "Show Hidden Files",`
	`13`	`+ "title": "Show Hidden Files",`
`14`	`14`	`"type": "boolean",`
`15`	`15`	`"optional": True,`
`16`	`16`	`}`
`@@ -23,7 +23,7 @@`
`23`	`23`	`"params": [`
`24`	`24`	`{`
`25`	`25`	`"name": "dir",`
`26`		`- "description": "Directory",`
	`26`	`+ "title": "Directory",`
`27`	`27`	`"type": "string",`
`28`	`28`	`"optional": True,`
`29`	`29`	`},`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import * as sunbeam from "https://deno.land/x/sunbeam/mod.ts";`
`4`	`4`
`5`	`5`	`const manifest = {`
`6`	`6`	`title: "Nixpkgs Search",`
	`7`	`+ description: "Search Nixpkgs packages",`
`7`	`8`	`commands: [`
`8`	`9`	`{`
`9`	`10`	`name: "search",`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import * as sunbeam from "https://deno.land/x/sunbeam/mod.ts";`
`3`	`3`
`4`	`4`	`const manifest: sunbeam.Manifest = {`
`5`	`5`	`title: "NPM Search",`
	`6`	`+ description: "Search NPM packages",`
`6`	`7`	`commands: [`
`7`	`8`	`{`
`8`	`9`	`name: "search",`