feat: support literal for logLevels (#133)

close #130
unjs · Feb 25, 2022 · 22738ac · 22738ac
1 parent 5d291fb
commit 22738ac
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 6 deletions.
diff --git a/src/consola.js b/src/consola.js
@@ -1,5 +1,6 @@
-import Types from './types.js'
-import { isLogObj } from './utils/index.js'
+import { normalizeLogLevel } from './logLevels'
+import Types from './types'
+import { isLogObj } from './utils/index'
 
 let paused = false
 const queue = []
@@ -8,7 +9,7 @@ class Consola {
   constructor (options = {}) {
     this._reporters = options.reporters || []
     this._types = options.types || Types
-    this.level = options.level !== undefined ? options.level : 3
+    this._level = normalizeLogLevel(options.level, this._types)
     this._defaults = options.defaults || {}
     this._async = options.async !== undefined ? options.async : undefined
     this._stdout = options.stdout
@@ -41,6 +42,14 @@ class Consola {
     this._throttleTimeout = undefined
   }
 
+  get level () {
+    return this._level
+  }
+
+  set level (level) {
+    this._level = normalizeLogLevel(level, this._types)
+  }
+
   get stdout () {
     return this._stdout || console._stdout // eslint-disable-line no-console
   }

diff --git a/src/logLevels.js b/src/logLevels.js
@@ -9,3 +9,10 @@ LogLevel[LogLevel.Debug = 4] = 'Debug'
 LogLevel[LogLevel.Trace = 5] = 'Trace'
 LogLevel[LogLevel.Silent = -Infinity] = 'Silent'
 LogLevel[LogLevel.Verbose = Infinity] = 'Verbose'
+
+export function normalizeLogLevel (input, types = {}, defaultLevel = 3) {
+  if (input == null) { return defaultLevel }
+  if (typeof input === 'number') { return input }
+  if (types[input] && types[input].level != null) { return types[input].level }
+  return defaultLevel
+}
diff --git a/test/consola.test.js b/test/consola.test.js
@@ -1,4 +1,4 @@
-import { Consola, LogLevel } from '../src'
+import { Consola } from '../src'
 
 describe('consola', () => {
   test('can set level', () => {
@@ -21,7 +21,7 @@ describe('consola', () => {
 
     const consola = new Consola({
       throttle: 100,
-      level: LogLevel.Silent,
+      level: 'silent',
       reporters: [
         new TestReporter()
       ]

diff --git a/types/consola.d.ts b/types/consola.d.ts
@@ -13,6 +13,8 @@ export enum LogLevel {
   Verbose= Infinity,
 }
 
+export type LogLevelLiterals = 'fatal' | 'error' | 'warn' | 'log' | 'info' | 'success' | 'debug' | 'trace' | 'silent' | 'verbose'
+
 export type logType =
   | 'silent'
   | 'fatal'
@@ -28,7 +30,7 @@ export type logType =
   | 'start'
 
 export interface ConsolaLogObject {
-  level?: LogLevel,
+  level?: LogLevel | LogLevelLiterals,
   tag?: string,
   type?: logType,
   message?: string,