swiftbar-github 1.0.0 → 1.1.0

package/README.md

@@ -17,3 +17,5 @@ Download [swiftbar-github.3m.sh](https://cdn.jsdelivr.net/npm/swiftbar-github@la
 Run `chmod +x swiftbar-github.3m.sh`. Updates resolve through `@latest` on each refresh; downloaded versions are cached. For authentication without `gh`, set `GH_TOKEN` or `GITHUB_TOKEN` in SwiftBar's environment.
 
 Allow notifications for the bundled terminal-notifier in macOS System Settings. Click entries to open them on GitHub.
+
+Use **Mark as read** to clear unread threads by type or reason. This does not complete pending review requests. Option-click the menu to access SwiftBar's hidden controls.

package/assets/github.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-  <path d="M12 .5C5.65.5.5 5.65.5 12c0 5.08 3.29 9.39 7.86 10.91.58.11.79-.25.79-.56v-2.14c-3.2.7-3.88-1.36-3.88-1.36-.52-1.33-1.28-1.68-1.28-1.68-1.04-.71.08-.7.08-.7 1.15.08 1.75 1.18 1.75 1.18 1.02 1.75 2.69 1.24 3.34.95.1-.74.4-1.24.73-1.53-2.55-.29-5.23-1.28-5.23-5.69 0-1.25.45-2.28 1.18-3.08-.12-.29-.51-1.46.11-3.04 0 0 .96-.31 3.16 1.18a11 11 0 0 1 5.75 0c2.2-1.49 3.16-1.18 3.16-1.18.62 1.58.23 2.75.11 3.04.73.8 1.18 1.83 1.18 3.08 0 4.42-2.69 5.4-5.25 5.68.41.36.78 1.06.78 2.14v3.17c0 .31.21.67.79.56A11.5 11.5 0 0 0 23.5 12C23.5 5.65 18.35.5 12 .5z"/>
+  <path transform="translate(4 4)" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27s1.36.09 2 .27c1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"/>
 </svg>

package/dist/swiftbar-github.js

@@ -83,13 +83,14 @@ function notify(item) {
         notifier.notify(notification, (error) => resolve(!error));
     });
 }
-function action(label, argument) {
+function action(label, args, refresh = false) {
     if (!launcher)
         return `${label} | href=${inbox}`;
-    return `${label} | bash="${launcher.replaceAll('"', '\\"')}" param1=${argument} terminal=false`;
+    const params = args.map((arg, index) => `param${index + 1}=${arg}`).join(" ");
+    return `${label} | bash="${launcher.replaceAll('"', '\\"')}" ${params} terminal=false${refresh ? " refresh=true" : ""}`;
 }
-async function fetchActivity(argument) {
-    const github = new Octokit({
+async function client() {
+    return new Octokit({
         auth: await token(),
         userAgent: "swiftbar-github",
         request: {
@@ -103,6 +104,9 @@ async function fetchActivity(argument) {
         },
         log: { debug() { }, info() { }, warn() { }, error() { } },
     });
+}
+async function fetchActivity(argument) {
+    const github = await client();
     const { data: user } = await github.rest.users.getAuthenticated();
     const requested = await github.paginate(github.rest.search.issuesAndPullRequests, {
         q: `is:pr is:open archived:false review-requested:${user.login}`,
@@ -127,7 +131,7 @@ async function fetchActivity(argument) {
         };
     });
     if (argument === "open-reviews")
-        return { reviews, notifications: [] };
+        return { reviews, notifications: [], unread: [] };
     const reviewURLs = new Set(reviews.map((item) => item.url));
     const unread = await github.paginate(github.rest.activity.listNotificationsForAuthenticatedUser, {
         all: false,
@@ -151,21 +155,21 @@ async function fetchActivity(argument) {
             reason,
         };
     });
-    return { reviews, notifications };
+    return { reviews, notifications, unread };
 }
-function renderMenu(reviews, notifications) {
+function renderMenu(reviews, notifications, unread) {
     const total = reviews.length + notifications.length;
     if (!total)
         return "";
     const menu = [
-        `${total} | templateImage=${icon}`,
+        `${process.env.SWIFTBAR_GITHUB_DEV ? "Dev " : ""}${total} | templateImage=${icon}`,
         "---",
         `Review requests (${reviews.length}) | color=gray`,
     ];
     if (reviews.length) {
         for (const item of reviews)
             menu.push(`${item.repository} ${item.title} | href=${item.url}`);
-        menu.push(action("Open all review requests", "open-reviews"));
+        menu.push(action("Open all review requests", ["open-reviews"]));
     }
     else
         menu.push("No reviews requested | color=gray");
@@ -173,37 +177,89 @@ function renderMenu(reviews, notifications) {
     if (notifications.length) {
         for (const item of notifications)
             menu.push(`${item.repository} [${item.reason}]: ${item.title} | href=${item.url}`);
-        menu.push(action("Open all notifications", "open-notifications"));
+        menu.push(action("Open all notifications", ["open-notifications"]));
     }
     else
         menu.push("No unread notifications | color=gray");
+    if (unread.length) {
+        const types = {
+            PullRequest: "Pull requests",
+            Issue: "Issues",
+            Discussion: "Discussions",
+            Commit: "Commits",
+            Release: "Releases",
+        };
+        menu.push("---", "Mark as read");
+        menu.push(`--${action(`All notifications (${unread.length})`, ["mark-read", unread.map((item) => item.id).join(",")], true)}`);
+        for (const [heading, labelFor] of [
+            [
+                "By type",
+                (item) => text(types[item.subject.type] || item.subject.type),
+            ],
+            [
+                "By reason",
+                (item) => text(item.reason).replaceAll("_", " "),
+            ],
+        ]) {
+            const groups = new Map();
+            for (const item of unread) {
+                const label = labelFor(item);
+                const ids = groups.get(label) || [];
+                ids.push(item.id);
+                groups.set(label, ids);
+            }
+            menu.push("-----", `--${heading} | color=gray`);
+            for (const [label, ids] of [...groups].sort(([a], [b]) => a.localeCompare(b)))
+                menu.push(`--${action(`${label} (${ids.length})`, ["mark-read", ids.join(",")], true)}`);
+        }
+    }
     return menu.join("\n");
 }
-async function deliverAlerts(file, items) {
+async function deliverAlerts(file, items, represented = []) {
     await mkdir(cache, { recursive: true });
     const path = join(cache, file);
     const seen = await state(path);
-    const current = [];
+    const current = new Set(represented);
     for (const item of items) {
+        if (current.has(item.key))
+            continue;
         if (!seen || seen.has(item.key) || (await notify(item)))
-            current.push(item.key);
+            current.add(item.key);
     }
-    await save(path, current);
+    await save(path, [...current]);
 }
 async function main() {
     const argument = process.argv[2];
-    if (argument && !["open-reviews", "open-notifications"].includes(argument))
+    if (argument &&
+        !["open-reviews", "open-notifications", "mark-read"].includes(argument))
         throw new Error("Usage: swiftbar-github");
-    const { reviews, notifications } = await fetchActivity(argument);
+    if (argument === "mark-read") {
+        const ids = (process.argv[3] || "").split(",").map(Number);
+        if (ids.some((id) => !Number.isSafeInteger(id) || id <= 0))
+            throw new Error("Usage: swiftbar-github mark-read <thread-ids>");
+        const github = await client();
+        for (const id of ids)
+            await github.rest.activity.markThreadAsRead({ thread_id: id });
+        return;
+    }
+    const { reviews, notifications, unread } = await fetchActivity(argument);
     if (argument) {
         const items = argument === "open-reviews" ? reviews : notifications;
         for (const item of items)
             await exec("/usr/bin/open", ["-g", item.url]);
         return;
     }
-    const menu = renderMenu(reviews, notifications);
+    const menu = renderMenu(reviews, notifications, unread);
+    const previousReviews = await state(join(cache, "requested-prs"));
+    const reviewURLs = new Set([
+        ...reviews.map((item) => item.url),
+        ...(previousReviews || []),
+    ]);
+    const represented = unread
+        .filter((item) => item.reason === "review_requested" && reviewURLs.has(webURL(item)))
+        .map((item) => `${item.id}:${item.updated_at}`);
     await deliverAlerts("requested-prs", reviews);
-    await deliverAlerts("inbox-notifications", notifications);
+    await deliverAlerts("inbox-notifications", notifications, represented);
     if (menu)
         console.log(menu);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "swiftbar-github",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"description": "GitHub notifications and review requests in the macOS menu bar",
 	"license": "MIT",
 	"repository": "github:jryom/swiftbar-github",

package/swiftbar-github.3m.sh

@@ -1,4 +1,9 @@
 #!/bin/bash
+# <swiftbar.hideAbout>true</swiftbar.hideAbout>
+# <swiftbar.hideRunInTerminal>true</swiftbar.hideRunInTerminal>
+# <swiftbar.hideLastUpdated>true</swiftbar.hideLastUpdated>
+# <swiftbar.hideDisablePlugin>true</swiftbar.hideDisablePlugin>
+# <swiftbar.hideSwiftBar>true</swiftbar.hideSwiftBar>
 
 if output=$(npx --yes swiftbar-github@latest "$@" 2>/dev/null); then
   [[ -z "$output" ]] || printf '%s\n' "$output"