简介
在前端开发中,日志记录是非常重要的一环。npm 上有很多优秀的日志包,winson 是其中的一种常用的日志库。winston-console-formatter 是一个对 winston 日志库进行了格式化包装的 npm 库,它提供可以美观的控制台输出格式、颜色、时间等设置,以及支持多种输出方式,比如文件。
安装
在项目中安装使用 winston-console-formatter 非常简单,只需要使用 npm install 命令即可:
npm install winston-console-formatter --save
用法
安装完库后,我们就可以在项目中使用 winston-console-formatter。首先,我们需要引入库:
var winston = require('winston'); var formatter = require('winston-console-formatter')
接着,我们可以按照一下方式来设置格式和输出:
-- -------------------- ---- ------- --- ------- - - ---------- - ------- -- ------ - -- ------- - ------- ------- ------ -------- -- ---------------- ----------- --------- -- --- ------ - --- ------------------ ------ ------- ----------- - --- ------------------------------ ---------- ------------------ -- - --- ------------------- -- -- ------ ----- ------- ------------------ -- -- ----- ----- -------
我们来逐一分析这些设置项:
logLevels
我们可以自定义你的日志级别,通常它由 winston 的默认级别加上我们自定义的级别共同组成,例如“custom”,它优先级可以设置为0,当然,你也可以给其它级别定义为高优先级
colors
颜色设置是每一个前端开发者都喜欢玩耍的一项功能,我们可以对不同的级别设置颜色,比如 blue, white, red 等等。
winston-console-formatter 有以下内置的颜色:
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- gray
以上均为支持前景色,后景色的颜色直接在前面加上“bg”,比如“bgGreen”。
timestampFormat
输出的日志中如果带有时间戳,我们也可以自定义格式化。moment.js 是一个优秀的时间库,我们可以通过它来实现自定义时间格式输出:
var options = { timestampFormat: 'YYYY-MM-DD HH:mm:ss' };
示例代码
-- -------------------- ---- ------- --- ------- - ------------------- --- --------- - ------------------------------------ --- ------ - ------------------ --- ------- - - ---------- - ------- -- ------ - -- ------- - ------- ------- ------ -------- -- ---------------- ----------- --------- -- --- ------ - --- ------------------ ------ ------- ----------- - --- ------------------------------ ---------- ------------------ -- - --- ------------------- -- -- ------ ----- ------- ------------------ -- -- ----- ----- -------
总结
winston-console-formatter 提供了非常完整的设置项,许多常用的需求都能在里面找到对应的配置,如颜色、时间戳、级别等等。在开发过程中,不管是日志记录还是调试,都有这样的依赖有非常大的用处。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671108dd3466f61ffe311