mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-04-20 14:25:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(stdlib): vim.json.decode() can allow comments #37795

Browse Source 
Problem:
`vim.json.decode()` could not parse JSONC (JSON with Comments)
extension, which is commonly used in configuration files.

Solution:
Introduce an `skip_comments` option, which is disabled by default. When
enabled, allows JavaScript-style comments within JSON data.
This commit is contained in:
skewb1k
2026-02-11 14:54:57 +03:00
committed by GitHub
parent 3567b7d751
commit 6b4ec2264e
5 changed files with 106 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
test/functional/lua/json_spec.lua
View File

@@ -146,6 +146,38 @@ describe('vim.json.decode()', function()
local str = ('%s{%s"key"%s:%s[%s"val"%s,%s"val2"%s]%s,%s"key2"%s:%s1%s}%s'):gsub('%%s', s)
eq({ key = { 'val', 'val2' }, key2 = 1 }, exec_lua([[return vim.json.decode(...)]], str))
end)
it('skip_comments', function()
eq({}, exec_lua([[return vim.json.decode('{//comment\n}', { skip_comments = true })]]))
eq({}, exec_lua([[return vim.json.decode('{//comment\r\n}', { skip_comments = true })]]))
eq(
'test // /* */ string',
exec_lua(
[[return vim.json.decode('"test // /* */ string"//comment', { skip_comments = true })]]
)
)
eq(
{},
exec_lua([[return vim.json.decode('{/* A multi-line\ncomment*/}', { skip_comments = true })]])
)
eq(
{ a = 1 },
exec_lua([[return vim.json.decode('{"a" /* Comment */: 1}', { skip_comments = true })]])
)
eq(
{ a = 1 },
exec_lua([[return vim.json.decode('{"a": /* Comment */ 1}', { skip_comments = true })]])
)
eq({}, exec_lua([[return vim.json.decode('/*first*//*second*/{}', { skip_comments = true })]]))
eq(
'Expected the end but found unclosed multi-line comment at character 13',
pcall_err(exec_lua, [[return vim.json.decode('{}/*Unclosed', { skip_comments = true })]])
)
eq(
'Expected comma or object end but found T_INTEGER at character 12',
pcall_err(exec_lua, [[return vim.json.decode('{"a":1/*x*/0}', { skip_comments = true })]])
)
end)
end)
describe('vim.json.encode()', function()