feat(oxfmt): sort package.json files before formatting#16541
Closed
feat(oxfmt): sort package.json files before formatting#16541
Conversation
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
CodSpeed Performance ReportMerging #16541 will not alter performanceComparing Summary
Footnotes
|
This was referenced Dec 8, 2025
Member
|
Will continue on #16593 |
taearls
pushed a commit
to taearls/oxc
that referenced
this pull request
Dec 11, 2025
…xc-project#16593) Fixes oxc-project#16525, closes oxc-project#16541 - Use `sort-package-json: 0.0.2` - Enable by default, can be disabled by `experimentalSortPackageJson: false`
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.
Note: This is a reference implementation. closes #16525
Summary
Integrates the
sort-package-jsonRust crate into oxfmt to automatically sortpackage.jsonfiles according to npm conventions before passing them to Prettier for final formatting.Changes
sort-package-jsonv0.0.1 dependencypackage_json_sortermodule with sorting logicformat_by_external_formatter()to detect and sortpackage.jsonfilesBehavior
✅ package.json files are sorted - Fields reordered according to npm conventions (name, version, description, scripts, dependencies, etc.)
✅ Sorting happens before Prettier - The sorted JSON is then formatted by Prettier for consistent spacing
✅ package-lock.json is NOT sorted - Only files named exactly "package.json" are affected
✅ Other JSON files unaffected - Regular .json files continue to work normally
✅ Error handling - Invalid JSON returns clear error messages
Example
Before:
{ "version": "1.0.0", "dependencies": { "lodash": "^4.17.21" }, "name": "my-app", "scripts": { "test": "echo test" } }After:
{ "name": "my-app", "version": "1.0.0", "scripts": { "test": "echo test" }, "dependencies": { "lodash": "^4.17.21" } }Test plan
cargo test -p oxfmt)just fmt)cargo clippy -p oxfmt)🤖 Generated with Claude Code