aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/json.lua
diff options
context:
space:
mode:
authorBartłomiej Maryńczak <marynczak.bartlomiej@gmail.com>2024-12-06 21:43:41 +0100
committerGitHub <noreply@github.com>2024-12-06 12:43:41 -0800
commit517ecb85f58ed6ac8b4d5443931612e75e7c7dc2 (patch)
treec98da87e669d073773762574d504ffb621fe20fa /runtime/lua/vim/_meta/json.lua
parentfac96b72a59e15d483e03bdc43b9ba08ce6c828e (diff)
downloadrneovim-517ecb85f58ed6ac8b4d5443931612e75e7c7dc2.tar.gz
rneovim-517ecb85f58ed6ac8b4d5443931612e75e7c7dc2.tar.bz2
rneovim-517ecb85f58ed6ac8b4d5443931612e75e7c7dc2.zip
feat(stdlib): vim.json.encode(...,{escape_slash:boolean}) #30561
Problem: vim.json.encode escapes every slash in string values (for example in file paths), and is not optional. Use-case is for preventing HTML injections (eg. injecting `</script>` closing tag); in the context of Nvim this is rarely useful. Solution: - Add a `escape_slash` flag to `vim.json.encode`. - Defaults to `false`. (This is a "breaking" change, but more like a bug fix.)
Diffstat (limited to 'runtime/lua/vim/_meta/json.lua')
-rw-r--r--runtime/lua/vim/_meta/json.lua5
1 files changed, 4 insertions, 1 deletions
diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
index 07d89aafc8..1a7e87db9c 100644
--- a/runtime/lua/vim/_meta/json.lua
+++ b/runtime/lua/vim/_meta/json.lua
@@ -35,5 +35,8 @@ function vim.json.decode(str, opts) end
--- Encodes (or "packs") Lua object {obj} as JSON in a Lua string.
---@param obj any
+---@param opts? table<string,any> Options table with keys:
+--- - escape_slash: (boolean) (default false) When true, escapes `/`
+--- character in JSON strings
---@return string
-function vim.json.encode(obj) end
+function vim.json.encode(obj, opts) end