Section luals.config missing in doc.json

[AndreasMatthias]

File doc.json contained a section luals.config up to commit ba8f90e (3.10.5).
But after a major refactoring of the code in commit aeb9ccb, this section
doesn't exist any more.

I suppose that it was not intended to drop it. The original code came from this pull request #2562.

Can someone give me a hint on how to reimplement it? I'm a bit lost in the new code.

[tomlau10]

The major refactoring was done in this PR #2821 by a contributor @skarph .
From the PR description, the refactor aims to expose a Lua.docScriptPath config for customizing the export logic. And if left empty then it will run the default script/cli/doc/export.lua export logic.

Seems that he incorrectly treated luals.config as a doc object type 😕

lua-language-server/script/cli/doc/export.lua

Lines 11 to 25 in aeb9ccb

	---@alias doctype
	---| 'doc.alias'
	---| 'doc.class'
	---| 'doc.field'
	---| 'doc.field.name'
	---| 'doc.type.arg.name'
	---| 'doc.type.function'
	---| 'doc.type.table'
	---| 'funcargs'
	---| 'function'
	---| 'function.return'
	---| 'global.type'
	---| 'global.variable'
	---| 'local'
	---| 'luals.config'

(all other types are the parser object type in luals AFAIK)

---

If I understand correctly, your original code #2562 actually adds luals.config as a doc entry in the results[] array, which is a hack anyway? Perhaps you can do the same in export.makeDocs in the current refactored version 🤔 ?

lua-language-server/script/cli/doc/export.lua

Lines 285 to 296 in 1bc0131

	function export.makeDocs(globals, callback)
	local docs = {}
	for i, global in ipairs(globals) do
	table.insert(docs, export.documentObject(global))
	callback(i, #globals)
	end
	table.sort(docs, export.sortDoc)
	return docs
	end

=> add your entry into the docs[] array

[AndreasMatthias]

Thanks for these explanations. I'll try to reimplement it.