npm 包 @jstp/logger 使用教程

简介

@jstp/logger 是一个 Node.js 环境下的日志输出工具，支持多种日志级别、文件输出等功能。在前端开发中，我们也常常需要对前端代码进行日志输出，@jstp/logger 可以帮助我们方便地输出指定的日志信息，方便我们进行前端代码的调试和问题追踪。

安装

使用 npm 进行安装：

npm install @jstp/logger

使用说明

初始化

const logger = require('@jstp/logger')({
  level: 'info', // 日志级别，默认为 info
  filePath: './logs/log.log', // 日志文件路径，为空则不输出到文件
  appendFile: true, // 是否在日志文件中追加，如为 false 则会覆盖原文件
  datePattern: 'YYYY-MM-DD',
  consoleFormatter: '%time %level %message', // 控制台输出格式，可自定义
  fileFormatter: '%time %level %message' // 日志文件输出格式，可自定义
});

输出日志

输出日志有 6 种不同的日志级别：

• trace
• debug
• info
• warn
• error
• fatal

logger.trace('Trace log message');
logger.debug('Debug log message');
logger.info('Info log message');
logger.warn('Warn log message');
logger.error('Error log message');
logger.fatal('Fatal log message');

自定义日志输出格式

使用 consoleFormatter 和 fileFormatter 两个参数来自定义当前日志输出的格式。

const logger = require('@jstp/logger')({
  level: 'info',
  consoleFormatter: (log) => `[${log.time}] [${log.level.toUpperCase()}] ${log.message}`,
  fileFormatter: (log) => `[${log.time}] [${log.level.toUpperCase()}] ${log.message}`
});

输出到文件

可以通过 filePath 参数来指定输出日志的文件路径。若未设置，则不会在文件中输出日志信息。同时，可以通过 appendFile 参数指定是否在文件中追加日志信息。

const logger = require('@jstp/logger')({
  level: 'info',
  filePath: './logs/log.log',
  appendFile: true
});

示例代码

-- -------------------- ---- -------
----- ------ - -------------------------
  ------ -------
  --------- -----------------
  ----------- ----
---

--------------- --- ---------- -- ------
-- -------
-- ------------ ------ -- --- -------

总结

@jstp/logger 提供了比较全面的日志输出功能，使用方便，同时也支持自定义日志输出格式和输出日志到文件中，可以帮助我们方便地进行前端代码的调试和问题追踪。在实际项目中，我们可以根据需求选择使用不同的日志级别并输出到不同的输出端。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bc4967216659e2442b9