CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.12.0](https://github.com/nuxt/consola/compare/v2.11.3...v2.12.0) (2020-05-07)
+
+
+### Features
+
+* **types:** add missing typescript definitions for reporters  ([#94](https://github.com/nuxt/consola/issues/94)) ([4a08ef0](https://github.com/nuxt/consola/commit/4a08ef02bc48ddc887f2b91713520eda50793a27))
+
 ### [2.11.3](https://github.com/nuxt/consola/compare/v2.11.2...v2.11.3) (2019-12-31)
 
 

README.md

@@ -20,7 +20,7 @@
 - Browser support
 - Pause/Resume support
 - Mocking support
-- Spam preventation by throttling logs
+- Spam prevention by throttling logs
 
 ## Installation
 
@@ -48,7 +48,11 @@ consola.info('Reporter: Some info')
 consola.error(new Error('Foo'))
 ```
 
-NOTE: Alternatively, you can import consola from source. But don't forget to whitelist it for transpilation:
+Will display in the terminal:
+
+![Screenshot 2020-01-28 at 14 15 15](https://user-images.githubusercontent.com/904724/73267133-af6b2f00-41d8-11ea-9f16-4a8243d19c43.png)
+
+**NOTE:** Alternatively, you can import consola from source. But don't forget to whitelist it for transpilation:
 
 ```js
 import consola from 'consola/src/node'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "consola",
-  "version": "2.11.3",
+  "version": "2.12.0",
   "description": "Elegant Console Logger for Node.js and Browser",
   "license": "MIT",
   "repository": "nuxt/consola",
@@ -34,39 +34,47 @@
     "unified",
     "winston"
   ],
-  "contributes": [
-    "Pooya Parsa <pooya@pi0.ir>",
-    "Clark Du (@clarkdo)",
-    "@pimlie <pimlie@hotmail.com>",
-    "Sébastien Chopin <seb@orion.sh>"
+  "contributors": [
+    {
+      "name": "Pooya Parsa <pooya@pi0.ir>"
+    },
+    {
+      "name": "Clark Du (@clarkdo)"
+    },
+    {
+      "name": "@pimlie <pimlie@hotmail.com>"
+    },
+    {
+      "name": "Sébastien Chopin <@Atinux>"
+    }
   ],
   "devDependencies": {
-    "@babel/core": "^7.7.7",
-    "@babel/preset-env": "^7.7.7",
-    "babel-eslint": "^10.0.3",
-    "babel-jest": "^24.9.0",
+    "@babel/core": "^7.9.6",
+    "@babel/preset-env": "^7.9.6",
+    "babel-eslint": "^10.1.0",
+    "babel-jest": "^26.0.1",
     "benchmark": "^2.1.4",
-    "bili": "^4.8.1",
-    "chalk": "^3.0.0",
-    "dayjs": "^1.8.18",
+    "bili": "^4.10.0",
+    "chalk": "^4.0.0",
+    "dayjs": "^1.8.26",
     "eslint": "^6.8.0",
-    "eslint-config-standard": "^14.1.0",
-    "eslint-plugin-import": "^2.19.1",
-    "eslint-plugin-jest": "^23.1.1",
-    "eslint-plugin-node": "^11.0.0",
+    "eslint-config-standard": "^14.1.1",
+    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-jest": "^23.9.0",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "esm": "^3.2.25",
-    "figures": "^3.1.0",
-    "jest": "^24.9.0",
+    "figures": "^3.2.0",
+    "jest": "^26.0.1",
     "lodash": "^4.17.15",
-    "sentencer": "^0.2.0",
-    "serve": "^11.2.0",
-    "standard-version": "^7.0.1",
+    "sentencer": "^0.2.1",
+    "serve": "^11.3.0",
+    "standard-version": "^8.0.0",
     "std-env": "^2.2.1",
     "string-width": "^4.2.0",
-    "ts-node": "^8.5.4",
-    "typescript": "^3.7.4",
+    "ts-node": "^8.10.1",
+    "typescript": "^3.8.3",
     "winston": "^3.2.1"
   }
 }

src/index.js

@@ -1,5 +1,6 @@
 export { default as Consola } from './consola'
 export { default as Types } from './types'
+export { LogLevel } from './logLevels'
 export { isLogObj } from './utils'
 export { assignGlobalConsola } from './utils/global'
 

src/logLevels.js

@@ -0,0 +1,10 @@
+export const LogLevel = {}
+LogLevel[LogLevel.Fatal = 0] = 'Fatal'
+LogLevel[LogLevel.Error = 0] = 'Error'
+LogLevel[LogLevel.Warn = 1] = 'Warn'
+LogLevel[LogLevel.Log = 2] = 'Log'
+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'

src/types.js

@@ -1,44 +1,46 @@
+import { LogLevel } from './logLevels'
+
 export default {
   // Level 0
   fatal: {
-    level: 0
+    level: LogLevel.Fatal
   },
   error: {
-    level: 0
+    level: LogLevel.Error
   },
   // Level 1
   warn: {
-    level: 1
+    level: LogLevel.Warn
   },
   // Level 2
   log: {
-    level: 2
+    level: LogLevel.Log
   },
   // Level 3
   info: {
-    level: 3
+    level: LogLevel.Info
   },
   success: {
-    level: 3
+    level: LogLevel.Success
   },
   // Level 4
   debug: {
-    level: 4
+    level: LogLevel.Debug
   },
   // Level 5
   trace: {
-    level: 5
+    level: LogLevel.Trace
   },
   // Silent
   silent: {
-    level: Infinity
+    level: LogLevel.Silent
   },
 
   // Legacy
   ready: {
-    level: 3
+    level: LogLevel.Info
   },
   start: {
-    level: 3
+    level: LogLevel.Info
   }
 }

types/consola.d.ts

@@ -1,10 +1,25 @@
+import { InspectOptions } from 'util';
+
+export enum LogLevel {
+  Fatal= 0,
+  Error= 0,
+  Warn= 1,
+  Log= 2,
+  Info= 3,
+  Success= 3,
+  Debug= 4,
+  Trace= 5,
+  Silent= Infinity,
+}
+
 export interface ConsolaLogObject {
-  level?: number,
+  level?: LogLevel,
   tag?: string,
   type?: string,
   message?: string,
   additional?: string | string[],
   args?: any[],
+  date?: Date,
 }
 
 type ConsolaMock = (...args: any) => void
@@ -13,8 +28,8 @@ type ConsolaMockFn = (type: string, defaults: ConsolaLogObject) => ConsolaMock
 
 export interface ConsolaReporterArgs {
   async: boolean,
-  stdout: any,
-  stderr: any,
+  stdout: NodeJS.WritableStream,
+  stderr: NodeJS.WritableStream,
 }
 
 export interface ConsolaReporter {
@@ -24,7 +39,7 @@ export interface ConsolaReporter {
 export interface ConsolaOptions {
   reporters?: ConsolaReporter[],
   types?: { [type: string]: ConsolaLogObject },
-  level?: number,
+  level?: LogLevel,
   defaults?: ConsolaLogObject,
   async?: boolean,
   stdout?: any,
@@ -36,7 +51,7 @@ export interface ConsolaOptions {
 export declare class Consola {
   constructor(options: ConsolaOptions)
 
-  level: number
+  level: LogLevel
   readonly stdout: any
   readonly stderr: any
 
@@ -87,8 +102,55 @@ export declare class Consola {
   mock(mockFn: ConsolaMockFn): any
 }
 
+export interface BasicReporterOptions {
+  dateFormat?: string;
+  formatOptions?: InspectOptions;
+}
+
+export declare class BasicReporter implements ConsolaReporter {
+  protected options: BasicReporterOptions;
+
+  constructor(options?: BasicReporterOptions);
+
+  public log(logObj: ConsolaLogObject, 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;
+}
+
+export interface FancyReporterOptions extends BasicReporterOptions{
+  secondaryColor?: string;
+}
+
+export declare class FancyReporter extends BasicReporter {
+  constructor(options?: FancyReporterOptions);
+
+  protected formatType(logObj: ConsolaLogObject): void;
+}
+
+export type BrowserReporterOptions = {};
+
 export declare class BrowserReporter implements ConsolaReporter {
-  log: (logObj: ConsolaLogObject, args: ConsolaReporterArgs) => void
+  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+}
+
+export type JSONReporterOptions = {
+  stream?: NodeJS.WritableStream;
+};
+
+export declare class JSONReporter implements ConsolaReporter {
+  constructor(options?: JSONReporterOptions);
+  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
+}
+
+export type Winston = any;
+
+export declare class WinstonReporter implements ConsolaReporter {
+  constructor(logger?: Winston);
+  public log(logObj: ConsolaLogObject, args: ConsolaReporterArgs): void;
 }
 
 declare const consolaGlobalInstance: Consola;