Skip to content

docs: sarif reporter#3772

Merged
Netail merged 3 commits intonextfrom
docs/sarif-reporter
Jan 7, 2026
Merged

docs: sarif reporter#3772
Netail merged 3 commits intonextfrom
docs/sarif-reporter

Conversation

@Netail
Copy link
Member

@Netail Netail commented Jan 2, 2026

Summary

Coupled to biomejs/biome#8631

@netlify
Copy link

netlify bot commented Jan 2, 2026

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 15b4014
🔍 Latest deploy log https://app.netlify.com/projects/biomejs/deploys/6957b987791c80000859d046
😎 Deploy Preview https://deploy-preview-3772--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Netail Netail added the Merge on release PRs that should be merged once the next minor in core is released label Jan 2, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 2, 2026

Walkthrough

Adds 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)
Check name Status Explanation
Title check ✅ Passed The title 'docs: sarif reporter' accurately and concisely summarises the main change: adding documentation for SARIF reporter support across multiple language files.
Description check ✅ Passed The description references a coupled PR and explains the purpose (SARIF reporter documentation), which is directly related to the changeset of adding SARIF reporter documentation.

Comment @coderabbitai help to get the list of available commands and usage tips.

@Netail Netail changed the base branch from main to next January 2, 2026 11:03
@Netail Netail requested a review from a team as a code owner January 2, 2026 12:26
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90aac9c and 15b4014.

📒 Files selected for processing (5)
  • src/content/docs/es/reference/reporters.mdx
  • src/content/docs/fr/reference/reporters.mdx
  • src/content/docs/ja/reference/reporters.mdx
  • src/content/docs/pl/reference/reporters.mdx
  • src/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/)に従った診断結果を出力するにはこのリポータを利用してください。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 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 1

Repository: 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.

@ematipico
Copy link
Member

How did you translate the other pages?

Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve only for the English part, so take my approval with a grain of salt

@Netail
Copy link
Member Author

Netail commented Jan 4, 2026

How did you translate the other pages?

Copied the text from RDJson, replaced rdjson with SARIF and verified with Google translate

@ematipico
Copy link
Member

@Netail this PR doesn't need to be merged on release, because it goes into next

@Netail Netail removed the Merge on release PRs that should be merged once the next minor in core is released label Jan 5, 2026
@Netail Netail requested review from chansuke and siketyan January 6, 2026 11:21
@Netail Netail merged commit 1af5368 into next Jan 7, 2026
9 checks passed
@Netail Netail deleted the docs/sarif-reporter branch January 7, 2026 08:31
@coderabbitai coderabbitai bot mentioned this pull request Feb 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants