refactor: shared app name

setchy · setchy · commit 4d1a2416416b · 2025-01-20T07:23:23.000-05:00
Signed-off-by: Adam Setch &lt;adam.setch@outlook.com&gt;
diff --git a/src/main/menu.ts b/src/main/menu.ts
@@ -79,7 +79,7 @@ export default class MenuBuilder {
             click: () => openLogsDirectory(),
           },
           {
-            label: 'Reset App',
+            label: `Reset ${APPLICATION.NAME}`,
             click: () => {
               resetApp(this.menubar);
             },
@@ -88,7 +88,7 @@ export default class MenuBuilder {
       },
       { type: 'separator' },
       {
-        label: 'Quit Gitify',
+        label: `Quit ${APPLICATION.NAME}`,
         accelerator: 'CommandOrControl+Q',
         click: () => {
           this.menubar.app.quit();
diff --git a/src/main/utils.ts b/src/main/utils.ts
@@ -5,14 +5,18 @@ import { dialog, shell } from 'electron';
 import log from 'electron-log';
 import type { Menubar } from 'menubar';
 
+import { APPLICATION } from '../shared/constants';
 import { namespacedEvent } from '../shared/events';
 import { logError, logInfo } from '../shared/logger';
 
 export function takeScreenshot(mb: Menubar) {
   const date = new Date();
   const dateStr = date.toISOString().replace(/:/g, '-');
 
-  const capturedPicFilePath = `${os.homedir()}/${dateStr}-gitify-screenshot.png`;
+  const capturedPicFilePath = path.join(
+    os.homedir(),
+    `${dateStr}-${APPLICATION.NAME}-screenshot.png`,
+  );
   mb.window.capturePage().then((img) => {
     fs.writeFile(capturedPicFilePath, img.toPNG(), () =>
       logInfo('takeScreenshot', `Screenshot saved ${capturedPicFilePath}`),
@@ -26,9 +30,8 @@ export function resetApp(mb: Menubar) {
 
   const response = dialog.showMessageBoxSync(mb.window, {
     type: 'warning',
-    title: 'Reset Gitify',
-    message:
-      'Are you sure you want to reset Gitify? You will be logged out of all accounts',
+    title: `Reset ${APPLICATION.NAME}`,
+    message: `Are you sure you want to reset ${APPLICATION.NAME}? You will be logged out of all accounts`,
     buttons: ['Cancel', 'Reset'],
     defaultId: cancelButtonId,
     cancelId: cancelButtonId,
diff --git a/src/renderer/components/Sidebar.tsx b/src/renderer/components/Sidebar.tsx
@@ -9,6 +9,7 @@ import {
 } from '@primer/octicons-react';
 import { type FC, useContext, useMemo } from 'react';
 import { useLocation, useNavigate } from 'react-router-dom';
+import { APPLICATION } from '../../shared/constants';
 import { AppContext } from '../context/App';
 import { Size } from '../types';
 import { quitApp } from '../utils/comms';
@@ -79,7 +80,7 @@ export const Sidebar: FC = () => {
           title="Home"
           onClick={() => navigate('/', { replace: true })}
         >
-          <LogoIcon size={Size.SMALL} aria-label="Open Gitify" />
+          <LogoIcon size={Size.SMALL} aria-label={`Open ${APPLICATION.NAME}`} />
         </button>
 
         <SidebarButton
@@ -133,7 +134,7 @@ export const Sidebar: FC = () => {
 
         {!isLoggedIn && (
           <SidebarButton
-            title="Quit Gitify"
+            title={`Quit ${APPLICATION.NAME}`}
             icon={XCircleIcon}
             size={Size.MEDIUM}
             onClick={() => quitApp()}
diff --git a/src/renderer/components/icons/LogoIcon.tsx b/src/renderer/components/icons/LogoIcon.tsx
@@ -1,4 +1,5 @@
 import type { FC } from 'react';
+import { APPLICATION } from '../../../shared/constants';
 import { Size } from '../../types';
 import { cn } from '../../utils/cn';
 
@@ -31,7 +32,7 @@ export const LogoIcon: FC<ILogoIcon> = ({
     xmlnsXlink="https://www.w3.org/1999/xlink"
     viewBox="0 0 500 500"
     role="img"
-    aria-label="Gitify Logo"
+    aria-label={`${APPLICATION.NAME} Logo`}
     {...props}
   >
     <defs>
diff --git a/src/renderer/components/settings/NotificationSettings.tsx b/src/renderer/components/settings/NotificationSettings.tsx
@@ -1,5 +1,6 @@
 import { BellIcon } from '@primer/octicons-react';
 import { type FC, type MouseEvent, useContext } from 'react';
+import { APPLICATION } from '../../../shared/constants';
 import { AppContext } from '../../context/App';
 import { GroupBy } from '../../types';
 import { openGitHubParticipatingDocs } from '../../utils/links';
@@ -106,9 +107,9 @@ export const NotificationSettings: FC = () => {
         }
         tooltip={
           <div>
-            Keep the notification within Gitify window upon interaction (click,
-            mark as read, mark as done, etc) until the next refresh window
-            (scheduled or user initiated).
+            Keep the notification within {APPLICATION.NAME} upon interaction
+            (ie: open notification, mark as read, mark as done) until the next
+            refresh window (scheduled or user initiated).
           </div>
         }
       />
diff --git a/src/renderer/components/settings/SettingsFooter.test.tsx b/src/renderer/components/settings/SettingsFooter.test.tsx
@@ -98,7 +98,7 @@ describe('renderer/routes/components/settings/SettingsFooter.tsx', () => {
       );
     });
 
-    fireEvent.click(screen.getByTitle('View release notes'));
+    fireEvent.click(screen.getByTitle('View Gitify release notes'));
 
     expect(openExternalLinkMock).toHaveBeenCalledTimes(1);
     expect(openExternalLinkMock).toHaveBeenCalledWith(
diff --git a/src/renderer/components/settings/SettingsFooter.tsx b/src/renderer/components/settings/SettingsFooter.tsx
@@ -1,6 +1,7 @@
 import { PersonIcon, XCircleIcon } from '@primer/octicons-react';
 import { type FC, useEffect, useState } from 'react';
 import { useNavigate } from 'react-router-dom';
+import { APPLICATION } from '../../../shared/constants';
 import { BUTTON_CLASS_NAME } from '../../styles/gitify';
 import { Size } from '../../types';
 import { getAppVersion, quitApp } from '../../utils/comms';
@@ -26,11 +27,13 @@ export const SettingsFooter: FC = () => {
       <button
         type="button"
         className="cursor-pointer font-semibold"
-        title="View release notes"
+        title={`View ${APPLICATION.NAME} release notes`}
         onClick={() => openGitifyReleaseNotes(appVersion)}
       >
         <div className="flex items-center gap-1">
-          <span aria-label="app-version">Gitify {appVersion}</span>
+          <span aria-label="app-version">
+            {APPLICATION.NAME} {appVersion}
+          </span>
         </div>
       </button>
       <div>
@@ -48,10 +51,13 @@ export const SettingsFooter: FC = () => {
         <button
           type="button"
           className={BUTTON_CLASS_NAME}
-          title="Quit Gitify"
+          title={`Quit ${APPLICATION.NAME}`}
           onClick={quitApp}
         >
-          <XCircleIcon size={Size.LARGE} aria-label="Quit Gitify" />
+          <XCircleIcon
+            size={Size.LARGE}
+            aria-label={`Quit ${APPLICATION.NAME}`}
+          />
         </button>
       </div>
     </div>
diff --git a/src/renderer/components/settings/SystemSettings.tsx b/src/renderer/components/settings/SystemSettings.tsx
@@ -1,5 +1,6 @@
 import { DeviceDesktopIcon } from '@primer/octicons-react';
 import { type FC, useContext } from 'react';
+import { APPLICATION } from '../../../shared/constants';
 import { isLinux, isMacOS } from '../../../shared/platform';
 import { AppContext } from '../../context/App';
 import { OpenPreference } from '../../types';
@@ -39,7 +40,7 @@ export const SystemSettings: FC = () => {
             <span className="text-orange-600">
               {Constants.DEFAULT_KEYBOARD_SHORTCUT}
             </span>{' '}
-            to show or hide Gitify.
+            to show or hide {APPLICATION.NAME}.
           </div>
         }
       />
@@ -77,8 +78,8 @@ export const SystemSettings: FC = () => {
         tooltip={
           <div>
             <div className="pb-3">
-              Use a white Gitify logo (instead of the default black logo) when
-              all notifications are read.
+              Use a white {APPLICATION.NAME} logo (instead of the default black
+              logo) when all notifications are read.
             </div>
             <div>
               This is particularly useful for devices which have a dark-themed
diff --git a/src/renderer/components/settings/__snapshots__/SettingsFooter.test.tsx.snap b/src/renderer/components/settings/__snapshots__/SettingsFooter.test.tsx.snap
diff --git a/src/renderer/routes/__snapshots__/Settings.test.tsx.snap b/src/renderer/routes/__snapshots__/Settings.test.tsx.snap
diff --git a/src/renderer/utils/auth/utils.ts b/src/renderer/utils/auth/utils.ts
@@ -2,6 +2,7 @@ import { BrowserWindow } from '@electron/remote';
 import { format } from 'date-fns';
 import semver from 'semver';
 
+import { APPLICATION } from '../../../shared/constants';
 import { logError } from '../../../shared/logger';
 import type {
   Account,
@@ -221,7 +222,10 @@ export function getDeveloperSettingsURL(account: Account): Link {
 export function getNewTokenURL(hostname: Hostname): Link {
   const date = format(new Date(), 'PP p');
   const newTokenURL = new URL(`https://${hostname}/settings/tokens/new`);
-  newTokenURL.searchParams.append('description', `Gitify (Created on ${date})`);
+  newTokenURL.searchParams.append(
+    'description',
+    `${APPLICATION.NAME} (Created on ${date})`,
+  );
   newTokenURL.searchParams.append('scopes', Constants.AUTH_SCOPE.join(','));
 
   return newTokenURL.toString() as Link;
@@ -234,7 +238,7 @@ export function getNewOAuthAppURL(hostname: Hostname): Link {
   );
   newOAuthAppURL.searchParams.append(
     'oauth_application[name]',
-    `Gitify (Created on ${date})`,
+    `${APPLICATION.NAME} (Created on ${date})`,
   );
   newOAuthAppURL.searchParams.append(
     'oauth_application[url]',
diff --git a/src/renderer/utils/notifications.ts b/src/renderer/utils/notifications.ts
@@ -1,5 +1,6 @@
 import path from 'node:path';
 
+import { APPLICATION } from '../../shared/constants';
 import { logError, logWarn } from '../../shared/logger';
 import { isWindows } from '../../shared/platform';
 import type {
@@ -84,7 +85,7 @@ export const raiseNativeNotification = (notifications: Notification[]) => {
     title = isWindows() ? '' : notification.repository.full_name;
     body = notification.subject.title;
   } else {
-    title = 'Gitify';
+    title = APPLICATION.NAME;
     body = `You have ${notifications.length} notifications.`;
   }
 
