feature: add option to sort encoded object keys - #115
Open
arkriny wants to merge 3 commits into
Open
Conversation
arkriny
force-pushed
the
feat/sort-keys
branch
2 times, most recently
from
August 31, 2025 18:54
91af5a5 to
51bace7
Compare
arkriny
added a commit
to arkriny/neovim
that referenced
this pull request
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.
arkriny
marked this pull request as ready for review
August 31, 2025 19:41
arkriny
added a commit
to arkriny/neovim
that referenced
this pull request
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.
arkriny
added a commit
to arkriny/neovim
that referenced
this pull request
Sep 9, 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.
arkriny
force-pushed
the
feat/sort-keys
branch
from
September 20, 2025 09:02
51bace7 to
7819ac4
Compare
arkriny
force-pushed
the
feat/sort-keys
branch
from
February 9, 2026 15:28
7819ac4 to
f945fde
Compare
Author
|
Rebased on latest master |
|
I will review it when I am free. |
zhuizhuhaomeng
requested changes
Feb 10, 2026
arkriny
force-pushed
the
feat/sort-keys
branch
from
February 10, 2026 02:02
f945fde to
0360295
Compare
Author
|
I changed the memory strategy: encode_keybuf is now persistent between calls (like encode_buf with encode_keep_buffer). It's only allocated or freed when the settings change. What do you think, is this better? |
|
It is better, but we need to free it if it is too large. |
arkriny
force-pushed
the
feat/sort-keys
branch
from
February 10, 2026 15:45
0360295 to
e6c4351
Compare
zhuizhuhaomeng
requested changes
Feb 21, 2026
|
Tick the box to add this pull request to the merge queue (same as
|
Author
|
Rebased on master and addressed keybuf memory management. |
Preserve fractional numbers, Lua integers, and binary string keys when looking up sorted object values. Sort keys before JSON escaping and break serialized numeric-key ties deterministically. Reset freed key buffers, guard entry allocation growth, and free the output buffer on numeric-key errors when buffer retention is disabled. Add regression coverage for key ordering, key preservation, large-object buffer reuse, and recovery after encoding errors. All 148 tests pass on Lua 5.4 and system LuaJIT.
Clean Makefile artifacts and recreate the build directory before each CMake variant. Use explicit source and build paths for configuration and the CMake build command. Validated with bash -n runtests.sh. The full build-matrix runner was not executed; the Lua 5.4 and LuaJIT suites passed separately.
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
3 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.
Adds
cjson.encode_sort_keys(enabled)option.If enabled, keys in encoded objects will be sorted in alphabetical order.
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.
Fixes #66