Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 8x 8x | import winston from 'winston'
import { exception } from './format'
/**
* Interface to implement Logger levels
*/
interface LoggerLevelsInterface {
[index: string]: number
}
/**
* Interface to implement Logger Colors
*/
interface LoggerColorInterface {
[index: string]: string
}
/**
* Interface to defined log method structure
*/
interface LoggerMethod {
(message: string | Error, meta: Object): LoggerInterface
}
interface LoggerExceptionMethod {
(exception: Error): LoggerInterface
(message: string, exception: Error): LoggerInterface
}
/**
* Define available logger levels.
*/
const LoggerLevels: LoggerLevelsInterface = {
error: 0,
warn: 1,
info: 2,
debug: 4,
}
/**
* Define logger colors by levels
*/
const LoggerColor: LoggerColorInterface = {
error: 'red',
warn: 'orange',
info: 'white bold blue',
debug: 'white bold pink',
}
/**
* Interface to implement a Builder Box Logger
*/
export interface LoggerInterface {
/**
* This method render the error logs on the different transports.
*
* @param {string} message
* @param {Object} meta
* @returns {LoggerInterface}
*/
error: LoggerMethod
/**
* This method render the warning logs on the different transports.
*
* @param {string} message
* @param {Object} meta
* @returns {LoggerInterface}
*/
warn: LoggerMethod
/**
* This method render the info logs on the different transports.
*
* @param {string} message
* @param {Object} meta
* @returns {LoggerInterface}
*/
info: LoggerMethod
/**
* This method render the debugging logs on the different transports.
*
* @param {string} message
* @param {Object} meta
* @returns {LoggerInterface}
*/
debug: LoggerMethod
}
winston.addColors(LoggerColor)
export class Logger implements LoggerInterface {
/**
* @var {winston.Logger}
*/
private logger: winston.Logger
/**
* Logger constructor.
*
* @param {[winston.transport]} transports
*/
public constructor(transports: [winston.transport]) {
this.logger = winston.createLogger({
transports,
level: 'debug',
levels: LoggerLevels,
exitOnError: false,
format: winston.format.combine(
winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
winston.format.metadata({
fillExcept: ['message', 'level', 'timestamp', 'label'],
}),
exception(),
winston.format.printf((info) => {
const { timestamp, level, message, metadata } = info
return `[${timestamp}] ${level.toUpperCase()} ${message} ${JSON.stringify(
metadata
)}`
})
),
})
}
/**
* {@inheritdoc}
*/
public error(message: string | Error, meta: Object = {}): LoggerInterface {
return this.log('error', message, meta)
}
/**
* {@inheritdoc}
*/
public warn(message: string | Error, meta: Object = {}): LoggerInterface {
return this.log('warn', message, meta)
}
/**
* {@inheritdoc}
*/
public info(message: string | Error, meta: Object = {}): LoggerInterface {
return this.log('info', message, meta)
}
/**
* {@inheritdoc}
*/
public debug(message: string | Error, meta: Object = {}): LoggerInterface {
return this.log('debug', message, meta)
}
/**
* This method render logs by levels on the different transports.
*
* @param {string} level
* @param {string} message
* @param {Object} meta
* @returns {LoggerInterface}
*/
private log(
level: string,
message: string | Error,
meta: Object
): LoggerInterface {
this.logger[level](message, meta)
return this
}
}
|