search

LuaLS / lua-language-server

A language server that offers Lua language support - programmed in Lua
https://luals.github.io
MIT License
3.38k stars 319 forks source link

Section `luals.config` missing in `doc.json` #2963

Open AndreasMatthias opened 3 days ago

AndreasMatthias commented 3 days ago

File doc.json contained a section luals.config up to commit ba8f90eb0fab18ce8aee2bdbf7007dc63050381d (3.10.5). But after a major refactoring of the code in commit aeb9ccb7012751bdb225336528720bd3bf80b536, 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 commented 3 days ago

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 😕 https://github.com/LuaLS/lua-language-server/blob/aeb9ccb7012751bdb225336528720bd3bf80b536/script/cli/doc/export.lua#L11-L25 (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 🤔 ? https://github.com/LuaLS/lua-language-server/blob/1bc01316af663092fa3ffa79e6a419a5b956e4e7/script/cli/doc/export.lua#L285-L296 => add your entry into the docs[] array

AndreasMatthias commented 2 days ago

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