Error when exporting Lua language server documentation #3170

Activity

1. GeTechG

   changed the title [-]Issue: Error when exporting Lua language server documentation[/-] [+]Error when exporting Lua language server documentation[/+] on Apr 30, 2025
2. tomlau10 commented on May 1, 2025

   

   tomlau10

   on May 1, 2025

   Contributor

   More actions

   This is surely a regression issue, as the export feature undergoes a heavy refactor before in the PR #2821.
   Since then it uses the DOC global variable in the getLocalPath(). 🤔
   https://github.com/LuaLS/lua-language-server/blame/115a518ad995bfc6ae8dabf216451055e1633898/script/cli/doc/export.lua#L57-L60

   • AFAIK the DOC here is a global variable representing the --doc CLI argument, it should not be nil when called from CLI:
     

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

     Lines 175 to 186 in 606ea70

     	---CLI call for documentation (parameter '--DOC=...' is passed to server)
     	function doc.runCLI()
     	lang(LOCALE)
     	if DOC_UPDATE then
     	DOC_OUT_PATH, DOC = getPathDocUpdate()
     	end
     	if type(DOC) ~= 'string' then
     	print(lang.script('CLI_CHECK_ERROR_TYPE', type(DOC)))
     	return
     	end

   • A better way might be to set this DOC global inside doc.makeDoc(), and unset after finish?
     Something like this:

       DOC = ws.rootUri and fs.path(furi.decode(ws.rootUri)) or fs.current_path()
       local docs = dirty_export.makeDocs(globals, function (i, max)
           prog:setMessage(('%d/%d'):format(i, max))
           prog:setPercentage((i) / max * 100)
       end)
       DOC = nil
3. GeTechG commented on May 1, 2025

   

   GeTechG

   on May 1, 2025

   Author

   More actions

   @tomlau10 Yes definitely, I would like to point out that I was not running through cli but through the vscode palette suggesting that I may not have accurately pointed out the problem, and the problem is how vscode is called. Since through cli it seems to complete successfully without any problems.
4. mark-wiemer commented on Dec 6, 2025

   

   mark-wiemer

   on Dec 6, 2025

   Last edited by mark-wiemer

   More actions

   Thanks for the workaround! For me, on Linux Mint, this didn't quite work though. Here's what did:

   Original error:

   script/cli/doc/export.lua:63: bad argument #1 to 'canonical' (std::filesystem::__cxx11::path expected, got nil)
   stack traceback:
   	[C]: in function 'bee.filesystem.canonical'
   	script/cli/doc/export.lua:63: in field 'getLocalPath'
   	script/cli/doc/export.lua:152: in field '?'
   	script/cli/doc/export.lua:120: in field 'documentObject'
   	script/cli/doc/export.lua:268: in field 'variable'
   	script/cli/doc/export.lua:241: in field '?'
   	script/cli/doc/export.lua:120: in field 'documentObject'
   	script/cli/doc/export.lua:294: in field 'makeDocs'
   	script/cli/doc/init.lua:162: in function 'cli.doc.makeDoc'
   	script/core/command/exportDocument.lua:10: in function 'core.command.exportDocument'
   	script/provider/provider.lua:1013: in function <script/provider/provider.lua:991>
   	[C]: in function 'xpcall'
   	script/proto/proto.lua:202: in function <script/proto/proto.lua:177>
   

   1. Open export.lua, e.g. /home/markw/.vscode/extensions/sumneko.lua-3.16.0-linux-x64/server/script/cli/doc/export.lua

      • In VS Code, you can find the extension path by viewing the extension and then clicking "Installation > Size > 12.34MB" (it's weird)

   2. Make the following changes:

       ...
      
       function export.getLocalPath(uri)
           local file_canonical = fs.canonical(furi.decode(uri)):string()
      +    -- Define DOC variable to avoid nil error, original workaround
      +    local DOC = DOC or (ws.rootUri and fs.path(furi.decode(ws.rootUri)) or fs.current_path())
           local doc_canonical = fs.canonical(DOC):string()
      
       ...
      
       function export.getLualsConfig()
      +    -- Define DOC variable to avoid nil error, secondary workaround
      +    local DOC = DOC or (ws.rootUri and fs.path(furi.decode(ws.rootUri)) or fs.current_path())
           return {
               name = "LuaLS",
               type = "luals.config",
               DOC = fs.canonical(fs.path(DOC)):string(),
               defines = {},
               fields = {},
           }
       end
      
       ...

   3. Restart extensions and wait a few seconds for Lua language server to start again

   4. Run Export Document

   Without secondary workaround:

   script/cli/doc/export.lua:306: bad argument #1 to 'path' (std::filesystem::__cxx11::path expected, got nil)
   stack traceback:
   	[C]: in function 'bee.filesystem.path'
   	script/cli/doc/export.lua:306: in field 'getLualsConfig'
   	script/cli/doc/export.lua:297: in field 'makeDocs'
   	script/cli/doc/init.lua:162: in function 'cli.doc.makeDoc'
   	script/core/command/exportDocument.lua:10: in function 'core.command.exportDocument'
   	script/provider/provider.lua:1013: in function <script/provider/provider.lua:991>
   	[C]: in function 'xpcall'
   	script/proto/proto.lua:202: in function <script/proto/proto.lua:177>
   

   With both original and secondary workaround, the docs were exported successfully :)

   👍React with 👍2Reacted by AshenOne and Van