Reporters
从 v1.8.0 版本开始，Biome 的 CLI 接受一个 --reporter 参数，该参数允许更改诊断和摘要在终端中的打印方式。
Summary
Section titled “Summary”biome check --reporter=summaryreporter/parse ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ i The following files have parsing errors.
- index.css
reporter/format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ i The following files needs to be formatted.
- index.css - index.ts - main.ts
reporter/violations ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ i Some lint rules or assist actions reported some violations.
Rule Name Diagnostics
lint/correctness/noUnknownFunction 14 (2 error(s), 12 warning(s), 0 info(s)) lint/suspicious/noImplicitAnyLet 16 (12 error(s), 4 warning(s), 0 info(s)) lint/suspicious/noDoubleEquals 8 (8 error(s), 0 warning(s), 0 info(s)) assist/source/organizeImports 2 (2 error(s), 0 warning(s), 0 info(s)) lint/suspicious/noRedeclare 12 (12 error(s), 0 warning(s), 0 info(s)) lint/suspicious/noDebugger 8 (8 error(s), 0 warning(s), 0 info(s))以 JSON 格式发出摘要和诊断信息。
biome ci --reporter=jsonJSON pretty
Section titled “JSON pretty”与 --reporter=json 相同，它以 JSON 格式发出摘要和诊断信息，并且输出使用当前的 JSON 格式化选项（配置文件或默认值）进行格式化。
biome ci --reporter=json-prettyGitHub
Section titled “GitHub”在 GitHub 工作流中使用此 reporter。在 PR 工作流中正确配置后，GitHub 将为发出的每个 info/warning/error 打印一条消息。
biome ci --reporter=github::error title=lint/suspicious/noDoubleEquals,file=main.ts,line=4,endLine=4,col=3,endColumn=5::Use === instead of ==::error title=lint/suspicious/noDebugger,file=main.ts,line=6,endLine=6,col=1,endColumn=9::This is an unexpected use of the debugger statement.::error title=lint/nursery/noEvolvingAny,file=main.ts,line=8,endLine=8,col=5,endColumn=6::This variable's type is not allowed to evolve implicitly, leading to potential any types.biome check --reporter=junit<?xml version="1.0" encoding="UTF-8"?><testsuites name="Biome" tests="16" failures="16" errors="20" time="<TIME>"> <testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome"> <testcase name="org.biome.lint.suspicious.noDoubleEquals" line="4" column="3"> <failure message="Use === instead of ==. == is only allowed when comparing against `null`">line 3, col 2, Use === instead of ==. == is only allowed when comparing against `null`</failure> </testcase> </testsuite> <testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome"> <testcase name="org.biome.lint.suspicious.noDebugger" line="6" column="1"> <failure message="This is an unexpected use of the debugger statement.">line 5, col 0, This is an unexpected use of the debugger statement.</failure> </testcase> </testsuite> <testsuite name="main.ts" tests="1" disabled="0" errors="0" failures="1" package="org.biome"> <testcase name="org.biome.lint.nursery.noEvolvingAny" line="8" column="5"> <failure message="This variable's type is not allowed to evolve implicitly, leading to potential any types.">line 7, col 4, This variable's type is not allowed to evolve implicitly, leading to potential any types.</failure> </testcase> </testsuite></testsuites>Checkstyle
Section titled “Checkstyle”使用此 reporter 来发出遵循 Checkstyle 格式的诊断信息。
biome check --reporter=checkstyle<?xml version="1.0" encoding="utf-8"?><checkstyle version="4.3"> <file name="index.ts"> <error line="1" column="8" severity="warning" message="This import is unused." source="lint/correctness/noUnusedImports" /> <error line="2" column="10" severity="warning" message="Several of these imports are unused." source="lint/correctness/noUnusedImports" /> <error line="8" column="5" severity="warning" message="This variable f is unused." source="lint/correctness/noUnusedVariables" /> <error line="9" column="7" severity="warning" message="This variable f is unused." source="lint/correctness/noUnusedVariables" /> <error line="1" column="1" severity="error" message="The imports and exports are not sorted." source="assist/source/organizeImports" /> <error line="4" column="3" severity="error" message="Using == may be unsafe if you are relying on type coercion." source="lint/suspicious/noDoubleEquals" /> <error line="6" column="1" severity="error" message="This is an unexpected use of the debugger statement." source="lint/suspicious/noDebugger" /> <error line="8" column="5" severity="error" message="This variable implicitly has the any type." source="lint/suspicious/noImplicitAnyLet" /> <error line="9" column="7" severity="error" message="This variable implicitly has the any type." source="lint/suspicious/noImplicitAnyLet" /> <error line="2" column="10" severity="error" message="Shouldn't redeclare 'z'. Consider to delete it or rename it." source="lint/suspicious/noRedeclare" /> <error line="9" column="7" severity="error" message="Shouldn't redeclare 'f'. Consider to delete it or rename it." source="lint/suspicious/noRedeclare" /> <error line="0" column="0" severity="error" message="Formatter would have printed the following content:" source="format" /> </file> <file name="main.ts"> <error line="1" column="8" severity="warning" message="This import is unused." source="lint/correctness/noUnusedImports" /> <error line="2" column="10" severity="warning" message="Several of these imports are unused." source="lint/correctness/noUnusedImports" /> <error line="8" column="5" severity="warning" message="This variable f is unused." source="lint/correctness/noUnusedVariables" /> <error line="9" column="7" severity="warning" message="This variable f is unused." source="lint/correctness/noUnusedVariables" /> <error line="1" column="1" severity="error" message="The imports and exports are not sorted." source="assist/source/organizeImports" /> <error line="4" column="3" severity="error" message="Using == may be unsafe if you are relying on type coercion." source="lint/suspicious/noDoubleEquals" /> <error line="6" column="1" severity="error" message="This is an unexpected use of the debugger statement." source="lint/suspicious/noDebugger" /> <error line="8" column="5" severity="error" message="This variable implicitly has the any type." source="lint/suspicious/noImplicitAnyLet" /> <error line="9" column="7" severity="error" message="This variable implicitly has the any type." source="lint/suspicious/noImplicitAnyLet" /> <error line="2" column="10" severity="error" message="Shouldn't redeclare 'z'. Consider to delete it or rename it." source="lint/suspicious/noRedeclare" /> <error line="9" column="7" severity="error" message="Shouldn't redeclare 'f'. Consider to delete it or rename it." source="lint/suspicious/noRedeclare" /> <error line="0" column="0" severity="error" message="Formatter would have printed the following content:" source="format" /> </file></checkstyle>RDJSON
Section titled “RDJSON”使用此 reporter 来发出遵循 RDJSON 格式的诊断信息。
biome check --reporter=rdjson{ "source": { "name": "Biome", "url": "https://biomejs.dev" }, "diagnostics": [ { "code": { "url": "https://biomejs.dev/linter/rules/no-unused-imports", "value": "lint/correctness/noUnusedImports" }, "location": { "path": "index.ts", "range": { "end": { "column": 11, "line": 0 }, "start": { "column": 7, "line": 0 } } }, "message": "This import is unused." }, { "code": { "url": "https://biomejs.dev/linter/rules/no-unused-imports", "value": "lint/correctness/noUnusedImports" }, "location": { "path": "index.ts", "range": { "end": { "column": 10, "line": 1 }, "start": { "column": 9, "line": 1 } } }, "message": "Several of these imports are unused." } ]}Copyright (c) 2023-present Biome Developers and Contributors.