chore: improve jsdocs

Signed-off-by: Adam Setch <adam.setch@outlook.com>

Author: setchy

src/renderer/types.ts

@@ -421,13 +421,12 @@ export type GitifyCheckSuiteStatus =
   | 'WAITING';
 
 /**
- *
  * Gitify Type Enhancements
  *
  * These types represent the clean, UI-focused notification structure
- * used throughout the application. Raw GitHub API responses are
- * transformed into these types at the API boundary.
+ * used throughout the application.
  *
+ * Raw GitHub API responses are transformed into these types at the API boundary.
  **/
 
 // Stronger typings for string literal attributes

src/shared/events.ts

@@ -2,6 +2,10 @@ import { APPLICATION } from './constants';
 
 const P = APPLICATION.EVENT_PREFIX;
 
+/**
+ * IPC event name constants for all Electron main ↔ renderer communication channels.
+ * Each value is prefixed with `APPLICATION.EVENT_PREFIX` to prevent collisions.
+ */
 export const EVENTS = {
   AUTH_CALLBACK: `${P}auth-callback`,
   QUIT: `${P}quit`,
@@ -23,23 +27,28 @@ export const EVENTS = {
   TWEMOJI_DIRECTORY: `${P}twemoji-directory`,
 } as const;
 
+/** Union type of all valid IPC event name strings. */
 export type EventType = (typeof EVENTS)[keyof typeof EVENTS];
 
+/** Payload for the `UPDATE_AUTO_LAUNCH` event. */
 export interface IAutoLaunch {
   openAtLogin: boolean;
   openAsHidden: boolean;
 }
 
+/** Payload for the `UPDATE_KEYBOARD_SHORTCUT` event. */
 export interface IKeyboardShortcut {
   enabled: boolean;
   keyboardShortcut: string;
 }
 
+/** Payload for the `OPEN_EXTERNAL` event. */
 export interface IOpenExternal {
   url: string;
   activate: boolean;
 }
 
+/** Union of all possible IPC event payload types. */
 export type EventData =
   | string
   | number

src/shared/logger.test.ts

@@ -12,18 +12,21 @@ describe('shared/logger.ts', () => {
   describe('logInfo', () => {
     it('logs info without contexts', () => {
       logInfo('foo', 'bar');
+
       expect(logInfoSpy).toHaveBeenCalledTimes(1);
       expect(logInfoSpy).toHaveBeenCalledWith('[foo]', 'bar');
     });
 
     it('logs info with single context', () => {
       logInfo('foo', 'bar', ['ctx']);
+
       expect(logInfoSpy).toHaveBeenCalledTimes(1);
       expect(logInfoSpy).toHaveBeenCalledWith('[foo]', 'bar', '[ctx]');
     });
 
     it('logs info with multiple contexts', () => {
       logInfo('foo', 'bar', ['ctx1', 'ctx2']);
+
       expect(logInfoSpy).toHaveBeenCalledTimes(1);
       expect(logInfoSpy).toHaveBeenCalledWith('[foo]', 'bar', '[ctx1 >> ctx2]');
     });
@@ -32,18 +35,21 @@ describe('shared/logger.ts', () => {
   describe('logWarn', () => {
     it('logs warn without contexts', () => {
       logWarn('foo', 'bar');
+
       expect(logWarnSpy).toHaveBeenCalledTimes(1);
       expect(logWarnSpy).toHaveBeenCalledWith('[foo]', 'bar');
     });
 
     it('logs warn with single context', () => {
       logWarn('foo', 'bar', ['ctx']);
+
       expect(logWarnSpy).toHaveBeenCalledTimes(1);
       expect(logWarnSpy).toHaveBeenCalledWith('[foo]', 'bar', '[ctx]');
     });
 
     it('logs warn with multiple contexts', () => {
       logWarn('foo', 'bar', ['ctx1', 'ctx2']);
+
       expect(logWarnSpy).toHaveBeenCalledTimes(1);
       expect(logWarnSpy).toHaveBeenCalledWith('[foo]', 'bar', '[ctx1 >> ctx2]');
     });
@@ -52,12 +58,14 @@ describe('shared/logger.ts', () => {
   describe('logError', () => {
     it('logs error without contexts', () => {
       logError('foo', 'bar', mockError);
+
       expect(logErrorSpy).toHaveBeenCalledTimes(1);
       expect(logErrorSpy).toHaveBeenCalledWith('[foo]', 'bar', mockError);
     });
 
     it('logs error with single context', () => {
       logError('foo', 'bar', mockError, ['ctx']);
+
       expect(logErrorSpy).toHaveBeenCalledTimes(1);
       expect(logErrorSpy).toHaveBeenCalledWith(
         '[foo]',
@@ -69,6 +77,7 @@ describe('shared/logger.ts', () => {
 
     it('logs error with multiple contexts', () => {
       logError('foo', 'bar', mockError, ['ctx1', 'ctx2']);
+
       expect(logErrorSpy).toHaveBeenCalledTimes(1);
       expect(logErrorSpy).toHaveBeenCalledWith(
         '[foo]',

src/shared/logger.ts

@@ -2,6 +2,13 @@ import log from 'electron-log';
 
 type AllowedLogFunction = typeof log.info | typeof log.warn | typeof log.error;
 
+/**
+ * Logs an informational message via electron-log.
+ *
+ * @param type - A short label identifying the caller or module (e.g. `'getAllNotifications'`).
+ * @param message - The log message.
+ * @param contexts - Optional array of context strings appended to the log entry.
+ */
 export function logInfo(
   type: string,
   message: string,
@@ -10,6 +17,13 @@ export function logInfo(
   logMessage(log.info, type, message, undefined, contexts);
 }
 
+/**
+ * Logs a warning message via electron-log.
+ *
+ * @param type - A short label identifying the caller or module.
+ * @param message - The warning message.
+ * @param contexts - Optional array of context strings appended to the log entry.
+ */
 export function logWarn(
   type: string,
   message: string,
@@ -18,6 +32,14 @@ export function logWarn(
   logMessage(log.warn, type, message, undefined, contexts);
 }
 
+/**
+ * Logs an error message via electron-log.
+ *
+ * @param type - A short label identifying the caller or module.
+ * @param message - A description of the error context.
+ * @param err - The error object that was caught.
+ * @param contexts - Optional array of context strings appended to the log entry.
+ */
 export function logError(
   type: string,
   message: string,

src/shared/platform.test.ts

@@ -9,28 +9,40 @@ describe('shared/platform.ts', () => {
     });
   }
 
-  afterEach(() => {
+  afterAll(() => {
     mockPlatform(originalPlatform as NodeJS.Platform);
   });
 
   it('isLinux returns true only for linux', () => {
     mockPlatform('linux');
     expect(isLinux()).toBe(true);
+
     mockPlatform('darwin');
     expect(isLinux()).toBe(false);
+
+    mockPlatform('win32');
+    expect(isLinux()).toBe(false);
   });
 
   it('isMacOS returns true only for darwin', () => {
+    mockPlatform('linux');
+    expect(isMacOS()).toBe(false);
+
     mockPlatform('darwin');
     expect(isMacOS()).toBe(true);
+
     mockPlatform('win32');
     expect(isMacOS()).toBe(false);
   });
 
   it('isWindows returns true only for win32', () => {
-    mockPlatform('win32');
-    expect(isWindows()).toBe(true);
     mockPlatform('linux');
     expect(isWindows()).toBe(false);
+
+    mockPlatform('darwin');
+    expect(isWindows()).toBe(false);
+
+    mockPlatform('win32');
+    expect(isWindows()).toBe(true);
   });
 });

src/shared/platform.ts

@@ -1,11 +1,26 @@
+/**
+ * Returns `true` if the current operating system is Linux.
+ *
+ * @returns `true` on Linux, `false` otherwise.
+ */
 export function isLinux(): boolean {
   return process.platform === 'linux';
 }
 
+/**
+ * Returns `true` if the current operating system is macOS.
+ *
+ * @returns `true` on macOS, `false` otherwise.
+ */
 export function isMacOS(): boolean {
   return process.platform === 'darwin';
 }
 
+/**
+ * Returns `true` if the current operating system is Windows.
+ *
+ * @returns `true` on Windows, `false` otherwise.
+ */
 export function isWindows(): boolean {
   return process.platform === 'win32';
 }