feat: document inline config

[ematipico]

Summary

Part of biomejs/biome#8278

[netlify]

✅ Deploy Preview for biomejs ready!

Name	Link
🔨 Latest commit	f6ec579
🔍 Latest deploy log	https://app.netlify.com/projects/biomejs/deploys/692e9d8d65de98000836f1d8
😎 Deploy Preview	https://deploy-preview-3557--biomejs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai]

Walkthrough

Added documentation for three editor extension settings exposed by the Biome Language Server: a boolean to require configuration, a string path for configuration files, and an object for inline overrides, each with examples. Also updated reference docs to use json5 code fences, expanded per-language formatter entries, and standardised headings and code block formatting.

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects the main change: documenting inline config settings in the editor extension guide.
Description check	✅ Passed	The description references the related upstream PR, providing context for the documentation changes even if minimal.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/document-inline-config

---

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

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

src/content/docs/guides/editors/create-an-extension.mdx (1)

73-73: Grammar error and missing context on configuration_path.

Line 73 contains a grammar error: "read" should be "reads". Additionally, the description lacks context about when to use this setting. The previous review suggested clarifying that this is useful "when the configuration is in a subfolder of your project".

-The path *should* be an absolute. The Biome Language Server read this option only when provided.
+The path can be relative or absolute. The Biome Language Server reads this option only when provided. Use this option when the configuration is *in a subfolder of your project*.

🧹 Nitpick comments (2)

src/content/docs/guides/editors/create-an-extension.mdx (1)

102-102: Possible comma splice for readability.

Line 102 uses "and" to connect two related thoughts within a "because" clause. Adding a comma before "and" would improve clarity: "…because it's useful, and you don't want to see red squiggles."

This is flagged by static analysis. Consider adding the comma if you agree it improves readability.

src/content/docs/reference/zed.mdx (1)

38-48: Verify code fence language choice.

The code fence language has been changed from json to json5 with titles. This is reasonable for settings files, but verify that the examples actually require JSON5 features (e.g., comments, trailing commas) rather than being standard JSON. If they're standard JSON, consider reverting to json for technical accuracy, though json5 is not incorrect.

Do the configuration examples in these blocks use JSON5-specific syntax, or are they valid standard JSON?

Also applies to: 54-71, 77-87, 91-117, 129-137

📜 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 6959fa3 and 8e64103.

📒 Files selected for processing (2)

• src/content/docs/guides/editors/create-an-extension.mdx (1 hunks)
• src/content/docs/reference/zed.mdx (6 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-11-28T01:34:31.066Z

Learnt from: CR
Repo: biomejs/website PR: 0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-11-28T01:34:31.066Z
Learning: Set the BIOME_VERSION environment variable when running codegen commands (e.g., BIOME_VERSION=2.0.0 pnpm codegen all)

Applied to files:

• src/content/docs/reference/zed.mdx

🪛 LanguageTool

src/content/docs/guides/editors/create-an-extension.mdx

[uncategorized] ~102-~102: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...to disable this rule because it's useful and you don't want to see red squiggles. In...

(COMMA_COMPOUND_SENTENCE)

⏰ 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: test
• GitHub Check: Redirect rules - biomejs
• GitHub Check: Header rules - biomejs
• GitHub Check: Pages changed - biomejs

🔇 Additional comments (1)

src/content/docs/reference/zed.mdx (1)

57-68: Comprehensive language formatter configuration expansion.

Excellent addition—the formatter configuration now covers all supported Biome languages. This makes the documentation much more complete for users wanting per-language setup.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/content/docs/guides/editors/create-an-extension.mdx (1)

81-116: inline_config example is helpful, but line 102 needs a punctuation tweak for clarity.

The practical example showing configuration override is useful. However, line 102 reads: "…you want to disable this rule because it's useful and you don't want to see red squiggles." This compound reason is clearer with a minor rewrite to separate the two reasons or add clarifying punctuation.

Consider rewriting line 102 as:

-However, during local development, you want to disable this rule because it's useful and you don't want to see red squiggles.
+However, during local development, you want to disable this rule: it's useful, and you don't want to see red squiggles.

Alternatively, restructure to:

-However, during local development, you want to disable this rule because it's useful and you don't want to see red squiggles.
+However, during local development, you want to disable this rule because it's useful and because you don't want to see red squiggles.

Either approach makes the dual rationale clearer.

📜 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 8e64103 and 51291e8.

📒 Files selected for processing (1)

• src/content/docs/guides/editors/create-an-extension.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

src/content/docs/guides/editors/create-an-extension.mdx

[uncategorized] ~102-~102: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...to disable this rule because it's useful and you don't want to see red squiggles. In...

(COMMA_COMPOUND_SENTENCE)

⏰ 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 (3)

src/content/docs/guides/editors/create-an-extension.mdx (3)

42-51: Well-structured new section with clear guidance for extension developers.

The introduction explains the purpose succinctly and the Zed example effectively illustrates how extensions may expose these settings differently. Good context-setting.

---

53-64: require_configuration documentation now complete.

The description correctly clarifies that parsing continues whilst analysis is deferred until a biome.json appears in the project root, addressing the previous review feedback. The example is clear.

---

66-79: configuration_path documentation is comprehensive.

The description properly covers both relative and absolute paths, and the subfolder use case is clearly explained. The example is practical.