feat: moved log transport to main package

Author: KatoakDR

electron/common/logger/types.ts

@@ -22,31 +22,6 @@ export type LogMessage = LogData & {
   timestamp: Date;
 };
 
-/**
- * Transporters write log messages somewhere.
- * For example, to a console, a file, an api, or nowhere.
- */
-export interface LogTransporter {
-  transport(message: LogMessage): void;
-}
-
-export interface LogTransportConfig {
-  /**
-   * Transports log messages somewhere.
-   * For example, to the console, a file, an api, or nowhere.
-   */
-  transporter: LogTransporter;
-  /**
-   * By default, all messages are logged to every transporter for levels
-   * that satisify the runtime log level. You can further restrict which
-   * levels are logged to a specific transporter by setting this property.
-   *
-   * For example, if the runtime log level is 'INFO' but you only want to send
-   * errors to this transporter, then set this config's level to 'ERROR'.
-   */
-  level?: LogLevel;
-}
-
 /**
  * Shape of a logger function that always logs to a specific level.
  */

electron/common/tsconfig.json

@@ -28,5 +28,9 @@
     "lib": ["DOM", "DOM.Iterable", "ESNext"]
   },
   "exclude": ["node_modules", "**/__tests__/**", "**/__mocks__/**"],
-  "include": ["**/types.ts", "**/*.ts"]
+  "include": [
+    "**/types.ts",
+    "**/*.ts",
+    "../main/logger/__mocks__/transporter.mock.ts"
+  ]
 }

electron/main/logger/__mocks__/log-formatter.mock.ts electron/main/logger/__mocks__/formatter.mock.ts

@@ -1,13 +1,11 @@
 import type { Mocked } from 'vitest';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import type { LogTransporterMock } from '../../../common/logger/__mocks__/transporter.mock.js';
-import { LogTransporterMockImpl } from '../../../common/logger/__mocks__/transporter.mock.js';
-import type {
-  LogMessage,
-  LogTransportConfig,
-} from '../../../common/logger/types.js';
+import type { LogMessage } from '../../../common/logger/types.js';
 import { LogLevel } from '../../../common/logger/types.js';
+import type { LogTransporterMock } from '../__mocks__/transporter.mock.js';
+import { LogTransporterMockImpl } from '../__mocks__/transporter.mock.js';
 import { LoggerImpl } from '../logger.js';
+import type { LogTransportConfig } from '../types.js';
 
 type LoggerUtilsModule = typeof import('../logger.utils.js');
 

electron/common/logger/__mocks__/transporter.mock.ts electron/main/logger/__mocks__/transporter.mock.ts

@@ -3,10 +3,9 @@ import type {
   LogData,
   LogLevel,
   LogMessage,
-  LogTransportConfig,
-  LogTransporter,
 } from '../../common/logger/types.js';
 import { isLogLevelEnabled } from './logger.utils.js';
+import type { LogTransportConfig, LogTransporter } from './types.js';
 
 const DEFAULT_SCOPE = 'default';
 

electron/main/logger/__tests__/logger.test.ts

@@ -1,7 +1,7 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { LogLevel, type LogMessage } from '../../../../common/logger/types.js';
-import type { LogFormatterMock } from '../../__mocks__/log-formatter.mock.js';
-import { LogFormatterMockImpl } from '../../__mocks__/log-formatter.mock.js';
+import type { LogFormatterMock } from '../../__mocks__/formatter.mock.js';
+import { LogFormatterMockImpl } from '../../__mocks__/formatter.mock.js';
 import { ConsoleLogTransporterImpl } from '../console.transporter.js';
 
 describe('console-log-transporter', () => {

electron/main/logger/logger.ts

@@ -1,7 +1,7 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { LogLevel, type LogMessage } from '../../../../common/logger/types.js';
-import type { LogFormatterMock } from '../../__mocks__/log-formatter.mock.js';
-import { LogFormatterMockImpl } from '../../__mocks__/log-formatter.mock.js';
+import type { LogFormatterMock } from '../../__mocks__/formatter.mock.js';
+import { LogFormatterMockImpl } from '../../__mocks__/formatter.mock.js';
 import { FileLogTransporterImpl } from '../file.transporter.js';
 
 const { mockWritable, mockCreateWriteStream } = await vi.hoisted(async () => {

electron/main/logger/transport/__tests__/console-transporter.test.ts

@@ -1,8 +1,8 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { LogLevel, type LogMessage } from '../../../../common/logger/types.js';
 import { WritableMockImpl } from '../../../__mocks__/writable.mock.js';
-import type { LogFormatterMock } from '../../__mocks__/log-formatter.mock.js';
-import { LogFormatterMockImpl } from '../../__mocks__/log-formatter.mock.js';
+import type { LogFormatterMock } from '../../__mocks__/formatter.mock.js';
+import { LogFormatterMockImpl } from '../../__mocks__/formatter.mock.js';
 import { WritableLogTransporterImpl } from '../writable.transporter.js';
 
 describe('writable-log-transporter', () => {

electron/main/logger/transport/__tests__/file-transporter.test.ts

@@ -1,9 +1,6 @@
-import type {
-  LogMessage,
-  LogTransporter,
-} from '../../../common/logger/types.js';
+import type { LogMessage } from '../../../common/logger/types.js';
 import { LogLevel } from '../../../common/logger/types.js';
-import type { LogFormatter } from '../types.js';
+import type { LogFormatter, LogTransporter } from '../types.js';
 
 /**
  * Transports logs to the console.

electron/main/logger/transport/__tests__/writable-transporter.test.ts

@@ -1,10 +1,7 @@
 import { nextTick } from 'node:process';
 import type { Writable } from 'node:stream';
-import type {
-  LogMessage,
-  LogTransporter,
-} from '../../../common/logger/types.js';
-import type { LogFormatter } from '../types.js';
+import type { LogMessage } from '../../../common/logger/types.js';
+import type { LogFormatter, LogTransporter } from '../types.js';
 
 /**
  * Transports logs via a {@link Writable} stream.

electron/main/logger/transport/console.transporter.ts

@@ -1,8 +1,33 @@
-import type { LogMessage } from '../../common/logger/types.js';
+import type { LogLevel, LogMessage } from '../../common/logger/types.js';
 
 /**
  * Formats log messages into strings to be written to transporters.
  */
 export interface LogFormatter {
   format(message: LogMessage): string;
 }
+
+/**
+ * Transporters write log messages somewhere.
+ * For example, to a console, a file, an api, or nowhere.
+ */
+export interface LogTransporter {
+  transport(message: LogMessage): void;
+}
+
+export interface LogTransportConfig {
+  /**
+   * Transports log messages somewhere.
+   * For example, to the console, a file, an api, or nowhere.
+   */
+  transporter: LogTransporter;
+  /**
+   * By default, all messages are logged to every transporter for levels
+   * that satisify the runtime log level. You can further restrict which
+   * levels are logged to a specific transporter by setting this property.
+   *
+   * For example, if the runtime log level is 'INFO' but you only want to send
+   * errors to this transporter, then set this config's level to 'ERROR'.
+   */
+  level?: LogLevel;
+}