fix: silent log level does not work (unjs#98)

himanshiLt · Jun 20, 2022 · 15066d8 · 15066d8
1 parent 9cbcc83
commit 15066d8
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 14 deletions.
diff --git a/src/consola.js b/src/consola.js
@@ -48,6 +48,9 @@ class Consola {
     let max = 0
     for (const typeName in this._types) {
       const type = this._types[typeName]
+      if (type.level === Infinity || type.level === -Infinity) {
+        continue
+      }
       if (type.level > max) {
         max = type.level
       } else if (type.level < min) {

diff --git a/src/logLevels.js b/src/logLevels.js
@@ -7,4 +7,5 @@ LogLevel[LogLevel.Info = 3] = 'Info'
 LogLevel[LogLevel.Success = 3] = 'Success'
 LogLevel[LogLevel.Debug = 4] = 'Debug'
 LogLevel[LogLevel.Trace = 5] = 'Trace'
-LogLevel[LogLevel.Silent = Infinity] = 'Silent'
+LogLevel[LogLevel.Silent = -Infinity] = 'Silent'
+LogLevel[LogLevel.Verbose = Infinity] = 'Verbose'
diff --git a/src/types.js b/src/types.js
@@ -35,6 +35,10 @@ export default {
   silent: {
     level: LogLevel.Silent
   },
+  // Enable all log levels
+  verbose: {
+    level: LogLevel.Verbose
+  },
 
   // Legacy
   ready: {

diff --git a/test/consola.test.js b/test/consola.test.js
@@ -1,4 +1,4 @@
-import { Consola } from '../src'
+import { Consola, LogLevel } from '../src'
 
 describe('consola', () => {
   test('can set level', () => {
@@ -16,6 +16,31 @@ describe('consola', () => {
 
     consola.level = -99
     expect(consola.level).toBe(0)
+
+    consola.level = 99
+    expect(consola.level).toBe(5)
+  })
+
+  test('silent log level does\'t print logs', async () => {
+    const logs = []
+    class TestReporter {
+      log (logObj) {
+        logs.push(logObj)
+      }
+    }
+
+    const consola = new Consola({
+      throttle: 100,
+      level: LogLevel.Silent,
+      reporters: [
+        new TestReporter()
+      ]
+    })
+    for (let i = 0; i < 10; i++) {
+      consola.log('SPAM')
+    }
+    await wait(200)
+    expect(logs.length).toBe(0)
   })
 
   test('can see spams without ending log', async () => {

diff --git a/types/consola.d.ts b/types/consola.d.ts
@@ -9,7 +9,8 @@ export enum LogLevel {
   Success= 3,
   Debug= 4,
   Trace= 5,
-  Silent= Infinity,
+  Silent= -Infinity,
+  Verbose= Infinity,
 }
 
 export interface ConsolaLogObject {
@@ -22,6 +23,14 @@ export interface ConsolaLogObject {
   date?: Date,
 }
 
+export interface ConsolaReporterLogObject {
+  level: LogLevel,
+  type: string,
+  tag: string;
+  args: any[],
+  date: Date,
+}
+
 type ConsolaMock = (...args: any) => void
 
 type ConsolaMockFn = (type: string, defaults: ConsolaLogObject) => ConsolaMock
@@ -33,7 +42,7 @@ export interface ConsolaReporterArgs {
 }
 
 export interface ConsolaReporter {
-  log: (logObj: ConsolaLogObject, args: ConsolaReporterArgs) => void
+  log: (logObj: ConsolaReporterLogObject, args: ConsolaReporterArgs) => void
 }
 
 export interface ConsolaOptions {
@@ -42,8 +51,8 @@ export interface ConsolaOptions {
   level?: LogLevel,
   defaults?: ConsolaLogObject,
   async?: boolean,
-  stdout?: any,
-  stderr?: any,
+  stdout?: NodeJS.WritableStream,
+  stderr?: NodeJS.WritableStream,
   mockFn?: ConsolaMockFn,
   throttle?: number,
 }
@@ -52,8 +61,8 @@ export declare class Consola {
   constructor(options: ConsolaOptions)
 
   level: LogLevel
-  readonly stdout: any
-  readonly stderr: any
+  readonly stdout: NodeJS.WritableStream
+  readonly stderr: NodeJS.WritableStream
 
   // Built-in log levels
   fatal(message: ConsolaLogObject | any, ...args: any[]): void
@@ -112,13 +121,13 @@ export declare class BasicReporter implements ConsolaReporter {
 
   constructor(options?: BasicReporterOptions);
 
-  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+  public log(logObj: ConsolaReporterLogObject, args: ConsolaReporterArgs): void;
 
   protected formatStack(stack: string): string;
   protected formatArgs(args: any[]): string;
   protected formatDate(date: Date): string;
   protected filterAndJoin(arr: Array<string | undefined>): string;
-  protected formatLogObj(logObj: ConsolaLogObject): string;
+  protected formatLogObj(logObj: ConsolaReporterLogObject): string;
 }
 
 export interface FancyReporterOptions extends BasicReporterOptions{
@@ -128,13 +137,13 @@ export interface FancyReporterOptions extends BasicReporterOptions{
 export declare class FancyReporter extends BasicReporter {
   constructor(options?: FancyReporterOptions);
 
-  protected formatType(logObj: ConsolaLogObject): void;
+  protected formatType(logObj: ConsolaReporterLogObject): void;
 }
 
 export type BrowserReporterOptions = {};
 
 export declare class BrowserReporter implements ConsolaReporter {
-  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+  public log(logObj: ConsolaReporterLogObject, args: ConsolaReporterArgs): void;
 }
 
 export type JSONReporterOptions = {
@@ -143,14 +152,14 @@ export type JSONReporterOptions = {
 
 export declare class JSONReporter implements ConsolaReporter {
   constructor(options?: JSONReporterOptions);
-  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+  public log(logObj: ConsolaReporterLogObject, args: ConsolaReporterArgs): void;
 }
 
 export type Winston = any;
 
 export declare class WinstonReporter implements ConsolaReporter {
   constructor(logger?: Winston);
-  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+  public log(logObj: ConsolaReporterLogObject, args: ConsolaReporterArgs): void;
 }
 
 declare const consolaGlobalInstance: Consola;