Skip to content

docs(editor): Update the README for the vscode extension to clarify experimental setting#18048

Merged
leaysgur merged 2 commits intomainfrom
rm-deprecated-setting
Jan 16, 2026
Merged

docs(editor): Update the README for the vscode extension to clarify experimental setting#18048
leaysgur merged 2 commits intomainfrom
rm-deprecated-setting

Conversation

@connorshea
Copy link
Member

@connorshea connorshea commented Jan 16, 2026

The option is deprecated and the message in the README here was confusing, so this rephrases it. We may want to remove the setting entirely in the near future.

…e experimental formatting option, as it's deprecated.
@connorshea connorshea requested a review from camc314 as a code owner January 16, 2026 00:39
Copilot AI review requested due to automatic review settings January 16, 2026 00:39
@github-actions github-actions bot added A-editor Area - Editor and Language Server C-docs Category - Documentation. Related to user-facing or internal documentation labels Jan 16, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the VS Code extension README to remove confusing documentation about the deprecated oxc.fmt.experimental setting. The formatter is now stable, and this setting has no effect, so the experimental note was causing confusion for users.

Changes:

  • Removed documentation about the deprecated oxc.fmt.experimental setting from the README and configuration table
  • Updated Oxfmt configuration examples to remove references to the experimental flag
  • Made minor improvements to wording and consistency (e.g., "multi-root workspaces", "file types" instead of "files")

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@connorshea connorshea changed the title docs(editor): Update the README for the vscode extension to remove experimental note about oxfmt setting docs(editor): Update the README for the vscode extension to clarify experimental setting Jan 16, 2026
@leaysgur leaysgur merged commit 5346fc9 into main Jan 16, 2026
21 checks passed
@leaysgur leaysgur deleted the rm-deprecated-setting branch January 16, 2026 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-editor Area - Editor and Language Server C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants