mirror of
https://github.com/neovim/neovim.git
synced 2025-11-04 01:34:25 +00:00
9beb40a4db
Problem: The documentation flow (`gen_vimdoc.py`) has several issues: - it's not very versatile - depends on doxygen - doesn't work well with Lua code as it requires an awkward filter script to convert it into pseudo-C. - The intermediate XML files and filters makes it too much like a rube goldberg machine. Solution: Re-implement the flow using Lua, LPEG and treesitter. - `gen_vimdoc.py` is now replaced with `gen_vimdoc.lua` and replicates a portion of the logic. - `lua2dox.lua` is gone! - No more XML files. - Doxygen is now longer used and instead we now use: - LPEG for comment parsing (see `scripts/luacats_grammar.lua` and `scripts/cdoc_grammar.lua`). - LPEG for C parsing (see `scripts/cdoc_parser.lua`) - Lua patterns for Lua parsing (see `scripts/luacats_parser.lua`). - Treesitter for Markdown parsing (see `scripts/text_utils.lua`). - The generated `runtime/doc/*.mpack` files have been removed. - `scripts/gen_eval_files.lua` now instead uses `scripts/cdoc_parser.lua` directly. - Text wrapping is implemented in `scripts/text_utils.lua` and appears to produce more consistent results (the main contributer to the diff of this change).
40 lines
1.4 KiB
Lua
40 lines
1.4 KiB
Lua
---@meta
|
|
|
|
---@nodoc
|
|
vim.json = {}
|
|
|
|
-- luacheck: no unused args
|
|
|
|
---@brief
|
|
---
|
|
--- This module provides encoding and decoding of Lua objects to and
|
|
--- from JSON-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
|
|
|
|
--- Decodes (or "unpacks") the JSON-encoded {str} to a Lua object.
|
|
---
|
|
--- - Decodes JSON "null" as |vim.NIL| (controllable by {opts}, see below).
|
|
--- - Decodes empty object as |vim.empty_dict()|.
|
|
--- - Decodes empty array as `{}` (empty Lua table).
|
|
---
|
|
--- Example:
|
|
---
|
|
--- ```lua
|
|
--- vim.print(vim.json.decode('{"bar":[],"foo":{},"zub":null}'))
|
|
--- -- { bar = {}, foo = vim.empty_dict(), zub = vim.NIL }
|
|
--- ```
|
|
---
|
|
---@param str string Stringified JSON data.
|
|
---@param opts? table<string,any> Options table with keys:
|
|
--- - luanil: (table) Table with keys:
|
|
--- * object: (boolean) When true, converts `null` in JSON objects
|
|
--- to Lua `nil` instead of |vim.NIL|.
|
|
--- * array: (boolean) When true, converts `null` in JSON arrays
|
|
--- to Lua `nil` instead of |vim.NIL|.
|
|
---@return any
|
|
function vim.json.decode(str, opts) end
|
|
|
|
--- Encodes (or "packs") Lua object {obj} as JSON in a Lua string.
|
|
---@param obj any
|
|
---@return string
|
|
function vim.json.encode(obj) end
|