docs(vcode): add example for editor.formatOnSave with editor.formatOnSaveMode#18126
Merged
graphite-app[bot] merged 1 commit intomainfrom Jan 17, 2026
Conversation
github-actions
bot
added
A-editor
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. |
Sysix
force-pushed
the
01-17-docs_vcode_add_example_for_editor.formatonsave_with_editor.formatonsavemode_
branch
from
e316f68 to
b211bac
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for VS Code's editor.formatOnSave and editor.formatOnSaveMode settings to help users properly configure automatic formatting with oxfmt. The change clarifies that oxfmt currently only supports formatting the entire file (not just modified lines) due to missing LSP specifications.
Changes:
- Added
editor.formatOnSaveandeditor.formatOnSaveModeconfiguration examples to the README - Included an inline comment explaining that oxfmt formats the whole file, not just modified lines
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
Merge activity
|
…tOnSaveMode` (#18126) VS Code can handle formatting on save in different ways. The configuration `editor.formatOnSaveMode` is responsible for it. The default value "file" will format the whole file. https://code.visualstudio.com/updates/v1_49#_only-format-modified-text Other values like `modifications` are not supported by `oxfmt` for the moment, because the missing LSP specs: - https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_rangeFormatting - (or) https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_onTypeFormatting Problem found in https://discord.com/channels/1079625926024900739/1461131443215405305/1461160171890938043
graphite-app
bot
force-pushed
the
01-17-docs_vcode_add_example_for_editor.formatonsave_with_editor.formatonsavemode_
branch
from
ead764c to
d8f5c66
Compare
graphite-app
bot
deleted the
01-17-docs_vcode_add_example_for_editor.formatonsave_with_editor.formatonsavemode_
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
1 participant
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.
VS Code can handle formatting on save in different ways. The configuration
editor.formatOnSaveModeis responsible for it.The default value "file" will format the whole file.
https://code.visualstudio.com/updates/v1_49#_only-format-modified-text
Other values like
modificationsare not supported byoxfmtfor the moment, because the missing LSP specs:Problem found in https://discord.com/channels/1079625926024900739/1461131443215405305/1461160171890938043