Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughAdds a SARIF reporter section to the reference reporters documentation across multiple locales, introducing shell usage examples and full SARIF JSON samples (schema, version, runs, tool/driver, rules, results). Minor whitespace/formatting adjustments were made to existing RDJSON examples in some files. No public API, behavioural code, or exported declarations were changed. Pre-merge checks✅ Passed checks (2 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/content/docs/es/reference/reporters.mdxsrc/content/docs/fr/reference/reporters.mdxsrc/content/docs/ja/reference/reporters.mdxsrc/content/docs/pl/reference/reporters.mdxsrc/content/docs/zh-CN/reference/reporters.mdx
✅ Files skipped from review due to trivial changes (1)
- src/content/docs/zh-CN/reference/reporters.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/reference/reporters.mdx
[grammar] ~256-~256: Il y a peut-être une erreur ici
Context: ...F](https://sarifweb.azurewebsites.net/). shell biome check --reporter=sarif json { "$schema": "https://json.schemastore.org/sarif-2.1.0.json", "version": "2.1.0", "runs": [ { "tool": { "driver": { "name": "Biome", "informationUri": "https://biomejs.dev", "rules": [ { "id": "lint/correctness/noUnusedImports", "shortDescription": { "text": "Disallow unused imports." }, "helpUri": "https://biomejs.dev/linter/rules/no-unused-imports" } ] } }, "results": [ { "ruleId": "lint/correctness/noUnusedImports", "level": "warning", "message": { "text": "This import is unused." }, "locations": [ { "physicalLocation": { "artifactLocation": { "uri": "index.ts" }, "region": { "startLine": 1, "startColumn": 8, "endLine": 1, "endColumn": 12 } } } ] } ] } ] }
(QB_NEW_FR)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - biomejs
- GitHub Check: Header rules - biomejs
- GitHub Check: Pages changed - biomejs
- GitHub Check: test
🔇 Additional comments (5)
src/content/docs/pl/reference/reporters.mdx (2)
199-252: AI summary inaccuracy: RDJSON examples not removed.The enriched AI summary claims "Removes the RDJSON code examples (shell and JSON blocks)", but these examples are still present in the code. Only the SARIF section was added.
254-310: Documentation looks good – SARIF section is properly structured in the Polish translation.The SARIF reporter documentation matches the English version perfectly, with valid SARIF 2.1.0 schema and a clear example. Ready to merge.
src/content/docs/fr/reference/reporters.mdx (1)
254-310: AI summary is incorrect: RDJSON section remains intact.The RDJSON documentation (lines 195–252) is untouched. Only the SARIF section was added. The AI summary's claim that RDJSON code blocks were removed is inaccurate.
The SARIF documentation itself follows the established pattern correctly with proper schema reference, version, and example structure. Since this couples to biomejs/biome#8631, ensure the SARIF reporter implementation is merged before this documentation goes live.
src/content/docs/ja/reference/reporters.mdx (1)
254-310: SARIF section structure looks good.The documentation follows the established pattern consistently, with proper Japanese localization and a well-structured SARIF JSON example that includes all the key elements (schema, version, runs, tool metadata, rules, and results).
src/content/docs/es/reference/reporters.mdx (1)
254-310: SARIF documentation looks solid.The new SARIF reporter section follows the established pattern and the JSON structure is fully compliant with the SARIF 2.1.0 specification. External links are accessible and properly formatted.
|
|
||
| ## SARIF | ||
|
|
||
| [SARIF形式](https://sarifweb.azurewebsites.net/)に従った診断結果を出力するにはこのリポータを利用してください。 |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
official SARIF 2.1.0 specification documentation URL
💡 Result:
Official SARIF 2.1.0 specification (OASIS): https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html. [1]
Also useful: OASIS HTML package for the OASIS Standard edition: https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html. [2]
Sources:
[1] OASIS — SARIF v2.1.0 (specification).
[2] OASIS — SARIF v2.1.0 OASIS Standard (HTML).
🏁 Script executed:
#!/bin/bash
# Verify URL accessibility
echo "=== Checking SARIF website ==="
curl -sI "https://sarifweb.azurewebsites.net/" 2>&1 | head -n 1
echo "=== Checking JSON schema ==="
curl -sI "https://json.schemastore.org/sarif-2.1.0.json" 2>&1 | head -n 1
echo "=== Checking Biome docs main ==="
curl -sI "https://biomejs.dev" 2>&1 | head -n 1
echo "=== Checking Biome rule page ==="
curl -sI "https://biomejs.dev/linter/rules/no-unused-imports" 2>&1 | head -n 1Repository: biomejs/website
Length of output: 258
Use the official OASIS SARIF documentation URL instead.
The link https://sarifweb.azurewebsites.net/ is accessible but not the canonical source. The official SARIF 2.1.0 specification is at https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html (published by OASIS). Update line 256 to reference the authoritative documentation.
🤖 Prompt for AI Agents
In src/content/docs/ja/reference/reporters.mdx around line 256, the SARIF link
points to https://sarifweb.azurewebsites.net/ which is not the canonical source;
replace that URL with the official OASIS SARIF 2.1.0 specification URL
(https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) so the
documentation references the authoritative spec.
|
How did you translate the other pages? |
ematipico
left a comment
There was a problem hiding this comment.
I approve only for the English part, so take my approval with a grain of salt
Copied the text from RDJson, replaced rdjson with SARIF and verified with Google translate |
|
@Netail this PR doesn't need to be merged on release, because it goes into |
Summary
Coupled to biomejs/biome#8631