refactor(lib): [createLogger] reporters

Signed-off-by: Lexus Drumgold <[email protected]>

src/__tests__/logger.spec.mts

@@ -26,7 +26,7 @@ describe('unit:logger', () => {
     expect(subject).to.have.property('format').satisfy(isObjectPlain)
     expect(subject).to.have.property('level', logLevels.info)
     expect(subject).to.have.property('levels', logLevels)
-    expect(subject).to.have.property('reporters').be.an('array').that.is.empty
+    expect(subject).to.have.property('reporters').be.instanceof(Set).and.empty
     expect(subject).to.have.property('stderr', process.stderr)
     expect(subject).to.have.property('stdout', process.stdout)
     expect(subject).to.have.property('types').with.keys(types)

src/interfaces/__tests__/log-function.spec-d.mts

@@ -7,8 +7,8 @@ import type TestSubject from '#interfaces/log-function'
 import type { InputLogObject } from '@flex-development/log'
 
 describe('unit-d:interfaces/LogFunction', () => {
-  it('should match [this: void]', () => {
-    expectTypeOf<TestSubject>().thisParameter.toEqualTypeOf<void>()
+  it('should match [this: unknown]', () => {
+    expectTypeOf<TestSubject>().thisParameter.toEqualTypeOf<unknown>()
   })
 
   describe('parameters', () => {

src/interfaces/__tests__/log-functions.spec-d.mts

@@ -14,8 +14,8 @@ describe('unit-d:interfaces/LogFunctions', () => {
   describe('inspect', () => {
     type Subject = TestSubject['inspect']
 
-    it('should match [this: void]', () => {
-      expectTypeOf<Subject>().thisParameter.toEqualTypeOf<void>()
+    it('should match [this: unknown]', () => {
+      expectTypeOf<Subject>().thisParameter.toEqualTypeOf<unknown>()
     })
 
     describe('parameters', () => {

src/interfaces/__tests__/logger-options.spec-d.mts

@@ -9,9 +9,9 @@ import type {
   LogFormatOptions,
   LogLevelOption,
   LogType,
+  ReportersOption,
   WriteStream
 } from '@flex-development/log'
-import type { Reporter } from '@flex-development/log/reporters'
 import type { Nilable } from '@flex-development/tutils'
 
 describe('unit-d:interfaces/LoggerOptions', () => {
@@ -33,10 +33,10 @@ describe('unit-d:interfaces/LoggerOptions', () => {
       .toEqualTypeOf<Nilable<LogLevelOption>>()
   })
 
-  it('should match [reporters?: Set<Reporter> | readonly Reporter[] | null | undefined]', () => {
+  it('should match [reporters?: ReportersOption | null | undefined]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('reporters')
-      .toEqualTypeOf<Nilable<Set<Reporter> | readonly Reporter[]>>()
+      .toEqualTypeOf<Nilable<ReportersOption>>()
   })
 
   it('should match [stderr?: WriteStream | null | undefined]', () => {

src/interfaces/__tests__/logger.spec-d.mts

@@ -66,10 +66,14 @@ describe('unit-d:interfaces/Logger', () => {
     expectTypeOf<TestSubject>().toHaveProperty('levels').toEqualTypeOf<T>()
   })
 
-  it('should match [reporters: Reporter[]]', () => {
-    expectTypeOf<TestSubject>()
-      .toHaveProperty('reporters')
-      .toEqualTypeOf<Reporter[]>()
+  it('should match [readonly reporters: Set<Reporter>]', () => {
+    // Arrange
+    type K = ReadonlyKeys<TestSubject>
+    type T = Set<Reporter>
+
+    // Expect
+    expectTypeOf<K>().extract<'reporters'>().not.toBeNever()
+    expectTypeOf<TestSubject>().toHaveProperty('reporters').toEqualTypeOf<T>()
   })
 
   it('should match [stderr: WriteStream]', () => {

src/interfaces/log-function.mts

@@ -12,30 +12,22 @@ interface LogFunction {
   /**
    * @see {@linkcode InputLogObject}
    *
-   * @this {void}
-   *
    * @param {InputLogObject | string} message
    *  The message to write
    * @param {unknown[]} args
    *  Message arguments
    * @return {undefined | void}
    */
-  (
-    this: void,
-    message: InputLogObject | string,
-    ...args: unknown[]
-  ): undefined | void
+  (message: InputLogObject | string, ...args: unknown[]): undefined | void
 
   /**
-   * @this {void}
-   *
    * @param {unknown} message
    *  The message to write
    * @param {unknown[]} args
    *  Message arguments
    * @return {undefined | void}
    */
-  (this: void, message: unknown, ...args: unknown[]): undefined | void
+  (message: unknown, ...args: unknown[]): undefined | void
 }
 
 export type { LogFunction as default }

src/interfaces/log-functions.mts

@@ -20,16 +20,13 @@ interface LogFunctions extends LogTypeFunctions {
    *
    * @see {@linkcode InspectOptions}
    *
-   * @this {void}
-   *
    * @param {unknown} value
    *  The thing to inspect
    * @param {InspectOptions | null | undefined} [options]
    *  Inspect options
    * @return {undefined}
    */
   inspect(
-    this: void,
     value: unknown,
     options?: InspectOptions | null | undefined
   ): undefined

src/interfaces/logger-options.mts

@@ -8,9 +8,9 @@ import type {
   LogFormatOptions,
   LogLevelOption,
   LogType,
+  ReportersOption,
   WriteStream
 } from '@flex-development/log'
-import type { Reporter } from '@flex-development/log/reporters'
 
 /**
  * Logger configuration options.
@@ -50,13 +50,13 @@ interface LoggerOptions {
   level?: LogLevelOption | null | undefined
 
   /**
-   * List of reporter instances used to handle and output log messages.
+   * Reporter instances used to handle and output log messages.
    *
-   * @see {@linkcode Reporter}
+   * @see {@linkcode ReportersOption}
    *
    * @default []
    */
-  reporters?: Set<Reporter> | readonly Reporter[] | null | undefined
+  reporters?: ReportersOption | null | undefined
 
   /**
    * The writeable stream for standard error output.

src/interfaces/logger.mts

@@ -73,7 +73,7 @@ interface Logger extends LogFunctions {
   format: LogFormatOptions
 
   /**
-   * Get the minimum log level to output.
+   * Get the current log level.
    *
    * @see {@linkcode LogLevel}
    *
@@ -83,12 +83,12 @@ interface Logger extends LogFunctions {
   get level(): LogLevel
 
   /**
-   * Set the minimum log level to output.
+   * Set the maximum log level to output.
    *
    * @see {@linkcode LogLevelOption}
    *
    * @param {LogLevelOption | null | undefined} level
-   *  New log level
+   *  Maximum log level (inclusive)
    */
   set level(level: LogLevelOption | null | undefined)
 
@@ -105,8 +105,10 @@ interface Logger extends LogFunctions {
    * List of reporter instances used to handle and output log messages.
    *
    * @see {@linkcode Reporter}
+   *
+   * @readonly
    */
-  reporters: Reporter[]
+  readonly reporters: Set<Reporter>
 
   /**
    * The writeable stream for standard error output.

src/internal/__tests__/normalize-level.spec.mts

@@ -9,10 +9,10 @@ import testSubject from '#internal/normalize-level'
 import type { Logger } from '@flex-development/log'
 
 describe('unit:internal/normalizeLevel', () => {
-  let self: Pick<Logger, 'levels' | 'types'>
+  let logger: Pick<Logger, 'levels' | 'types'>
 
   beforeAll(() => {
-    self = {
+    logger = {
       levels: logLevels,
       types: {
         [logTypes.debug]: { level: logLevels.debug },
@@ -30,7 +30,7 @@ describe('unit:internal/normalizeLevel', () => {
     }
   })
 
-  it.each<Parameters<typeof testSubject>>([
+  it.each<[number | string | null | undefined]>([
     [-13],
     [logLevels.silent],
     [logLevels.error],
@@ -54,6 +54,6 @@ describe('unit:internal/normalizeLevel', () => {
     [logTypes.warn],
     [null]
   ])('should return normalized log level (%j)', level => {
-    expect(testSubject.call(self, level)).toMatchSnapshot()
+    expect(testSubject(logger, level)).toMatchSnapshot()
   })
 })

src/internal/normalize-level.mts

@@ -17,23 +17,23 @@ import { clamp } from '@flex-development/tutils'
  *
  * @internal
  *
- * @this {Pick<Logger, 'levels' | 'types'>}
- *
+ * @param {Pick<Logger, 'levels' | 'types'>} logger
+ *  Logger object
  * @param {number | string | null | undefined} level
  *  Log level or type
  * @return {LogLevel}
  *  Normalized log level
  */
 function normalizeLevel(
-  this: Pick<Logger, 'levels' | 'types'>,
+  logger: Pick<Logger, 'levels' | 'types'>,
   level: number | string | null | undefined
 ): LogLevel {
   /**
    * Log level map.
    *
    * @const {LogLevelMap} levels
    */
-  const levels: LogLevelMap = this.levels
+  const levels: LogLevelMap = logger.levels
 
   if (typeof level === 'number') {
     return clamp(level, levels.silent, levels.verbose) as LogLevel
@@ -43,7 +43,7 @@ function normalizeLevel(
      *
      * @const {Record<LogType, InputLogObject>} types
      */
-    const types: Record<LogType, InputLogObject> = this.types
+    const types: Record<LogType, InputLogObject> = logger.types
 
     // `level` is a known log type
     if (level in types) return types[level as LogType].level ?? levels.info

src/lib/__tests__/create-logger.functional.spec.mts

@@ -37,7 +37,7 @@ describe('functional:lib/createLogger', () => {
 
     beforeEach(() => {
       reporter = new MockReporter()
-      subject = testSubject({ reporters: [reporter] })
+      subject = testSubject({ reporters: reporter })
       subject.unicode = true
     })