@docusaurus/logger

一个封装的记录器,用于模拟控制台信息的格式.

APIs 密码

它导出一个对象作为默认导出 : logger。 。 。 . logger 具有下列属性:

• 一些有用的颜色.
  • red
  • yellow
  • green
  • bold
  • dim
• 格式化软件。 这些函数都有签名 (msg: unknown) => string. 注意其执行得不到保证。 你应该只关心他们的语义.
  • path:格式化文件路径.
  • url: 格式化一个 URL.
  • name: 格式化一个标识符.
  • code:格式化代码片段.
  • subdue:将文字下接.
  • num:格式为数字.
• 这个 interpolate 函数。 这是一个模板字面标记。 语法如下.
• 日志函数 。 所有伐木功能都可以作为正常功能(类似于 console.log 家族,但只接受一个参数)或模板字面标记.
  • info:打印信息.
  • warn:打印一个应当注意的警告.
  • error:打印一个显示出重大问题的错误(不一定停止程序).
  • success: 打印成功的信息.
• 这个 report 函数。 它需要一个 ReportingSeverity 价值(ignore, (中文(简体) ), log, (中文(简体) ), warn, (中文(简体) ), throw),并根据严重程度报告信息.

说句话 error 主题

小心一点 error 消息,即使它不挂断程序, 也可能造成混乱。 当用户检查日志并找到 [ERROR]即使建筑成功 他们也会认为出事了 少用点.

仅使用 Docusaurus logger.error 当在投出错误之前打印信件,或者当用户设定了报告的严重程度时 onBrokenLink等,将 "error"。 。 。 .

还有, warn 财务报告和审定财务报表 error 将显示 整个 请大家注意 如果您在打印关于错误的大块帮助文本, 请更好地使用 logger.info。 。 。 .

使用模板字面标记

模板字面标记评价嵌入的模板和表达式. interpolate 返回新字符串,而其他日志函数则打印它。 下面是典型的用法:

import logger from '@docusaurus/logger';

logger.info`Hello name=${name}! You have number=${money} dollars. Here are the ${
  items.length > 1 ? 'items' : 'item'
} on the shelf: ${items}
To buy anything, enter code=${'buy x'} where code=${'x'} is the item's name; to quit, press code=${'Ctrl + C'}.`;

嵌入式表达式在形式上可选前加一面旗帜 [a-z]+= (几个小写字母,后面是等号,直接在嵌入式表达式之前). 如果表达式前没有标出任何旗帜,则以正字印刷出. 否则,它的格式化为一个格式化的:

• path=数字 : path
• url=数字 : url
• name=数字 : name
• code=数字 : code
• subdue=数字 : subdue
• number=数字 : num

如果表达式是数组,则格式化为: `\n- ${array.join('\n- ')}\n` (注意它会自动得到领先的一行终点). 每位成员都是自行格式化的,而项目符号没有格式化. 因此,你可以看到上面的信息被打印为: