xlogger-pretty

A logger as pretty and easy to use as the Python logging library.

Install

npm install xlogger-pretty
yarn add xlogger-pretty

Quick Start

import Logger from 'xlogger-pretty'

const logger = new Logger()

logger.log('This is a normal log.')
logger.info('This is an info log.')
logger.debug('This is a debug log.')
logger.notice('This is a notice log.')
logger.warn('This is a warn log.')
logger.error('This is an error log.')
logger.success('This is a success log.')

Options

| name | type | default | desc | | -------------- | ------------- | ------------------- | ------------------------------------------------------------ | | level | number/string | 0 | 日志输出级别，可以数字或者字符串，详情见下面Level说明 | | format | string | [label] [msg] | 自定义日志输出格式 | | datetimeFormat | string | YYYY-MM-DD HH:mm:ss | 日志时间格式 | | msgColor | boolean | false | 日志内容是否为彩色 | | wrapLabel | boolean | false | 日志标签是否被[]包裹 | | uppercaseLabel | boolean | false | 日志标签是否大写 | | colors | object | null | 自定义日志标签输出颜色, { success: green }，颜色值取kolorist库中的颜色函数 (import { green } from 'kolorist') |

Custom Colors

import * as colors from 'kolorist'

const logger = new Logger({
  uppercaseLabel: true,
  colors: {
    info: colors.bgBlue,
    debug: colors.bgMagenta,
    notice: colors.bgCyan,
    warn: colors.bgYellow,
    error: colors.bgRed,
    success: colors.bgGreen
  }
})

logger.info('This is an info log.')
logger.debug('This is a debug log.')
logger.notice('This is a notice log.')
logger.warn('This is a warn log.')
logger.error('This is an error log.')
logger.success('This is a success log.')

Custom Display Format

Level log方法不受级别控制

| LevelString | LevelNumber | | ----------- | ----------- | | success | 0 | | debug | 1 | | info | 2 | | notice | 3 | | warn | 4 | | error | 5 |

Exposed variable

| name | default | desc | | -------- | ------------------------------------ | -------- | | label | info/debug/notice/warn/error/success | 日志标签 | | msg | msg | 日志内容 | | datetime | 2021-07-05 17:21:01 | 当前时间 |

Example

[xxx] format占位标记， 实际运行会转换为真实的值。

const logger = new Logger({
  format: '[datetime] - [label] - [msg]',
  wrapLabel: true,
  uppercaseLabel: true,
  msgColor: true
})

logger.log('This is a normal log.')
logger.info('This is an info log.')
logger.debug('This is a debug log.')
logger.notice('This is a notice log.')
logger.warn('This is a warn log.')
logger.error('This is an error log.')
logger.success('This is a success log.')