feat(oxfmt): Add more Oxfmtrc fields description#17979
Merged
graphite-app[bot] merged 1 commit intomainfrom Jan 14, 2026
Merged
feat(oxfmt): Add more Oxfmtrc fields description#17979graphite-app[bot] merged 1 commit intomainfrom
Oxfmtrc fields description#17979graphite-app[bot] merged 1 commit intomainfrom
Conversation
github-actions
bot
added
A-cli
Member
Author
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
leaysgur
changed the title
Oxfmtrc fields description
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation for Oxfmt configuration options by adding more detailed descriptions, clarifying default values, and providing additional context for each option. The changes primarily improve the developer experience by making the configuration more understandable.
Changes:
- Improved documentation format with consistent default value notation (e.g., "- Default:
value") - Added comprehensive descriptions for experimental sort imports options with detailed explanations of selectors and modifiers
- Enhanced descriptions for Prettier-compatible options to clarify their behavior across multiple file types
- Added notes about .editorconfig overrides and feature limitations
- Standardized "NOTE:" prefix for important information
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| apps/oxfmt/src/core/oxfmtrc.rs | Enhanced source documentation for all configuration options with detailed descriptions and consistent formatting |
| tasks/website_formatter/src/snapshots/schema_markdown.snap | Updated markdown snapshot reflecting documentation improvements |
| tasks/website_formatter/src/snapshots/schema_json.snap | Updated JSON schema snapshot with enhanced descriptions |
| npm/oxfmt/configuration_schema.json | Updated NPM package schema with improved documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leaysgur
force-pushed
the
01-14-feat_oxfmt_add_more_oxfmtrc_docs_description
branch
from
d95fcef to
56c3c5b
Compare
leaysgur
force-pushed
the
01-14-feat_oxfmt_add_more_oxfmtrc_docs_description
branch
3 times, most recently
from
a906616 to
364b183
Compare
Dunqing
approved these changes
Jan 14, 2026
Contributor
Merge activity
|
Added more description with consistent notation.
graphite-app
bot
force-pushed
the
01-14-feat_oxfmt_add_more_oxfmtrc_docs_description
branch
from
364b183 to
6ffe315
Compare
graphite-app
bot
deleted the
01-14-feat_oxfmt_add_more_oxfmtrc_docs_description
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added more description with consistent notation.