Type annotations for VSCode or VSCodium and Lua Language Server

[massifrg]

I write my Lua filters and custom readers/writers for Pandoc with VSCodium and Lua Language Server (LuaLS).

LuaLS complains about the global variables like pandoc or FORMAT, so you may add a .luarc.json file like this in the base directory of your project:

{
  "diagnostics.globals": [
    "FORMAT",
    "PANDOC_READER_OPTIONS",
    "PANDOC_WRITER_OPTIONS",
    "PANDOC_VERSION",
    "PANDOC_API_VERSION",
    "PANDOC_SCRIPT_FILE",
    "PANDOC_STATE",
    "pandoc",
    "lpeg",
    "re"
  ]
}

I also wrote a file with type annotations that may be useful while developing with Lua for Pandoc. Here's the link to the file inside a project of mine.

Just copy that file among your sources and add a line like this:

---@module "pandoc-types-annotations"

to get the type definitions for Inline, Block, Div, etc.

If you find mistakes, typos or have suggestions to make those annotations better, just let me know.

[massifrg]

Those annotations are now in a repository: pandoc-luals-annotations.

It should be complete (and almost correct, I hope).