fix(migrate): preserve comments in existing editor JSONC configs#1956
Merged
Conversation
Merging editor settings re-serialized the parsed object with JSON.stringify, dropping comments, key order, and trailing commas from existing .vscode/.zed files. Patch the original text with jsonc-parser instead so only missing keys are inserted and existing content is left untouched.
✅ Deploy Preview for viteplus-preview canceled.
|
Member
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep it up! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
- Share formatting detection via json.ts detectFormattingOptions - Extract applyJsoncEdit helper for the modify/applyEdits pattern - Use a Set for existing recommendation lookup - Ignore the JSONC snap-test fixtures in fmt so comments/trailing commas stay
fengmk2
added
test: e2e
TheAlexLichter
approved these changes
Jun 26, 2026
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
2 participants
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.
Problem
vp migratedropped comments from existing.vscode/.zedJSON(C) files. The merge parsed the file into an object and re-serialized it withJSON.stringify, losing comments, key order, and trailing commas.Fix
Patch the original text with
jsonc-parser(modify+applyEdits) instead of serializing a merged object. Only missing keys/branches are inserted; existing values, comments, and formatting are left untouched. Extension recommendations are appended without rebuilding the array, and a no-op merge no longer rewrites the file.Tests
editor.spec.tsto assert comment text survives, plus cases for nested comments, existing-values-win, trailing commas, extension dedup, idempotence, and Zed.migration-preserve-editor-jsonc-comments.