feat: Move pandoc builtins to their own module and split filters, rea…

…ders, and writers
lunarmodules · Aug 28, 2024 · 25021e0 · 25021e0
1 parent edd9456
commit 25021e0
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 19 deletions.
diff --git a/luacheck-dev-1.rockspec b/luacheck-dev-1.rockspec
@@ -46,6 +46,7 @@ build = {
  ["luacheck.builtin_standards"] = "src/luacheck/builtin_standards/init.lua",
  ["luacheck.builtin_standards.love"] = "src/luacheck/builtin_standards/love.lua",
  ["luacheck.builtin_standards.minetest"] = "src/luacheck/builtin_standards/minetest.lua",
+ ["luacheck.builtin_standards.pandoc"] = "src/luacheck/builtin_standards/pandoc.lua",
  ["luacheck.builtin_standards.playdate"] = "src/luacheck/builtin_standards/playdate.lua",
  ["luacheck.builtin_standards.ngx"] = "src/luacheck/builtin_standards/ngx.lua",
  ["luacheck.cache"] = "src/luacheck/cache.lua",

diff --git a/src/luacheck/builtin_standards/init.lua b/src/luacheck/builtin_standards/init.lua
@@ -1,5 +1,6 @@
 local love = require "luacheck.builtin_standards.love"
 local minetest = require "luacheck.builtin_standards.minetest"
+local pandoc = require "luacheck.builtin_standards.pandoc"
 local playdate = require "luacheck.builtin_standards.playdate"
 local ngx = require "luacheck.builtin_standards.ngx"
 local standards = require "luacheck.standards"
@@ -344,25 +345,10 @@ builtin_standards.sile = {
  }
 }
 
--- https://pandoc.org/lua-filters.html#global-variables
-builtin_standards.pandoc = {
- globals = {
- -- Global modules
- "pandoc", "lpeg", "re",
- -- Global variables passed to filters
- "FORMAT", "PANDOC_READER_OPTIONS", "PANDOC_WRITER_OPTIONS", "PANDOC_VERSION", "PANDOC_API_VERSION",
- "PANDOC_SCRIPT_FILE", "PANDOC_STATE",
- -- Globals that can be used to create filter elements
- -- - top level
- "Inlines", "Inline", "Blocks", "Block", "Meta", "Pandoc",
- -- - inline
- "Cite", "Code", "Emph", "Image", "LineBreak", "Link", "Math", "Note", "Quoted", "RawInline", "SmallCaps",
- "SoftBreak", "Space", "Span", "Str", "Strikeout", "Strong", "Subscript", "Superscript", "Underline",
- -- - block
- "BlockQuote", "BulletList", "CodeBlock", "DefinitionList", "Div", "Figure", "Header", "HorizontalRule",
- "LineBlock", "OrderedList", "Para", "Plain", "RawBlock", "Table",
- }
-}
+builtin_standards.pandoc = pandoc.pandoc
+builtin_standards.pandoc_filter = pandoc.filter
+builtin_standards.pandoc_reader = pandoc.reader
+builtin_standards.pandoc_writer = pandoc.writer
 
 builtin_standards.none = {}
 

diff --git a/src/luacheck/builtin_standards/pandoc.lua b/src/luacheck/builtin_standards/pandoc.lua
@@ -0,0 +1,58 @@
+local add_std_table = require "luacheck.standards".add_std_table
+
+local function combine(...)
+ local res = {}
+ for _, def in ipairs({...}) do
+ add_std_table(res, def)
+ end
+ return res.fields
+end
+
+local common = {
+ read_globals = {
+ "pandoc", "lpeg", "re",
+ },
+}
+
+-- https://pandoc.org/lua-filters.html
+local filter = {
+ read_globals = {
+ "FORMAT", "PANDOC_READER_OPTIONS", "PANDOC_WRITER_OPTIONS", "PANDOC_VERSION", "PANDOC_API_VERSION",
+ "PANDOC_SCRIPT_FILE", "PANDOC_STATE",
+ },
+ globals = {
+ -- - top level
+ "Inlines", "Inline", "Blocks", "Block", "Meta", "Pandoc",
+ -- - inline
+ "Cite", "Code", "Emph", "Image", "LineBreak", "Link", "Math", "Note", "Quoted", "RawInline", "SmallCaps",
+ "SoftBreak", "Space", "Span", "Str", "Strikeout", "Strong", "Subscript", "Superscript", "Underline",
+ -- - block
+ "BlockQuote", "BulletList", "CodeBlock", "DefinitionList", "Div", "Figure", "Header", "HorizontalRule",
+ "LineBlock", "OrderedList", "Para", "Plain", "RawBlock", "Table",
+ },
+}
+
+-- https://pandoc.org/custom-readers.html
+local reader = {
+ globals = {
+ "Reader", "Extensions",
+ "ByteStringReader"
+ },
+}
+
+-- https://pandoc.org/custom-writers.html
+local writer = {
+ globals = {
+ "PANDOC_DOCUMENT", "Writer", "Extensions", "Doc", "Template",
+ "Blocksep", "ByteStringWriter", "CaptionedImage", "DisplayMath", "DoubleQuoted", "InlineMath", "SingleQuoted",
+ },
+}
+
+local variants = {
+ pandoc = { globals = combine(common, filter, reader, writer) },
+ filter = { globals = combine(common, filter) },
+ reader = { globals = combine(common, reader) },
+ writer = { globals = combine(common, writer) },
+}
+
+return variants