feat: format display attributes on GitifyNotification

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

src/renderer/utils/notifications/formatters.ts

@@ -49,13 +49,22 @@ export function formatNotificationType(
   ]);
 }
 
+/**
+ * Return the formatted (issue, pull request, discussion) number for this notification.
+ */
+export function formatGitHubNumber(num: number): string {
+  return `#${num}`;
+}
+
 /**
  * Return the formatted notification number for this notification.
  */
 export function formatNotificationNumber(
   notification: GitifyNotification,
 ): string {
-  return notification.subject?.number ? `#${notification.subject.number}` : '';
+  return notification.subject?.number
+    ? formatGitHubNumber(notification.subject.number)
+    : '';
 }
 
 /**

src/renderer/utils/notifications/handlers/pullRequest.ts

@@ -23,6 +23,7 @@ import type {
   PullRequestDetailsFragment,
   PullRequestReviewFieldsFragment,
 } from '../../api/graphql/generated/graphql';
+import { formatGitHubNumber } from '../formatters';
 import { DefaultHandler, defaultHandler } from './default';
 import { getNotificationAuthor } from './utils';
 
@@ -60,8 +61,8 @@ class PullRequestHandler extends DefaultHandler {
       reviews: reviews,
       commentCount: pr.comments.totalCount,
       labels: pr.labels?.nodes.map((label) => label.name) ?? [],
-      linkedIssues: pr.closingIssuesReferences?.nodes.map(
-        (issue) => `#${issue.number}`,
+      linkedIssues: pr.closingIssuesReferences?.nodes.map((issue) =>
+        formatGitHubNumber(issue.number),
       ),
       milestone: pr.milestone,
       htmlUrl: prComment?.url ?? pr.url,

src/renderer/utils/notifications/notifications.ts

@@ -67,6 +67,15 @@ function getNotifications(state: GitifyState) {
 /**
  * Get all notifications for all accounts.
  *
+ * Notifications follow these stages:
+ *  - Fetch / retrieval
+ *  - Transform
+ *  - Base filtering
+ *  - Enrichment
+ *  - Detailed filtering
+ *  - Formatting
+ *  - Ordering
+ *
  * @param state - The Gitify state.
  * @returns A promise that resolves to an array of account notifications.
  */