add requirements param in manifest

pomdtr · Nov 6, 2023 · 0956323 · 0956323
1 parent 793bb88
commit 0956323
Show file tree

Hide file tree

Showing 21 changed files with 241 additions and 56 deletions.
diff --git a/cmd/custom.go b/cmd/custom.go
@@ -154,6 +154,10 @@ func NewCmdCustom(alias string, extension extensions.Extension) (*cobra.Command,
 }
 
 func runExtension(extension extensions.Extension, input types.CommandInput, env map[string]string) error {
+	if err := extension.CheckRequirements(); err != nil {
+		return tui.Draw(tui.NewErrorPage(fmt.Errorf("missing requirements: %w", err)))
+	}
+
 	command, ok := extension.Command(input.Command)
 	if !ok {
 		return fmt.Errorf("command %s not found", input.Command)

diff --git a/docs/catalog.md b/docs/catalog.md
@@ -23,6 +23,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Browse files and folders
 
+### Requirements
+
+- [`python`](https://www.python.org/)
+
 ### Commands
 
 - `ls`: List files
@@ -37,6 +41,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Pipe your clipboard through various commands
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `urldecode`: URL Decode Clipboard
@@ -50,7 +58,11 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 ## [GitHub](https://github.com/pomdtr/sunbeam/tree/main/extensions/github.ts)
 
-undefined
+Search GitHub repositories
+
+### Requirements
+
+- [`deno`](https://deno.com)
 
 ### Commands
 
@@ -69,6 +81,11 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Manage your tailscale devices
 
+### Requirements
+
+- [`deno`](https://deno.com)
+- [`tailscale`](https://tailscale.com)
+
 ### Commands
 
 - `list-devices`: Search My Devices
@@ -100,6 +117,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Manage your gists
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `list`: List Gists
@@ -115,7 +136,11 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 ## [Bitwarden Vault](https://github.com/pomdtr/sunbeam/tree/main/extensions/bitwarden.sh)
 
-List your Bitwarden passwords
+Search your Bitwarden passwords
+
+### Requirements
+
+- [`bw`](https://bitwarden.com/help/article/cli/)
 
 ### Commands
 
@@ -131,6 +156,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Manage your VS Code projects
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `list-projects`: List Projects
@@ -176,6 +205,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Browse TLDR Pages
 
+### Requirements
+
+- [`tldr`](https://dbrgn.github.io/tealdeer/installing.html)
+
 ### Commands
 
 - `list`: Search Pages
@@ -207,6 +240,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Manage your RSS feeds
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `show`: Show a feed
@@ -221,6 +258,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Browse Hacker News
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `browse`: Show a feed
@@ -250,6 +291,10 @@ sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/
 
 Manage your raindrop bookmarks
 
+### Requirements
+
+- [`deno`](https://deno.com)
+
 ### Commands
 
 - `search-bookmarks`: Search Bookmarks
@@ -259,4 +304,3 @@ Manage your raindrop bookmarks
 ```
 sunbeam extension install https://raw.githubusercontent.com/pomdtr/sunbeam/main/extensions/raindrop.ts
 ```
-
diff --git a/extensions/bitwarden.sh b/extensions/bitwarden.sh
@@ -3,7 +3,10 @@
 if [ $# -eq 0 ]; then
     sunbeam query -n '{
         title: "Bitwarden Vault",
-        description: "List your Bitwarden passwords",
+        description: "Search your Bitwarden passwords",
+        requirements: [
+            { name: "bw", link: "https://bitwarden.com/help/article/cli/" }
+        ],
         commands: [
             {
                 name: "list-passwords",
@@ -15,20 +18,14 @@ if [ $# -eq 0 ]; then
     exit 0
 fi
 
-# check for dependencies
-if ! command -v bkt &> /dev/null; then
-    echo "bkt could not be found"
-    exit 1
-fi
-
-if ! command -v bw &> /dev/null; then
-    echo "bw could not be found"
+if [ -z "$BW_SESSION" ]; then
+    echo "Please set BW_SESSION environment variable"
     exit 1
 fi
 
 COMMAND=$(echo "$1" | jq -r '.command')
 if [ "$COMMAND" = "list-passwords" ]; then
-    bkt --ttl 24h --stale 1h -- bw --nointeraction list items --session "$BW_SESSION" | sunbeam query 'map({
+    bw --nointeraction list items --session "$BW_SESSION" | sunbeam query 'map({
         title: .name,
         subtitle: (.login.username // ""),
         actions: [

diff --git a/extensions/files.py b/extensions/files.py
@@ -9,6 +9,7 @@
         {
             "title": "File Browser",
             "description": "Browse files and folders",
+            "requirements": [{"name": "python", "link": "https://www.python.org/"}],
             "commands": [
                 {
                     "name": "ls",

diff --git a/extensions/gist.ts b/extensions/gist.ts
@@ -1,12 +1,18 @@
 #!/usr/bin/env deno run -A
 
 import { Octokit } from "https://esm.sh/[email protected]?dts";
-import * as sunbeam from "npm:[email protected].18"
+import * as sunbeam from "npm:[email protected].19"
 
 if (Deno.args.length === 0) {
     const manifest: sunbeam.Manifest = {
         title: "Gist",
         description: "Manage your gists",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         commands: [
             {
                 name: "list",

diff --git a/extensions/github.ts b/extensions/github.ts
@@ -1,11 +1,18 @@
 #!/usr/bin/env deno run -A
 
-import type * as sunbeam from "npm:[email protected].18";
+import type * as sunbeam from "npm:[email protected].19";
 import * as base64 from "https://deno.land/[email protected]/encoding/base64.ts";
 
 if (Deno.args.length == 0) {
     const manifest: sunbeam.Manifest = {
         title: "GitHub",
+        description: "Search GitHub repositories",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         commands: [
             {
                 title: "Search Repositories",

diff --git a/extensions/hackernews.ts b/extensions/hackernews.ts
@@ -2,12 +2,18 @@
 
 import Parser from "npm:rss-parser";
 import { formatDistance } from "npm:date-fns";
-import * as sunbeam from "npm:[email protected].15"
+import * as sunbeam from "npm:[email protected].19"
 
 if (Deno.args.length == 0) {
     const manifest: sunbeam.Manifest = {
         title: "Hacker News",
         description: "Browse Hacker News",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         root: [
             {
                 title: "Front Page",
@@ -40,7 +46,7 @@ if (Deno.args.length == 0) {
     Deno.exit(0);
 }
 
-const payload = JSON.parse(Deno.args[0]) as sunbeam.CommandInput;
+const payload = JSON.parse(Deno.args[0]) as sunbeam.Payload;
 if (payload.command == "browse") {
     const { topic } = payload.params as { topic: string };
     const feed = await new Parser().parseURL(`https://hnrss.org/${topic}?description=0&count=25`);

diff --git a/extensions/pipe.ts b/extensions/pipe.ts
@@ -1,12 +1,18 @@
 #!/usr/bin/env deno run -A
-import * as sunbeam from "npm:[email protected].16"
+import * as sunbeam from "npm:[email protected].19"
 import * as clipboard from "https://deno.land/x/[email protected]/mod.ts";
 
 
 if (Deno.args.length == 0) {
     const manifest: sunbeam.Manifest = {
         title: "Pipe Commands",
         description: "Pipe your clipboard through various commands",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         commands: [
             {
                 name: "urldecode",

diff --git a/extensions/raindrop.ts b/extensions/raindrop.ts
@@ -1,10 +1,16 @@
 #!/usr/bin/env -S deno run -A
-import * as sunbeam from "npm:[email protected].15"
+import * as sunbeam from "npm:[email protected].19"
 
 if (Deno.args.length === 0) {
     const manifest: sunbeam.Manifest = {
         title: "Raindrop",
         description: "Manage your raindrop bookmarks",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         commands: [
             {
                 title: "Search Bookmarks",
@@ -22,7 +28,7 @@ if (!raindropToken) {
     throw new Error("RAINDROP_TOKEN is not set");
 }
 
-const payload = JSON.parse(Deno.args[0]) as sunbeam.CommandInput;
+const payload = JSON.parse(Deno.args[0]) as sunbeam.Payload;
 if (payload.command == "search-bookmarks") {
     const resp = await fetch("https://api.raindrop.io/rest/v1/raindrops/0", {
         headers: {

diff --git a/extensions/rss.ts b/extensions/rss.ts
@@ -2,12 +2,18 @@
 
 import Parser from "npm:rss-parser";
 import { formatDistance } from "npm:date-fns";
-import * as sunbeam from "npm:[email protected].15"
+import * as sunbeam from "npm:[email protected].19"
 
 if (Deno.args.length == 0) {
     const manifest: sunbeam.Manifest = {
         title: "RSS",
         description: "Manage your RSS feeds",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            }
+        ],
         commands: [
             {
                 name: "show",
@@ -29,7 +35,7 @@ if (Deno.args.length == 0) {
     Deno.exit(0);
 }
 
-const payload = JSON.parse(Deno.args[0]) as sunbeam.CommandInput;
+const payload = JSON.parse(Deno.args[0]) as sunbeam.Payload;
 if (payload.command == "show") {
     const params = payload.params as { url: string };
     const feed = await new Parser().parseURL(params.url);

diff --git a/extensions/tailscale.ts b/extensions/tailscale.ts
@@ -1,10 +1,20 @@
 #!/usr/bin/env -S deno run -A
-import type * as sunbeam from "npm:[email protected].15";
+import type * as sunbeam from "npm:[email protected].19";
 
 if (Deno.args.length == 0) {
     const manifest: sunbeam.Manifest = {
         title: "Tailscale",
         description: "Manage your tailscale devices",
+        requirements: [
+            {
+                name: "deno",
+                link: "https://deno.com"
+            },
+            {
+                name: "tailscale",
+                link: "https://tailscale.com"
+            }
+        ],
         commands: [
             {
                 name: "list-devices",
@@ -38,7 +48,7 @@ type Device = {
     Online: boolean;
 }
 
-const payload = JSON.parse(Deno.args[0]) as sunbeam.CommandInput;
+const payload = JSON.parse(Deno.args[0]) as sunbeam.Payload;
 
 if (payload.command == "list-devices") {
     const command = new Deno.Command("tailscale", { args: ["status", "--json"] });

diff --git a/extensions/tldr.sh b/extensions/tldr.sh
@@ -10,6 +10,9 @@ if [ $# -eq 0 ]; then
 {
     title: "Browse TLDR Pages",
     description: "Browse TLDR Pages",
+    requirements: [
+        { name: "tldr", link: "https://dbrgn.github.io/tealdeer/installing.html" }
+    ],
     # each command can be called through the cli
     commands: [
         { name: "list", mode: "list", title: "Search Pages" },
@@ -19,12 +22,6 @@ if [ $# -eq 0 ]; then
 exit 0
 fi
 
-# check if tldr is installed
-if ! command -v tldr >/dev/null 2>&1; then
-    echo "tldr is not installed. Please install it from https://dbrgn.github.io/tealdeer/installing.html"
-    exit 1
-fi
-
 COMMAND=$(echo "$1" | jq -r '.command')
 if [ "$COMMAND" = "list" ]; then
     tldr --list | sunbeam query -R '{