fix(node): rename proc-log event-name

Author: commenthol

README.md

@@ -546,7 +546,7 @@ framework of choice for logging. Check `initProcLog()` for inspiration.
 Emits the following process event:
 
 ```
-process.emit('log', level, name, fmt, args)
+process.emit('log-level', level, name, fmt, args)
 ```
 
 where

src/ProcLog.js

@@ -9,7 +9,7 @@ import { inspectOpts, inspectNamespaces, INFO } from './utils.js'
  * @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog
  */
 
-const EVENT = 'log'
+export const EVENT_NAME = 'log-level'
 
 const defaultOptions = {
   level: INFO,
@@ -69,7 +69,7 @@ export class ProcLog extends LogBase {
 
   _log(level, fmt, args) {
     // @ts-expect-error
-    process.emit(EVENT, level, this.name, fmt, args)
+    process.emit(EVENT_NAME, level, this.name, fmt, args)
   }
 }
 
@@ -84,9 +84,9 @@ export function initProcLog(options) {
     logger[namespace] || (logger[namespace] = new LogCls(namespace, options))
 
   // prevent multiple log-lines from adding more than one listener
-  process.removeAllListeners(EVENT)
+  process.removeAllListeners(EVENT_NAME)
   // listen on event
-  process.on(EVENT, (level, namespace, fmt, args) => {
+  process.on(EVENT_NAME, (level, namespace, fmt, args) => {
     const log = getLogger(namespace)
     log[level.toLowerCase()]?.(fmt, ...args)
   })

src/index.js

@@ -12,8 +12,17 @@ import { LogEcs } from './ecs/LogEcs.js'
 import { logger } from './logger.js'
 import { browserLogs } from './browserLogs.js'
 import { httpLogs } from './httpLogs.js'
-import { ProcLog, initProcLog } from './ProcLog.js'
+import { ProcLog, initProcLog, EVENT_NAME } from './ProcLog.js'
 
 export default Log
 
-export { Log, LogEcs, logger, ProcLog, initProcLog, browserLogs, httpLogs }
+export {
+  Log,
+  LogEcs,
+  logger,
+  ProcLog,
+  initProcLog,
+  EVENT_NAME,
+  browserLogs,
+  httpLogs
+}

test/ProcLog.test.js

@@ -1,6 +1,6 @@
 import assert from 'node:assert'
 import { LogEcs } from '../src/index.js'
-import { ProcLog, initProcLog } from '../src/ProcLog.js'
+import { ProcLog, initProcLog, EVENT_NAME } from '../src/ProcLog.js'
 
 describe('ProcLog', function () {
   beforeEach(function () {
@@ -98,7 +98,7 @@ const myInitProcLog = () => {
   const reset = () => {
     lines = []
   }
-  process.on('log', (...args) => {
+  process.on(EVENT_NAME, (...args) => {
     lines.push(...args)
   })
   return { lines, reset }

types/ProcLog.d.ts

@@ -3,6 +3,13 @@
  * @param {LogOptionsWithCustomLog} [options]
  */
 export function initProcLog(options?: LogOptionsWithCustomLog): void;
+/**
+ * @typedef {import('./node.js').LogOptions} LogOptions
+ */
+/**
+ * @typedef {LogOptions & {Log: typeof Log}} LogOptionsWithCustomLog
+ */
+export const EVENT_NAME: "log-level";
 /**
  * Decouple logging via process event 'log'. This allows to use a different
  * logger framework than 'debug-level'. In such cases you'd need to adapt your

types/index.d.ts

@@ -14,6 +14,7 @@ import { LogEcs } from './ecs/LogEcs.js';
 import { logger } from './logger.js';
 import { ProcLog } from './ProcLog.js';
 import { initProcLog } from './ProcLog.js';
+import { EVENT_NAME } from './ProcLog.js';
 import { browserLogs } from './browserLogs.js';
 import { httpLogs } from './httpLogs.js';
-export { Log, LogEcs, logger, ProcLog, initProcLog, browserLogs, httpLogs };
+export { Log, LogEcs, logger, ProcLog, initProcLog, EVENT_NAME, browserLogs, httpLogs };