refactor: allow lowercase log levels

README.md

@@ -53,65 +53,65 @@ log('debug log')
 Create a log entry with a red cross.
 
 ```typescript
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - error log
  * @module log/docs/examples/error
  */
 
-log('error log', { level: 'ERROR' })
+log('error log', { level: LogLevel.ERROR })
 ```
 
 #### Info
 
 Create a log entry with a blue info symbol.
 
 ```typescript
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - info log
  * @module log/docs/examples/info
  */
 
-log('info log', { level: 'INFO' })
+log('info log', { level: LogLevel.INFO })
 ```
 
 #### Success
 
 Create a log entry with a green tick mark.
 
 ```typescript
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - success log
  * @module log/docs/examples/success
  */
 
-log('success log', { level: 'SUCCESS' })
+log('success log', { level: LogLevel.SUCCESS })
 ```
 
 #### Warning
 
 Create a log entry with a yellow exclamation point.
 
 ```typescript
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - warning log
  * @module log/docs/examples/warning
  */
 
-log('warning log', { level: 'WARN' })
+log('warning log', { level: LogLevel.WARN })
 ```
 
 ### Options
 
 ```typescript
-export interface LogOptions {
+interface LogOptions {
   /**
    * Log arguments.
    *
@@ -159,7 +159,15 @@ export interface LogOptions {
   silent?: boolean
 }
 
-type Level = 'DEBUG' | 'ERROR' | 'INFO' | 'SUCCESS' | 'WARN'
+enum LogLevel {
+  DEBUG = 'debug',
+  ERROR = 'error',
+  INFO = 'info',
+  SUCCESS = 'success',
+  WARN = 'warn'
+}
+
+export type Level = keyof typeof LogLevel | LogLevel
 ```
 
 ## Built With

docs/examples/error.ts

@@ -1,8 +1,8 @@
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - error log
  * @module log/docs/examples/error
  */
 
-log('error log', { level: 'ERROR' })
+log('error log', { level: LogLevel.ERROR })

docs/examples/info.ts

@@ -1,8 +1,8 @@
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - info log
  * @module log/docs/examples/info
  */
 
-log('info log', { level: 'INFO' })
+log('info log', { level: LogLevel.INFO })

docs/examples/success.ts

@@ -1,8 +1,8 @@
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - success log
  * @module log/docs/examples/success
  */
 
-log('success log', { level: 'SUCCESS' })
+log('success log', { level: LogLevel.SUCCESS })

docs/examples/warning.ts

@@ -1,8 +1,8 @@
-import log from '@flex-development/log'
+import log, { LogLevel } from '@flex-development/log'
 
 /**
  * @file Examples - warning log
  * @module log/docs/examples/warning
  */
 
-log('warning log', { level: 'WARN' })
+log('warning log', { level: LogLevel.WARN })

src/__tests__/log.functional.spec.ts

@@ -1,9 +1,9 @@
 import defaults from '@log/config/defaults.config'
 import type { LogOptions } from '@log/interfaces'
 import format from '@log/utils/format.util'
+import normalizeOptions from '@log/utils/normalize-options.util'
 import type { RestoreConsole } from 'jest-mock-console'
 import mockConsole from 'jest-mock-console'
-import merge from 'lodash.merge'
 import sh from 'shelljs'
 import testSubject from '../log'
 
@@ -13,28 +13,29 @@ import testSubject from '../log'
  */
 
 jest.mock('@log/utils/format.util')
+jest.mock('@log/utils/normalize-options.util')
 
 const mockSH = sh as jest.Mocked<typeof sh>
 const mockFormat = format as jest.MockedFunction<typeof format>
-const mockMerge = merge as jest.MockedFunction<typeof merge>
+const mockNormalizeOptions = normalizeOptions as jest.MockedFunction<
+  typeof normalizeOptions
+>
 
 describe('functional:log', () => {
   const restoreConsole: RestoreConsole = mockConsole(['log'])
   const spy_console_log = jest.spyOn(console, 'log')
 
   afterAll(() => restoreConsole())
 
-  it('should merge options with defaults', () => {
+  it('should normalize options', () => {
     // Arrange
     const options: LogOptions = { level: 'ERROR' }
 
     // Act
     testSubject('', options)
 
     // Expect
-    expect(mockMerge).toBeCalledTimes(1)
-    expect(mockMerge.mock.calls[0][1]).toStrictEqual(defaults)
-    expect(mockMerge.mock.calls[0][2]).toStrictEqual(options)
+    expect(mockNormalizeOptions.mock.calls[0][0]).toMatchObject(options)
   })
 
   it('should format log entry', () => {
@@ -47,7 +48,7 @@ describe('functional:log', () => {
 
     // Expect
     expect(mockFormat).toBeCalledTimes(1)
-    expect(mockFormat).toBeCalledWith(data, options)
+    expect(mockFormat).toBeCalledWith(data, mockNormalizeOptions(options))
   })
 
   describe('options', () => {

src/config/defaults.config.ts

@@ -1,3 +1,4 @@
+import { LogLevel } from '@log/enums/log-level.enum'
 import type { LogOptions } from '@log/interfaces'
 
 /**
@@ -9,5 +10,5 @@ export default Object.freeze({
   args: [],
   bold: { args: true, data: false },
   color: {},
-  level: 'DEBUG'
+  level: LogLevel.DEBUG
 }) as Readonly<Required<Pick<LogOptions, 'args' | 'bold' | 'color' | 'level'>>>

src/enums/log-figure.enum.ts

@@ -1,5 +1,5 @@
 import figures from 'figures'
-import type { Level } from './log-level.enum'
+import type { LogLevel } from './log-level.enum'
 
 /**
  * @file Enums - LogFigure
@@ -14,10 +14,11 @@ import type { Level } from './log-level.enum'
  * @readonly
  * @enum {string}
  */
-export const LogFigure: Readonly<Record<Level, string>> = Object.freeze({
-  DEBUG: '',
-  ERROR: figures.cross,
-  INFO: figures.info,
-  SUCCESS: figures.tick,
-  WARN: '!'
-})
+export const LogFigure: Readonly<Record<keyof typeof LogLevel, string>> =
+  Object.freeze({
+    DEBUG: '',
+    ERROR: figures.cross,
+    INFO: figures.info,
+    SUCCESS: figures.tick,
+    WARN: '!'
+  })

src/enums/log-level.enum.ts

@@ -11,7 +11,5 @@ export enum LogLevel {
   ERROR = 'error',
   INFO = 'info',
   SUCCESS = 'success',
-  WARN = 'warning'
+  WARN = 'warn'
 }
-
-export type Level = keyof typeof LogLevel

src/index.ts

@@ -5,4 +5,8 @@ import log from './log'
  * @module log
  */
 
+export { LogLevel } from './enums/log-level.enum'
+export type { LogOptions } from './interfaces'
+export type { Level } from './types'
+
 export default log

src/interfaces/log-options.interface.ts

@@ -1,5 +1,5 @@
 import type { NullishString } from '@flex-development/tutils'
-import type { Level } from '@log/enums/log-level.enum'
+import type { Level } from '@log/types'
 import figures from 'figures'
 import type { LogOptionsBold } from './log-options-bold.interface'
 import type { LogOptionsColor } from './log-options-color.interface'
@@ -42,7 +42,7 @@ export interface LogOptions {
   /**
    * Log level.
    *
-   * @default 'DEBUG'
+   * @default LogLevel.DEBUG
    */
   level?: Level
 

src/log.ts

@@ -1,15 +1,15 @@
 import type { NullishString } from '@flex-development/tutils'
 import defaults from '@log/config/defaults.config'
-import type { Level } from '@log/enums/log-level.enum'
 import type {
   LogOptions,
   LogOptionsBold,
   LogOptionsColor
 } from '@log/interfaces'
+import type { Level } from '@log/types'
 import type { Color } from 'chalk'
 import figs from 'figures'
-import merge from 'lodash.merge'
 import format from './utils/format.util'
+import normalizeOptions from './utils/normalize-options.util'
 
 /**
  * @file Log Method
@@ -34,14 +34,14 @@ import format from './utils/format.util'
  * @param {typeof Color} [options.color.data] - Set log data color
  * @param {typeof Color} [options.color.figure] - Set log figure color
  * @param {keyof typeof figs | NullishString} [options.figure] - Override figure
- * @param {Level} [options.level='DEBUG'] - Log level
+ * @param {Level} [options.level=LogLevel.DEBUG] - Log level
  * @param {boolean} [options.shell] - Use [`echo`][2] instead of `console.log`
  * @param {boolean} [options.silent] - Do not log any output
  * @return {string} Formatted log entry
  */
 const log = (data: any, options: LogOptions = defaults): string => {
   // Merge options with defaults
-  const $options = merge({}, defaults, options)
+  const $options = normalizeOptions(options)
 
   // Create formatted log entry
   const entry = format(data, $options)

src/types/Level.ts

@@ -0,0 +1,11 @@
+import type { LogLevel } from '@log/enums/log-level.enum'
+
+/**
+ * @file Type Definitions - Level
+ * @module log/types/Level
+ */
+
+/**
+ * Log levels.
+ */
+export type Level = keyof typeof LogLevel | LogLevel

src/types/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Type Definitions
+ * @module log/types
+ */
+
+export type { Level } from './Level'

src/utils/__mocks__/normalize-options.util.ts

@@ -0,0 +1,9 @@
+/**
+ * @file User Module Mock - normalizeOptions
+ * @module utils/mocks/normalizeOptions
+ * @see https://jestjs.io/docs/manual-mocks#mocking-user-modules
+ */
+
+export default jest.fn((...args) => {
+  return jest.requireActual('../normalize-options.util').default(...args)
+})