Skip to content

feat: document editor options#3782

Merged
ematipico merged 2 commits intonextfrom
feat/document-vscode-inlineconfig
Jan 6, 2026
Merged

feat: document editor options#3782
ematipico merged 2 commits intonextfrom
feat/document-vscode-inlineconfig

Conversation

@ematipico
Copy link
Member

Summary

Part of biomejs/biome#8278

@netlify
Copy link

netlify bot commented Jan 4, 2026

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 852d29f
🔍 Latest deploy log https://app.netlify.com/projects/biomejs/deploys/695a4c1659595d0008b3be7e
😎 Deploy Preview https://deploy-preview-3782--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.

@ematipico ematipico requested review from a team January 4, 2026 10:45
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 4, 2026

Walkthrough

Documentation updates to the VS Code and Zed extension reference guides adding a new inline Biome configuration option (biome.inlineConfig / inline_config), plus require_config_file and config_path for Zed. JSON examples demonstrate how inline configuration overrides disk-based biome.json or defaults and show require_config_file behaviour. No code or runtime changes; only docs content and structure were modified.

Possibly related PRs

  • feat: document inline config #3557 — Adds documentation for the same inline configuration setting (inline_config / biome.inlineConfig) across editor integrations, overlapping with these docs changes.

Suggested reviewers

  • chansuke
  • dyc3

Pre-merge checks

✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: documenting editor options (inlineConfig, require_config_file, config_path) for VS Code and Zed integrations.
Description check ✅ Passed The description references a related upstream PR and correctly identifies this as part of broader feature work, which aligns with the documentation additions for editor configuration options.

📜 Recent 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 851db29 and 852d29f.

📒 Files selected for processing (1)
  • src/content/docs/reference/vscode.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/reference/vscode.mdx
⏰ 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

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

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

🧹 Nitpick comments (3)
src/content/docs/reference/vscode.mdx (1)

154-156: Missing Default and Scopes metadata.

Other settings in this document include Default: and Scopes: information (e.g., lines 128, 138, 144). Consider adding the same metadata here for consistency.

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

34-50: Consider adding a default value for config_path.

The require_config_file section has a > Default: \false`` callout. For consistency, it would be helpful to add similar default information here (presumably the workspace root).


136-148: Duplicate content.

This section duplicates the require_config_file documentation from lines 52-68. Consider removing this section or consolidating into a cross-reference.

🔎 Suggested fix
-### Enable biome only when biome.json is present
-
-```json5 title=".zed/settings.json"
-{
-  "lsp": {
-    "biome": {
-      "settings": {
-        "require_config_file": true
-      }
-    }
-  }
-}
-```
+### Enable biome only when biome.json is present
+
+See the [`require_config_file`](#require_config_file) configuration option.
📜 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 c428052 and 851db29.

📒 Files selected for processing (2)
  • src/content/docs/reference/vscode.mdx
  • src/content/docs/reference/zed.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/reference/zed.mdx

[uncategorized] ~88-~88: 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)

src/content/docs/reference/vscode.mdx

[uncategorized] ~172-~172: 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 (1)
src/content/docs/reference/zed.mdx (1)

70-108: Good documentation for inline_config.

Clear explanation with a practical example showing how to override biome.json settings locally. The example is consistent with the VS Code documentation.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@arendjr arendjr left a comment

Choose a reason for hiding this comment

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

Love it!

@ematipico ematipico merged commit 7c2a01a into next Jan 6, 2026
8 checks passed
@ematipico ematipico deleted the feat/document-vscode-inlineconfig branch January 6, 2026 09:25
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.

2 participants