诊断信息

了解 Biome 诊断信息的结构与内容。

Biome 诊断信息以结构化格式解释错误、警告和其他事件。它们通常会提供你理解和解决问题所需的上下文。

本页解释诊断信息的每个部分，以及如何解读它。

诊断严重性等级

一条诊断信息的严重性等级决定了 Biome 如何报告它，并可能影响 CLI。例如，一个错误会导致 CLI 以非零状态码退出。

致命

致命诊断信息使用红色文本，表示 Biome 内部发生了未预期的错误。与错误诊断信息不同，它们会包含 fatal 标签。

FATAL官方生成的诊断输出样例

 FATAL  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
  ⚠ Biome exited as this error could not be handled and resulted in a fatal error. Please report it if necessary.

错误

错误诊断信息使用红色文本，通常都应处理。出现时，CLI 会失败并退出。

ERROR官方生成的诊断输出样例

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

警告

警告诊断信息使用黄色文本，通常都应处理。默认情况下，它们不会导致 CLI 失败。

WARNING官方生成的诊断输出样例

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This diagnostic message is displayed in a color that reflects its severity.

信息

信息类诊断使用绿色文本。它们提供有用的上下文，且不会导致 CLI 失败。

INFORMATION官方生成的诊断输出样例

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This diagnostic message is displayed in a color that reflects its severity.

诊断标签

标签是附加在诊断信息上的元数据。它们可以改变客户端显示或处理诊断信息的方式。

详细

详细诊断信息默认隐藏。要在 CLI 中显示它们，请传入 --verbose 选项。

VERBOSE官方生成的诊断输出样例

 VERBOSE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

内部

内部诊断信息表示 Biome 内部发生了未预期的错误。如果你遇到一个，请在 GitHub 上提交错误报告。

INTERNAL官方生成的诊断输出样例

 INTERNAL  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
  ⚠ This diagnostic was derived from an internal Biome error. Potential bug, please report it if necessary.

可修复

可修复诊断信息表示有一个可用的修复方案。它们常用于 lint 诊断信息，这类诊断会提供一个可供用户审阅并应用的代码操作。

FIXABLE官方生成的诊断输出样例

 FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

已弃用

已弃用诊断信息用于标识已经过时、不应再使用的代码或配置。

DEPRECATED官方生成的诊断输出样例

 DEPRECATED  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

诊断类别

诊断类别是一个用于标识所报告问题类型的标识符。它出现在诊断信息的头部，可以用来标识一个命令、子系统或规则。

CATEGORY SIMPLE官方生成的诊断输出样例

check ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

某些类别还可以包含一个链接。例如，lint/a11y/noAccessKey 会链接到该 lint 规则的文档：

CATEGORY LINK官方生成的诊断输出样例

lint/a11y/noAccessKey ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

诊断位置

一条诊断信息可以包含文件路径、源代码和一段高亮范围，用来显示问题发生的位置。每个部分都是可选的，因此 Biome 会显示所有可用的上下文。

文件路径用于标识诊断信息所指向的文件，即使没有源代码或确切位置也可以：

LOC FILE官方生成的诊断输出样例

path/to/file.js ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.

当有源代码和一段高亮范围时，Biome 会显示一个代码框架来指向相关文本。代码框架可以在没有文件路径的情况下出现，此时头部不包含行号和列号：

LOC FRAME官方生成的诊断输出样例

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
  > 1 │ Some source code
      │      ^^^^^

当三个部分都具备时，Biome 会在文件路径后加上高亮范围起始处的行号和列号：

LOC ALL官方生成的诊断输出样例

path/to/file.txt:1:6 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
  > 1 │ Some source code
      │      ^^^^^^

一段高亮范围可以跨越多个行。在许多 IDE 内置的终端中，你可以点击诸如 path/to/file.js:2:2 这样的位置，来打开文件并把光标放到该范围的起始处：

LOC MULTILINE官方生成的诊断输出样例

path/to/file.js:2:2 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
    1 │ function name() {
  > 2 │ 	return 'lorem'
      │ 	^^^^^^^^^^^^^^
    3 │ }

诊断建议

诊断信息可以在主要消息之后包含建议。建议有多种形式，默认会显示。详细的建议只有在你传入 --verbose 选项时才会显示。

WITH ADVICE官方生成的诊断输出样例

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This diagnostic message is displayed in a color that reflects its severity.
  
  ✖ An error message.
  
  ⚠ A warning message.
  
  ℹ An informational message.
  
  An unstyled message can introduce a command:
  
  $ biome command
  
  Messages can be grouped under a heading:
  
  Related information
  
    ℹ First message of a group.
    
    ℹ Second message of a group.
    
  Messages can also be displayed as a list:
  
  - First item
  - Second item
  
  A diff can show a suggested change:
  
  - Old·code
  + New·code
  
  A code frame can highlight a source range:
  
  > 1 │ Lorem
      │ ^^^
    2 │ Ipsum