build: enable lintlua for scripts/ dir #26391

Problem:
We don't enable stylua for many Lua scripts. Automating code-style is an
important tool for reducing time spent on accidental (non-essential)
complexity.

Solution:
- Enable lintlua for `scripts/` directory.
- Specify `call_parentheses = "Input"`, we should allow kwargs-style
  function invocations.

10 files changed, 415 insertions, 292 deletions

diff --git a/.stylua.toml b/.stylua.toml
index a2b3447506..22d6d3e6fc 100644
--- a/.stylua.toml
+++ b/.stylua.toml
@@ -3,4 +3,4 @@ line_endings = "Unix"
 indent_type = "Spaces"
 indent_width = 2
 quote_style = "AutoPreferSingle"
-call_parentheses = "Always"
+call_parentheses = "Input"
diff --git a/.styluaignore b/.styluaignore
index c9303e07ce..c720c00f7e 100644
--- a/.styluaignore
+++ b/.styluaignore
@@ -2,6 +2,5 @@
 /runtime/lua/coxpcall.lua
 /runtime/lua/vim/_meta
 /runtime/lua/vim/re.lua
-/scripts
 /src
 /test
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6701b0211b..2bae668e51 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -233,7 +233,7 @@ add_glob_target(
   TARGET lintlua-stylua
   COMMAND ${STYLUA_PRG}
   FLAGS --color=always --check --respect-ignores
-  GLOB_DIRS runtime/
+  GLOB_DIRS runtime/ scripts/
   GLOB_PAT *.lua
   TOUCH_STRATEGY SINGLE)
 
@@ -260,7 +260,7 @@ add_glob_target(
   TARGET formatlua
   COMMAND ${STYLUA_PRG}
   FLAGS --respect-ignores
-  GLOB_DIRS runtime
+  GLOB_DIRS runtime/ scripts/
   GLOB_PAT *.lua)
 
 add_custom_target(format)
diff --git a/scripts/bump_deps.lua b/scripts/bump_deps.lua
index 076ad374cf..c5294893e0 100755
--- a/scripts/bump_deps.lua
+++ b/scripts/bump_deps.lua
@@ -138,9 +138,10 @@ local function get_archive_info(repo, ref)
     'Failed to download archive from GitHub'
   )
 
-  local shacmd = (vim.fn.executable('sha256sum') == 1
-    and{ 'sha256sum', archive_path }
-    or { 'shasum', '-a', '256', archive_path })
+  local shacmd = (
+    vim.fn.executable('sha256sum') == 1 and { 'sha256sum', archive_path }
+    or { 'shasum', '-a', '256', archive_path }
+  )
   local archive_sha = run(shacmd):gmatch('%w+')()
   return { url = archive_url, sha = archive_sha }
 end
@@ -152,18 +153,7 @@ local function write_cmakelists_line(symbol, kind, value)
     'sed',
     '-i',
     '-e',
-    's/'
-      .. symbol
-      .. '_'
-      .. kind
-      .. '.*$'
-      .. '/'
-      .. symbol
-      .. '_'
-      .. kind
-      .. ' '
-      .. value
-      .. '/',
+    's/' .. symbol .. '_' .. kind .. '.*$' .. '/' .. symbol .. '_' .. kind .. ' ' .. value .. '/',
     deps_file,
   }, 'Failed to write ' .. deps_file)
 end
@@ -203,16 +193,13 @@ local function update_cmakelists(dependency, archive, comment)
   p('Updating ' .. dependency.name .. ' to ' .. archive.url .. '\n')
   write_cmakelists_line(dependency.symbol, 'URL', archive.url:gsub('/', '\\/'))
   write_cmakelists_line(dependency.symbol, 'SHA256', archive.sha)
-  run_die(
-    {
-      'git',
-      'commit',
-      deps_file,
-      '-m',
-      commit_prefix .. 'bump ' .. dependency.name .. ' to ' .. comment,
-    },
-    'git failed to commit'
-  )
+  run_die({
+    'git',
+    'commit',
+    deps_file,
+    '-m',
+    commit_prefix .. 'bump ' .. dependency.name .. ' to ' .. comment,
+  }, 'git failed to commit')
 end
 
 local function verify_cmakelists_committed()
@@ -318,9 +305,9 @@ function M.commit(dependency_name, commit)
 end
 
 function M.version(dependency_name, version)
-  vim.validate{
-    dependency_name={dependency_name,'s'},
-    version={version,'s'},
+  vim.validate {
+    dependency_name = { dependency_name, 's' },
+    version = { version, 's' },
   }
   local dependency = assert(get_dependency(dependency_name))
   verify_cmakelists_committed()
@@ -384,7 +371,7 @@ function M.submit_pr()
 end
 
 local function usage()
-  local this_script = _G.arg[0]:match("[^/]*.lua$")
+  local this_script = _G.arg[0]:match('[^/]*.lua$')
   print(([=[
     Bump Nvim dependencies
 
@@ -421,13 +408,13 @@ local function parseargs()
     elseif _G.arg[i] == '--pr' then
       args.pr = true
     elseif _G.arg[i] == '--branch' then
-      args.branch = _G.arg[i+1]
+      args.branch = _G.arg[i + 1]
     elseif _G.arg[i] == '--dep' then
-      args.dep = _G.arg[i+1]
+      args.dep = _G.arg[i + 1]
     elseif _G.arg[i] == '--version' then
-      args.version = _G.arg[i+1]
+      args.version = _G.arg[i + 1]
     elseif _G.arg[i] == '--commit' then
-      args.commit = _G.arg[i+1]
+      args.commit = _G.arg[i + 1]
     elseif _G.arg[i] == '--head' then
       args.head = true
     end
diff --git a/scripts/gen_eval_files.lua b/scripts/gen_eval_files.lua
index e331dd996e..dddc7d000c 100755
--- a/scripts/gen_eval_files.lua
+++ b/scripts/gen_eval_files.lua
@@ -1,7 +1,7 @@
 -- Generator for various vimdoc and Lua type files
 
 local DEP_API_METADATA = 'build/api_metadata.mpack'
-local DEP_API_DOC  = 'runtime/doc/api.mpack'
+local DEP_API_DOC = 'runtime/doc/api.mpack'
 
 --- @class vim.api.metadata
 --- @field name string
@@ -302,7 +302,7 @@ local function get_api_keysets_meta()
   for _, k in ipairs(keysets) do
     local params = {}
     for _, key in ipairs(k.keys) do
-      table.insert(params, {key..'?', api_type(k.types[key] or 'any')})
+      table.insert(params, { key .. '?', api_type(k.types[key] or 'any') })
     end
     ret[k.name] = {
       signature = 'NA',
@@ -396,7 +396,7 @@ local function render_sig_and_tag(name, fun, write)
 
   local tag = table.concat(tags, ' ')
   local siglen = #fun.signature
-  local conceal_offset = 2*(#tags - 1)
+  local conceal_offset = 2 * (#tags - 1)
   local tag_pad_len = math.max(1, 80 - #tag + conceal_offset)
 
   if siglen + #tag > 80 then
@@ -473,7 +473,7 @@ local function render_option_default(d, vimdoc)
     end
   end
 
-  if dt == "" or dt == nil or type(dt) == 'function' then
+  if dt == '' or dt == nil or type(dt) == 'function' then
     dt = d.meta
   end
 
@@ -481,22 +481,22 @@ local function render_option_default(d, vimdoc)
   if not vimdoc then
     v = vim.inspect(dt) --[[@as string]]
   else
-    v = type(dt) == 'string' and '"'..dt..'"' or tostring(dt)
+    v = type(dt) == 'string' and '"' .. dt .. '"' or tostring(dt)
   end
 
   --- @type table<string, string|false>
   local envvars = {
     TMPDIR = false,
     VIMRUNTIME = false,
-    XDG_CONFIG_HOME = vim.env.HOME..'/.local/config',
-    XDG_DATA_HOME = vim.env.HOME..'/.local/share',
-    XDG_STATE_HOME = vim.env.HOME..'/.local/state',
+    XDG_CONFIG_HOME = vim.env.HOME .. '/.local/config',
+    XDG_DATA_HOME = vim.env.HOME .. '/.local/share',
+    XDG_STATE_HOME = vim.env.HOME .. '/.local/state',
   }
 
   for name, default in pairs(envvars) do
     local value = vim.env[name] or default
     if value then
-      v = v:gsub(vim.pesc(value), '$'..name)
+      v = v:gsub(vim.pesc(value), '$' .. name)
     end
   end
 
@@ -509,26 +509,26 @@ end
 local function render_option_meta(_f, opt, write)
   write('')
   for _, l in ipairs(split(norm_text(opt.desc))) do
-    write('--- '..l)
+    write('--- ' .. l)
   end
 
-  write('--- @type '..OPTION_TYPES[opt.type])
-  write('vim.o.'..opt.full_name..' = '..render_option_default(opt.defaults))
+  write('--- @type ' .. OPTION_TYPES[opt.type])
+  write('vim.o.' .. opt.full_name .. ' = ' .. render_option_default(opt.defaults))
   if opt.abbreviation then
-    write('vim.o.'..opt.abbreviation..' = vim.o.'..opt.full_name)
+    write('vim.o.' .. opt.abbreviation .. ' = vim.o.' .. opt.full_name)
   end
 
   for _, s in pairs {
-    {'wo', 'window'},
-    {'bo', 'buffer'},
-    {'go', 'global'},
+    { 'wo', 'window' },
+    { 'bo', 'buffer' },
+    { 'go', 'global' },
   } do
     local id, scope = s[1], s[2]
     if vim.list_contains(opt.scope, scope) or (id == 'go' and #opt.scope > 1) then
-      local pfx = 'vim.'..id..'.'
-      write(pfx..opt.full_name..' = vim.o.'..opt.full_name)
+      local pfx = 'vim.' .. id .. '.'
+      write(pfx .. opt.full_name .. ' = vim.o.' .. opt.full_name)
       if opt.abbreviation then
-        write(pfx..opt.abbreviation..' = '..pfx..opt.full_name)
+        write(pfx .. opt.abbreviation .. ' = ' .. pfx .. opt.full_name)
       end
     end
   end
@@ -541,14 +541,14 @@ local function scope_to_doc(s)
     global = 'global',
     buffer = 'local to buffer',
     window = 'local to window',
-    tab = 'local to tab page'
+    tab = 'local to tab page',
   }
 
   if #s == 1 then
     return m[s[1]]
   end
   assert(s[1] == 'global')
-  return 'global or '..m[s[2]]..' |global-local|'
+  return 'global or ' .. m[s[2]] .. ' |global-local|'
 end
 
 -- @param o vim.option_meta
@@ -602,23 +602,23 @@ local function build_option_tags(opt)
   --- @type string[]
   local tags = { opt.full_name }
 
-  tags[#tags+1] = opt.abbreviation
+  tags[#tags + 1] = opt.abbreviation
   if opt.type == 'bool' then
     for i = 1, #tags do
-      tags[#tags+1] = 'no'..tags[i]
+      tags[#tags + 1] = 'no' .. tags[i]
     end
   end
 
   for i, t in ipairs(tags) do
-    tags[i] = "'"..t.."'"
+    tags[i] = "'" .. t .. "'"
   end
 
   for _, t in ipairs(opt.tags or {}) do
-    tags[#tags+1] = t
+    tags[#tags + 1] = t
   end
 
   for i, t in ipairs(tags) do
-    tags[i] = "*"..t.."*"
+    tags[i] = '*' .. t .. '*'
   end
 
   return tags
@@ -630,10 +630,10 @@ end
 local function render_option_doc(_f, opt, write)
   local tags = build_option_tags(opt)
   local tag_str = table.concat(tags, ' ')
-  local conceal_offset = 2*(#tags - 1)
+  local conceal_offset = 2 * (#tags - 1)
   local tag_pad = string.rep('\t', math.ceil((64 - #tag_str + conceal_offset) / 8))
   -- local pad = string.rep(' ', 80 - #tag_str + conceal_offset)
-  write(tag_pad..tag_str)
+  write(tag_pad .. tag_str)
 
   local name_str --- @type string
   if opt.abbreviation then
@@ -649,19 +649,19 @@ local function render_option_doc(_f, opt, write)
     if opt.defaults.doc then
       local deflen = #string.format('%s%s%s (', name_str, pad, otype)
       --- @type string
-      v = v:gsub('\n', '\n'..string.rep(' ', deflen - 2))
+      v = v:gsub('\n', '\n' .. string.rep(' ', deflen - 2))
     end
     write(string.format('%s%s%s\t(default %s)', name_str, pad, otype, v))
   else
     write(string.format('%s\t%s', name_str, otype))
   end
 
-  write('\t\t\t'..scope_to_doc(opt.scope)..scope_more_doc(opt))
+  write('\t\t\t' .. scope_to_doc(opt.scope) .. scope_more_doc(opt))
   for _, l in ipairs(split(opt.desc)) do
     if l == '<' or l:match('^<%s') then
       write(l)
     else
-      write('\t'..l:gsub('\\<', '<'))
+      write('\t' .. l:gsub('\\<', '<'))
     end
   end
 end
@@ -751,21 +751,21 @@ local CONFIG = {
     header = { '' },
     from = 'A jump table for the options with a short description can be found at |Q_op|.',
     footer = {
-      ' vim:tw=78:ts=8:noet:ft=help:norl:'
+      ' vim:tw=78:ts=8:noet:ft=help:norl:',
     },
     funcs = get_option_meta,
     render = render_option_doc,
-  }
+  },
 }
 
 --- @param elem nvim.gen_eval_files.elem
 local function render(elem)
-  print('Rendering '..elem.path)
-  local from_lines = {}  --- @type string[]
+  print('Rendering ' .. elem.path)
+  local from_lines = {} --- @type string[]
   local from = elem.from
   if from then
     for line in io.lines(elem.path) do
-      from_lines[#from_lines+1] = line
+      from_lines[#from_lines + 1] = line
       if line:match(from) then
         break
       end
diff --git a/scripts/gen_filetype.lua b/scripts/gen_filetype.lua
index 42478a1082..18b53f1ea4 100644
--- a/scripts/gen_filetype.lua
+++ b/scripts/gen_filetype.lua
@@ -8,18 +8,18 @@ if do_not_run then
   return
 end
 
-local filetype_vim = "runtime/filetype.vim"
-local filetype_lua = "runtime/lua/vim/filetype.lua"
+local filetype_vim = 'runtime/filetype.vim'
+local filetype_lua = 'runtime/lua/vim/filetype.lua'
 
 local keywords = {
-  ["for"] = true,
-  ["or"] = true,
-  ["and"] = true,
-  ["end"] = true,
-  ["do"] = true,
-  ["if"] = true,
-  ["while"] = true,
-  ["repeat"] = true,
+  ['for'] = true,
+  ['or'] = true,
+  ['and'] = true,
+  ['end'] = true,
+  ['do'] = true,
+  ['if'] = true,
+  ['while'] = true,
+  ['repeat'] = true,
 }
 
 local sections = {
@@ -28,42 +28,42 @@ local sections = {
   pattern = { str = {}, func = {} },
 }
 
-local specialchars = "%*%?\\%$%[%]%{%}"
+local specialchars = '%*%?\\%$%[%]%{%}'
 
 local function add_pattern(pat, ft)
   local ok = true
 
   -- Patterns that start or end with { or } confuse splitting on commas and make parsing harder, so just skip those
-  if not string.find(pat, "^%{") and not string.find(pat, "%}$") then
-    for part in string.gmatch(pat, "[^,]+") do
-      if not string.find(part, "[" .. specialchars .. "]") then
-        if type(ft) == "string" then
+  if not string.find(pat, '^%{') and not string.find(pat, '%}$') then
+    for part in string.gmatch(pat, '[^,]+') do
+      if not string.find(part, '[' .. specialchars .. ']') then
+        if type(ft) == 'string' then
           sections.filename.str[part] = ft
         else
           sections.filename.func[part] = ft
         end
-      elseif string.match(part, "^%*%.[^%./" .. specialchars .. "]+$") then
-        if type(ft) == "string" then
+      elseif string.match(part, '^%*%.[^%./' .. specialchars .. ']+$') then
+        if type(ft) == 'string' then
           sections.extension.str[part:sub(3)] = ft
         else
           sections.extension.func[part:sub(3)] = ft
         end
       else
-        if string.match(part, "^%*/[^" .. specialchars .. "]+$") then
+        if string.match(part, '^%*/[^' .. specialchars .. ']+$') then
           -- For patterns matching */some/pattern we want to easily match files
           -- with path /some/pattern, so include those in filename detection
-          if type(ft) == "string" then
+          if type(ft) == 'string' then
             sections.filename.str[part:sub(2)] = ft
           else
             sections.filename.func[part:sub(2)] = ft
           end
         end
 
-        if string.find(part, "^[%w-_.*?%[%]/]+$") then
-          local p = part:gsub("%.", "%%."):gsub("%*", ".*"):gsub("%?", ".")
+        if string.find(part, '^[%w-_.*?%[%]/]+$') then
+          local p = part:gsub('%.', '%%.'):gsub('%*', '.*'):gsub('%?', '.')
           -- Insert into array to maintain order rather than setting
           -- key-value directly
-          if type(ft) == "string" then
+          if type(ft) == 'string' then
             sections.pattern.str[p] = ft
           else
             sections.pattern.func[p] = ft
@@ -80,14 +80,16 @@ end
 
 local function parse_line(line)
   local pat, ft
-  pat, ft = line:match("^%s*au%a* Buf[%a,]+%s+(%S+)%s+setf%s+(%S+)")
+  pat, ft = line:match('^%s*au%a* Buf[%a,]+%s+(%S+)%s+setf%s+(%S+)')
   if pat then
     return add_pattern(pat, ft)
   else
     local func
-    pat, func = line:match("^%s*au%a* Buf[%a,]+%s+(%S+)%s+call%s+(%S+)")
+    pat, func = line:match('^%s*au%a* Buf[%a,]+%s+(%S+)%s+call%s+(%S+)')
     if pat then
-      return add_pattern(pat, function() return func end)
+      return add_pattern(pat, function()
+        return func
+      end)
     end
   end
 end
@@ -95,12 +97,12 @@ end
 local unparsed = {}
 local full_line
 for line in io.lines(filetype_vim) do
-  local cont = string.match(line, "^%s*\\%s*(.*)$")
+  local cont = string.match(line, '^%s*\\%s*(.*)$')
   if cont then
-    full_line = full_line .. " " .. cont
+    full_line = full_line .. ' ' .. cont
   else
     if full_line then
-      if not parse_line(full_line) and string.find(full_line, "^%s*au%a* Buf") then
+      if not parse_line(full_line) and string.find(full_line, '^%s*au%a* Buf') then
         table.insert(unparsed, full_line)
       end
     end
@@ -109,40 +111,46 @@ for line in io.lines(filetype_vim) do
 end
 
 if #unparsed > 0 then
-  print("Failed to parse the following patterns:")
+  print('Failed to parse the following patterns:')
   for _, v in ipairs(unparsed) do
     print(v)
   end
 end
 
 local function add_item(indent, key, ft)
-  if type(ft) == "string" then
-    if string.find(key, "%A") or keywords[key] then
-      key = string.format("[\"%s\"]", key)
+  if type(ft) == 'string' then
+    if string.find(key, '%A') or keywords[key] then
+      key = string.format('["%s"]', key)
     end
     return string.format([[%s%s = "%s",]], indent, key, ft)
-  elseif type(ft) == "function" then
+  elseif type(ft) == 'function' then
     local func = ft()
-    if string.find(key, "%A") or keywords[key] then
-      key = string.format("[\"%s\"]", key)
+    if string.find(key, '%A') or keywords[key] then
+      key = string.format('["%s"]', key)
     end
     -- Right now only a single argument is supported, which covers
     -- everything in filetype.vim as of this writing
-    local arg = string.match(func, "%((.*)%)$")
-    func = string.gsub(func, "%(.*$", "")
-    if arg == "" then
+    local arg = string.match(func, '%((.*)%)$')
+    func = string.gsub(func, '%(.*$', '')
+    if arg == '' then
       -- Function with no arguments, call the function directly
       return string.format([[%s%s = function() vim.fn["%s"]() end,]], indent, key, func)
     elseif string.match(arg, [[^(["']).*%1$]]) then
       -- String argument
-      if func == "s:StarSetf" then
+      if func == 's:StarSetf' then
         return string.format([[%s%s = starsetf(%s),]], indent, key, arg)
       else
         return string.format([[%s%s = function() vim.fn["%s"](%s) end,]], indent, key, func, arg)
       end
-    elseif string.find(arg, "%(") then
+    elseif string.find(arg, '%(') then
       -- Function argument
-      return string.format([[%s%s = function() vim.fn["%s"](vim.fn.%s) end,]], indent, key, func, arg)
+      return string.format(
+        [[%s%s = function() vim.fn["%s"](vim.fn.%s) end,]],
+        indent,
+        key,
+        func,
+        arg
+      )
     else
       assert(false, arg)
     end
@@ -153,7 +161,7 @@ do
   local lines = {}
   local start = false
   for line in io.lines(filetype_lua) do
-    if line:match("^%s+-- END [A-Z]+$") then
+    if line:match('^%s+-- END [A-Z]+$') then
       start = false
     end
 
@@ -161,14 +169,14 @@ do
       table.insert(lines, line)
     end
 
-    local indent, section = line:match("^(%s+)-- BEGIN ([A-Z]+)$")
+    local indent, section = line:match('^(%s+)-- BEGIN ([A-Z]+)$')
     if section then
       start = true
       local t = sections[string.lower(section)]
 
       local sorted = {}
       for k, v in pairs(t.str) do
-        table.insert(sorted, {[k] = v})
+        table.insert(sorted, { [k] = v })
       end
 
       table.sort(sorted, function(a, b)
@@ -182,7 +190,7 @@ do
 
       sorted = {}
       for k, v in pairs(t.func) do
-        table.insert(sorted, {[k] = v})
+        table.insert(sorted, { [k] = v })
       end
 
       table.sort(sorted, function(a, b)
@@ -195,7 +203,7 @@ do
       end
     end
   end
-  local f = io.open(filetype_lua, "w")
-  f:write(table.concat(lines, "\n") .. "\n")
+  local f = io.open(filetype_lua, 'w')
+  f:write(table.concat(lines, '\n') .. '\n')
   f:close()
 end
diff --git a/scripts/gen_help_html.lua b/scripts/gen_help_html.lua
index 633207e018..9369711b0f 100644
--- a/scripts/gen_help_html.lua
+++ b/scripts/gen_help_html.lua
@@ -60,26 +60,26 @@ local new_layout = {
 
 -- TODO: These known invalid |links| require an update to the relevant docs.
 local exclude_invalid = {
-  ["'string'"] = "eval.txt",
+  ["'string'"] = 'eval.txt',
   Query = 'treesitter.txt',
   matchit = 'vim_diff.txt',
-  ["set!"] = "treesitter.txt",
+  ['set!'] = 'treesitter.txt',
 }
 
 -- False-positive "invalid URLs".
 local exclude_invalid_urls = {
-  ["http://"] = "usr_23.txt",
-  ["http://."] = "usr_23.txt",
-  ["http://aspell.net/man-html/Affix-Compression.html"] = "spell.txt",
-  ["http://aspell.net/man-html/Phonetic-Code.html"] = "spell.txt",
-  ["http://canna.sourceforge.jp/"] = "mbyte.txt",
-  ["http://gnuada.sourceforge.net"] = "ft_ada.txt",
-  ["http://lua-users.org/wiki/StringLibraryTutorial"] = "lua.txt",
-  ["http://michael.toren.net/code/"] = "pi_tar.txt",
-  ["http://papp.plan9.de"] = "syntax.txt",
-  ["http://wiki.services.openoffice.org/wiki/Dictionaries"] = "spell.txt",
-  ["http://www.adapower.com"] = "ft_ada.txt",
-  ["http://www.jclark.com/"] = "quickfix.txt",
+  ['http://'] = 'usr_23.txt',
+  ['http://.'] = 'usr_23.txt',
+  ['http://aspell.net/man-html/Affix-Compression.html'] = 'spell.txt',
+  ['http://aspell.net/man-html/Phonetic-Code.html'] = 'spell.txt',
+  ['http://canna.sourceforge.jp/'] = 'mbyte.txt',
+  ['http://gnuada.sourceforge.net'] = 'ft_ada.txt',
+  ['http://lua-users.org/wiki/StringLibraryTutorial'] = 'lua.txt',
+  ['http://michael.toren.net/code/'] = 'pi_tar.txt',
+  ['http://papp.plan9.de'] = 'syntax.txt',
+  ['http://wiki.services.openoffice.org/wiki/Dictionaries'] = 'spell.txt',
+  ['http://www.adapower.com'] = 'ft_ada.txt',
+  ['http://www.jclark.com/'] = 'quickfix.txt',
 }
 
 -- Deprecated, brain-damaged files that I don't care about.
@@ -98,19 +98,18 @@ local function tofile(fname, text)
 end
 
 local function html_esc(s)
-  return s:gsub(
-    '&', '&amp;'):gsub(
-    '<', '&lt;'):gsub(
-    '>', '&gt;')
+  return s:gsub('&', '&amp;'):gsub('<', '&lt;'):gsub('>', '&gt;')
 end
 
 local function url_encode(s)
   -- Credit: tpope / vim-unimpaired
   -- NOTE: these chars intentionally *not* escaped: ' ( )
-  return vim.fn.substitute(vim.fn.iconv(s, 'latin1', 'utf-8'),
+  return vim.fn.substitute(
+    vim.fn.iconv(s, 'latin1', 'utf-8'),
     [=[[^A-Za-z0-9()'_.~-]]=],
     [=[\="%".printf("%02X",char2nr(submatch(0)))]=],
-    'g')
+    'g'
+  )
 end
 
 local function expandtabs(s)
@@ -131,7 +130,7 @@ local function to_heading_tag(text)
 end
 
 local function basename_noext(f)
- return vim.fs.basename(f:gsub('%.txt', ''))
+  return vim.fs.basename(f:gsub('%.txt', ''))
 end
 
 local function is_blank(s)
@@ -151,7 +150,7 @@ local function fix_url(url)
   local removed_chars = ''
   local fixed_url = url
   -- Remove up to one of each char from end of the URL, in this order.
-  for _, c in ipairs({ '.', ')', }) do
+  for _, c in ipairs({ '.', ')' }) do
     if fixed_url:sub(-1) == c then
       removed_chars = c .. removed_chars
       fixed_url = fixed_url:sub(1, -2)
@@ -162,7 +161,7 @@ end
 
 --- Checks if a given line is a "noise" line that doesn't look good in HTML form.
 local function is_noise(line, noise_lines)
-  if (
+  if
     -- First line is always noise.
     (noise_lines ~= nil and vim.tbl_count(noise_lines) == 0)
     or line:find('Type .*gO.* to see the table of contents')
@@ -177,7 +176,7 @@ local function is_noise(line, noise_lines)
     or line:find('^%s*vim?%:.*ft=help')
     or line:find('^%s*vim?%:.*filetype=help')
     or line:find('[*>]local%-additions[*<]')
-  ) then
+  then
     -- table.insert(stats.noise_lines, getbuflinestr(root, opt.buf, 0))
     table.insert(noise_lines or {}, line)
     return true
@@ -188,28 +187,32 @@ end
 --- Creates a github issue URL at neovim/tree-sitter-vimdoc with prefilled content.
 local function get_bug_url_vimdoc(fname, to_fname, sample_text)
   local this_url = string.format('https://neovim.io/doc/user/%s', vim.fs.basename(to_fname))
-  local bug_url = ('https://github.com/neovim/tree-sitter-vimdoc/issues/new?labels=bug&title=parse+error%3A+'
-    ..vim.fs.basename(fname)
-    ..'+&body=Found+%60tree-sitter-vimdoc%60+parse+error+at%3A+'
-    ..this_url
-    ..'%0D%0DContext%3A%0D%0D%60%60%60%0D'
-    ..url_encode(sample_text)
-    ..'%0D%60%60%60')
+  local bug_url = (
+    'https://github.com/neovim/tree-sitter-vimdoc/issues/new?labels=bug&title=parse+error%3A+'
+    .. vim.fs.basename(fname)
+    .. '+&body=Found+%60tree-sitter-vimdoc%60+parse+error+at%3A+'
+    .. this_url
+    .. '%0D%0DContext%3A%0D%0D%60%60%60%0D'
+    .. url_encode(sample_text)
+    .. '%0D%60%60%60'
+  )
   return bug_url
 end
 
 --- Creates a github issue URL at neovim/neovim with prefilled content.
 local function get_bug_url_nvim(fname, to_fname, sample_text, token_name)
   local this_url = string.format('https://neovim.io/doc/user/%s', vim.fs.basename(to_fname))
-  local bug_url = ('https://github.com/neovim/neovim/issues/new?labels=bug&title=user+docs+HTML%3A+'
-    ..vim.fs.basename(fname)
-    ..'+&body=%60gen_help_html.lua%60+problem+at%3A+'
-    ..this_url
-    ..'%0D'
-    ..(token_name and '+unhandled+token%3A+%60'..token_name..'%60' or '')
-    ..'%0DContext%3A%0D%0D%60%60%60%0D'
-    ..url_encode(sample_text)
-    ..'%0D%60%60%60')
+  local bug_url = (
+    'https://github.com/neovim/neovim/issues/new?labels=bug&title=user+docs+HTML%3A+'
+    .. vim.fs.basename(fname)
+    .. '+&body=%60gen_help_html.lua%60+problem+at%3A+'
+    .. this_url
+    .. '%0D'
+    .. (token_name and '+unhandled+token%3A+%60' .. token_name .. '%60' or '')
+    .. '%0DContext%3A%0D%0D%60%60%60%0D'
+    .. url_encode(sample_text)
+    .. '%0D%60%60%60'
+  )
   return bug_url
 end
 
@@ -274,9 +277,11 @@ end
 
 local function get_tagname(node, bufnr)
   local text = vim.treesitter.get_node_text(node, bufnr)
-  local tag = (node:type() == 'optionlink' or node:parent():type() == 'optionlink') and ("'%s'"):format(text) or text
-  local helpfile = vim.fs.basename(tagmap[tag]) or nil  -- "api.txt"
-  local helppage = get_helppage(helpfile)               -- "api.html"
+  local tag = (node:type() == 'optionlink' or node:parent():type() == 'optionlink')
+      and ("'%s'"):format(text)
+    or text
+  local helpfile = vim.fs.basename(tagmap[tag]) or nil -- "api.txt"
+  local helppage = get_helppage(helpfile) -- "api.html"
   return helppage, tag
 end
 
@@ -295,11 +300,9 @@ local function ignore_parse_error(fname, s)
   if ignore_errors[vim.fs.basename(fname)] then
     return true
   end
-  return (
-    -- Ignore parse errors for unclosed tag.
-    -- This is common in vimdocs and is treated as plaintext by :help.
-    s:find("^[`'|*]")
-  )
+  -- Ignore parse errors for unclosed tag.
+  -- This is common in vimdocs and is treated as plaintext by :help.
+  return s:find("^[`'|*]")
 end
 
 local function has_ancestor(node, ancestor_name)
@@ -377,10 +380,11 @@ local function visit_validate(root, level, lang_tree, opt, stats)
     -- Flatten the sample text to a single, truncated line.
     sample_text = vim.trim(sample_text):gsub('[\t\n]', ' '):sub(1, 80)
     table.insert(stats.parse_errors, sample_text)
-  elseif (node_name == 'word' or node_name == 'uppercase_name')
-    and (not vim.tbl_contains({'codespan', 'taglink', 'tag'}, parent))
+  elseif
+    (node_name == 'word' or node_name == 'uppercase_name')
+    and (not vim.tbl_contains({ 'codespan', 'taglink', 'tag' }, parent))
   then
-    local text_nopunct = vim.fn.trim(text, '.,', 0)  -- Ignore some punctuation.
+    local text_nopunct = vim.fn.trim(text, '.,', 0) -- Ignore some punctuation.
     if spell_dict[text_nopunct] then
       invalid_spelling[text_nopunct] = invalid_spelling[text_nopunct] or {}
       invalid_spelling[text_nopunct][vim.fs.basename(opt.fname)] = node_text(root:parent())
@@ -399,7 +403,7 @@ local function fix_tab_after_conceal(text, next_node_text)
   -- Vim tabs take into account the two concealed characters even though they
   -- are invisible, so we need to add back in the two spaces if this is
   -- followed by a tab to make the tab alignment to match Vim's behavior.
-  if string.sub(next_node_text,1,1) == '\t' then
+  if string.sub(next_node_text, 1, 1) == '\t' then
     text = text .. '  '
   end
   return text
@@ -411,9 +415,15 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
 
   local node_name = (root.named and root:named()) and root:type() or nil
   -- Previous sibling kind (string).
-  local prev = root:prev_sibling() and (root:prev_sibling().named and root:prev_sibling():named()) and root:prev_sibling():type() or nil
+  local prev = root:prev_sibling()
+      and (root:prev_sibling().named and root:prev_sibling():named())
+      and root:prev_sibling():type()
+    or nil
   -- Next sibling kind (string).
-  local next_ = root:next_sibling() and (root:next_sibling().named and root:next_sibling():named()) and root:next_sibling():type() or nil
+  local next_ = root:next_sibling()
+      and (root:next_sibling().named and root:next_sibling():named())
+      and root:next_sibling():type()
+    or nil
   -- Parent kind (string).
   local parent = root:parent() and root:parent():type() or nil
   local text = ''
@@ -450,7 +460,7 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
     trimmed = trim(text)
   end
 
-  if node_name == 'help_file' then  -- root node
+  if node_name == 'help_file' then -- root node
     return text
   elseif node_name == 'url' then
     local fixed_url, removed_chars = fix_url(trimmed)
@@ -459,18 +469,22 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
     return text
   elseif node_name == 'h1' or node_name == 'h2' or node_name == 'h3' then
     if is_noise(text, stats.noise_lines) then
-      return ''  -- Discard common "noise" lines.
+      return '' -- Discard common "noise" lines.
     end
     -- Remove "===" and tags from ToC text.
     local hname = (node_text():gsub('%-%-%-%-+', ''):gsub('%=%=%=%=+', ''):gsub('%*.*%*', ''))
     -- Use the first *tag* node as the heading anchor, if any.
     local tagnode = first(root, 'tag')
     -- Use the *tag* as the heading anchor id, if possible.
-    local tagname = tagnode and url_encode(node_text(tagnode:child(1), false)) or to_heading_tag(hname)
+    local tagname = tagnode and url_encode(node_text(tagnode:child(1), false))
+      or to_heading_tag(hname)
     if node_name == 'h1' or #headings == 0 then
       table.insert(headings, { name = hname, subheadings = {}, tag = tagname })
     else
-      table.insert(headings[#headings].subheadings, { name = hname, subheadings = {}, tag = tagname })
+      table.insert(
+        headings[#headings].subheadings,
+        { name = hname, subheadings = {}, tag = tagname }
+      )
     end
     local el = node_name == 'h1' and 'h2' or 'h3'
     return ('<%s id="%s" class="help-heading">%s</%s>\n'):format(el, tagname, text, el)
@@ -490,11 +504,16 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
     end
     return string.format('<div class="help-para">\n%s\n</div>\n', text)
   elseif node_name == 'line' then
-    if (parent ~= 'codeblock' or parent ~= 'code') and (is_blank(text) or is_noise(text, stats.noise_lines)) then
-      return ''  -- Discard common "noise" lines.
+    if
+      (parent ~= 'codeblock' or parent ~= 'code')
+      and (is_blank(text) or is_noise(text, stats.noise_lines))
+    then
+      return '' -- Discard common "noise" lines.
     end
     -- XXX: Avoid newlines (too much whitespace) after block elements in old (preformatted) layout.
-    local div = opt.old and root:child(0) and vim.list_contains({'column_heading', 'h1', 'h2', 'h3'}, root:child(0):type())
+    local div = opt.old
+      and root:child(0)
+      and vim.list_contains({ 'column_heading', 'h1', 'h2', 'h3' }, root:child(0):type())
     return string.format('%s%s', div and trim(text) or text, div and '' or '\n')
   elseif node_name == 'line_li' then
     local sib = root:prev_sibling()
@@ -520,12 +539,17 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
     if ignored then
       return text
     end
-    local s = ('%s<a href="%s#%s">%s</a>'):format(ws(), helppage, url_encode(tagname), html_esc(tagname))
+    local s = ('%s<a href="%s#%s">%s</a>'):format(
+      ws(),
+      helppage,
+      url_encode(tagname),
+      html_esc(tagname)
+    )
     if opt.old and node_name == 'taglink' then
       s = fix_tab_after_conceal(s, node_text(root:next_sibling()))
     end
     return s
-  elseif vim.list_contains({'codespan', 'keycode'}, node_name) then
+  elseif vim.list_contains({ 'codespan', 'keycode' }, node_name) then
     if root:has_error() then
       return text
     end
@@ -541,24 +565,28 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
   elseif node_name == 'language' then
     language = node_text(root)
     return ''
-  elseif node_name == 'code' then  -- Highlighted codeblock (child).
+  elseif node_name == 'code' then -- Highlighted codeblock (child).
     if is_blank(text) then
       return ''
     end
     local code
     if language then
-      code = ('<pre><code class="language-%s">%s</code></pre>'):format(language,trim(trim_indent(text), 2))
+      code = ('<pre><code class="language-%s">%s</code></pre>'):format(
+        language,
+        trim(trim_indent(text), 2)
+      )
       language = nil
     else
       code = ('<pre>%s</pre>'):format(trim(trim_indent(text), 2))
     end
     return code
-  elseif node_name == 'tag' then  -- anchor
+  elseif node_name == 'tag' then -- anchor
     if root:has_error() then
       return text
     end