merge log levels and aliases; remove silent

Author: grypez

packages/logger/src/constants.ts

@@ -0,0 +1 @@
+export const logLevels = ['debug', 'info', 'log', 'warn', 'error'] as const;

packages/logger/src/logger.ts

@@ -55,7 +55,6 @@ import type {
   LoggerOptions,
   LogMethod,
   LogArgs,
-  LogAlias,
 } from './types.ts';
 
 /**
@@ -93,10 +92,10 @@ export class Logger {
 
     // Create aliases for the log methods, allowing them to be used in a
     // manner similar to the console object.
-    const bind = (alias: LogAlias): LogMethod =>
+    const bind = (level: LogLevel): LogMethod =>
       this.#dispatch.bind(this, {
         ...this.#options,
-        level: alias as LogLevel,
+        level,
       }) as LogMethod;
     this.log = bind('log');
     this.debug = bind('debug');

packages/logger/src/transports.test.ts

@@ -1,21 +1,20 @@
 import type { DuplexStream } from '@ocap/streams';
-import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 
+import { logLevels } from './constants.ts';
 import { consoleTransport, makeStreamTransport } from './transports.ts';
-import type { LogAlias, LogEntry, LogLevel, Transport } from './types.ts';
+import type { LogEntry, LogLevel } from './types.ts';
 
 const makeLogEntry = (level: LogLevel): LogEntry => ({
   level,
   message: 'test-message',
   tags: ['test-tag'],
 });
 
-const logAliases = ['log', 'info', 'debug', 'warn', 'error'] as const;
-
 describe('consoleTransport', () => {
-  it.each(logAliases)(
+  it.each(logLevels)(
     'logs to the appropriate console alias: %s',
-    (level: LogAlias) => {
+    (level: LogLevel) => {
       const logEntry = makeLogEntry(level);
       const consoleMethodSpy = vi.spyOn(console, level);
       consoleTransport(logEntry);
@@ -25,36 +24,16 @@ describe('consoleTransport', () => {
       );
     },
   );
-
-  it('does not log silent messages', () => {
-    const consoleMethodSpies = logAliases.map((alias) =>
-      vi.spyOn(console, alias),
-    );
-    consoleTransport(makeLogEntry('silent'));
-    consoleMethodSpies.forEach((spy) => expect(spy).not.toHaveBeenCalled());
-  });
 });
 
 describe('makeStreamTransport', () => {
-  let mockStream: DuplexStream<LogEntry>;
-  let streamTransport: Transport;
-
-  beforeEach(() => {
-    mockStream = {
-      write: vi.fn().mockResolvedValue(undefined),
-    } as unknown as DuplexStream<LogEntry>;
-    streamTransport = makeStreamTransport(mockStream);
-  });
-
   it('writes to the stream', () => {
     const logEntry = makeLogEntry('info');
+    const mockStream = {
+      write: vi.fn().mockResolvedValue(undefined),
+    } as unknown as DuplexStream<LogEntry>;
+    const streamTransport = makeStreamTransport(mockStream);
     streamTransport(logEntry);
     expect(mockStream.write).toHaveBeenCalledWith(logEntry);
   });
-
-  it('does not write silent messages', () => {
-    const logEntry = makeLogEntry('silent');
-    streamTransport(logEntry);
-    expect(mockStream.write).not.toHaveBeenCalled();
-  });
 });

packages/logger/src/transports.ts

@@ -8,9 +8,6 @@ import type { Transport, LogEntry } from './types.ts';
  * @param entry - The log entry to transport.
  */
 export const consoleTransport: Transport = (entry) => {
-  if (entry.level === 'silent') {
-    return;
-  }
   const args = [
     ...(entry.tags.length > 0 ? [entry.tags] : []),
     ...(entry.message ? [entry.message] : []),
@@ -30,9 +27,6 @@ export const makeStreamTransport = (
   stream: DuplexStream<LogEntry>,
 ): Transport => {
   return (entry) => {
-    if (entry.level === 'silent') {
-      return;
-    }
     stream.write(entry).catch(console.debug);
   };
 };

packages/logger/src/types.ts

@@ -1,7 +1,9 @@
+import type { logLevels } from './constants.ts';
+
 /**
  * The log level for the logger.
  */
-export type LogLevel = 'debug' | 'info' | 'log' | 'warn' | 'error' | 'silent';
+export type LogLevel = (typeof logLevels)[number];
 
 /**
  * The log entry for the logger.
@@ -30,5 +32,3 @@ export type LoggerOptions = {
 export type LogArgs = [string, ...unknown[]] | [];
 
 export type LogMethod = (...args: LogArgs) => void;
-
-export type LogAlias = 'debug' | 'info' | 'log' | 'warn' | 'error';