feat(json): sort_keys option to vim.json.encode()
#35574
Merged
Conversation
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
skewb1k
force-pushed
the
feat/json-sort-keys
branch
from
78ae531 to
70e61ec
Compare
skewb1k
commented
Aug 31, 2025
Problem: There is no way to ensure a stable key order when encoding a JSON string, which can be useful for comparisons and producing cleaner diffs. Solution: Introduce a `sort_keys` option for `vim.json.encode()`,which is disabled by default. When enabled, object keys are sorted in alphabetical order. Adapts PR to upstream: openresty/lua-cjson#115.
skewb1k
force-pushed
the
feat/json-sort-keys
branch
from
70e61ec to
bdcbc3b
Compare
Member
also for "stable" representation: https://github.com/ljharb/json-stable-stringify |
Contributor
Author
|
@justinmk that's partly what I meant by "comparisons". Should I update the commit message? |
dundargoc
pushed a commit
to dundargoc/neovim
that referenced
this pull request
Sep 27, 2025
Problem: There is no way to ensure a stable key order when encoding a JSON string, which can be useful for comparisons and producing cleaner diffs. Solution: Introduce a `sort_keys` option for `vim.json.encode()`,which is disabled by default. When enabled, object keys are sorted in alphabetical order.
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
There is no way to ensure a stable key order when encoding a JSON string, which can be useful for comparisons and producing cleaner diffs.
Solution
Introduce a
sort_keysoption forvim.json.encode(),which is disabled by default. When enabled, object keys are sorted in alphabetical order.Adapts PR to upstream: openresty/lua-cjson#115.
Uses the most performant approach to sort keys I could find. A small benchmark with comparisons is available here: https://github.com/skewb1k/lua-c-sort-keys-benchmark
Updates #34776 I guess? @echasnovski