Skip to content

documentation generation malfunctioning #2262

@Bilal2453

Description

@Bilal2453

How are you using the lua-language-server?

Command Line

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Following the wiki, doing lua-language-server --doc "/path/to/project" should generate documentation of that project, as a markdown file and a json file. I expect to see the definitions of that project at the log path.

I have tried pointing it out to multiple different values, to a Lua file directly containing the definitions, it is always the same behavior.

Actual Behaviour

Instead, what gets generated is the entirety of the Lua 5.4 definitions (the version of Lua I have set). No project definitions generated whatsoever.

The same happens using the VSCode extension's built-in feature.

Reproduction steps

  1. Create a Lua file inside an empty directory, type out some function/class.
  2. Execute the language server and set the value of --doc to the directory path.
  3. Notice the generated markdown contents not containing the Lua file definitions written on step 1.

Additional Notes

I have tried this before at one point and it was working as expected.

The language server version is 3.6.25.

Log File

[12:42:35.367][info] [#0:/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/main.lua:66]: Lua Lsp startup, root: 	/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server
[12:42:35.368][info] [#0:/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/main.lua:67]: ROOT:	/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server
[12:42:35.368][info] [#0:/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/main.lua:68]: LOGPATH:	/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/log
[12:42:35.368][info] [#0:/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/main.lua:69]: METAPATH:	/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta
[12:42:35.368][info] [#0:/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/main.lua:70]: VERSION:	3.6.25
[12:42:35.413][info] [#0:script/language.lua:137]: VSC language: nil
[12:42:35.413][info] [#0:script/language.lua:138]: LS  language: en-us
[12:42:35.413][info] [#0:script/client.lua:657]: Client init	{
  rootUri = "file:///home/bilal/dev/lua/font-name"
}
[12:42:35.413][info] [#0:script/language.lua:137]: VSC language: nil
[12:42:35.413][info] [#0:script/language.lua:138]: LS  language: en-us
[12:42:35.413][info] [#0:script/workspace/workspace.lua:38]: Workspace init root: 	file:///home/bilal/dev/lua/font-name
[12:42:35.413][info] [#0:script/workspace/workspace.lua:42]: Log path: 	/home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/log/file_home_bilal_dev_lua_font-name.log
[12:42:35.413][info] [#0:script/workspace/workspace.lua:48]: Workspace create: 	file:///home/bilal/dev/lua/font-name
[12:42:35.415][warn] [#0:script/config/loader.lua:116]: No config?	nil
[12:42:35.415][warn] [#0:script/config/loader.lua:116]: No config?	nil
[12:42:35.415][info] [#0:script/provider/provider.lua:61]: Load config from client	fallback
[12:42:35.415][info] [#0:script/provider/provider.lua:62]: nil
[12:42:35.415][info] [#0:script/library.lua:212]: Init builtin library at:	file:///home/bilal/dev/lua/font-name
[12:42:35.434][info] [#0:script/library.lua:212]: Init builtin library at:	nil
[12:42:35.451][info] [#0:script/workspace/workspace.lua:322]: Preload start:	file:///home/bilal/dev/lua/font-name
[12:42:35.454][info] [#0:script/workspace/workspace.lua:328]: Scan files at:	file:///home/bilal/dev/lua/font-name
[12:42:35.454][info] [#0:script/workspace/workspace.lua:322]: Preload start:	<fallback>
[12:42:35.457][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua
[12:42:35.457][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua
[12:42:35.457][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua
[12:42:35.457][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua
[12:42:35.458][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua
[12:42:35.458][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua
[12:42:35.458][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua
[12:42:35.458][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua
[12:42:35.458][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua
[12:42:35.459][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua
[12:42:35.459][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua
[12:42:35.459][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua
[12:42:35.460][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua
[12:42:35.461][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua
[12:42:35.461][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua
[12:42:35.461][info] [#0:script/workspace/workspace.lua:351]: Scan library at:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua
[12:42:35.461][info] [#0:script/workspace/workspace.lua:377]: Found 11 files at:	<fallback>
[12:42:35.461][info] [#0:script/workspace/loading.lua:161]: Load files from disk:	<fallback>
[12:42:35.461][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua , size = 2.590 KB
[12:42:35.464][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua
[12:42:35.464][info] [#0:script/workspace/workspace.lua:377]: Found 13 files at:	file:///home/bilal/dev/lua/font-name
[12:42:35.464][info] [#0:script/workspace/loading.lua:161]: Load files from disk:	file:///home/bilal/dev/lua/font-name
[12:42:35.464][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua
[12:42:35.464][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/coroutine.lua
[12:42:35.464][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua , size = 6.364 KB
[12:42:35.471][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua
[12:42:35.471][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua
[12:42:35.471][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/io.lua
[12:42:35.471][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua , size = 2.386 KB
[12:42:35.473][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua
[12:42:35.473][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua
[12:42:35.473][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/utf8.lua
[12:42:35.473][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua , size = 2.944 KB
[12:42:35.475][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua
[12:42:35.475][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua
[12:42:35.475][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/package.lua
[12:42:35.476][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua , size = 8.731 KB
[12:42:35.486][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua
[12:42:35.486][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua
[12:42:35.486][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/math.lua
[12:42:35.486][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua , size = 6.313 KB
[12:42:35.491][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua
[12:42:35.491][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua
[12:42:35.491][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/string.lua
[12:42:35.491][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua , size = 4.347 KB
[12:42:35.495][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua
[12:42:35.495][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua
[12:42:35.495][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/os.lua
[12:42:35.495][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua , size = 4.230 KB
[12:42:35.498][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua
[12:42:35.498][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua
[12:42:35.498][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/table.lua
[12:42:35.499][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua , size = 7.637 KB
[12:42:35.508][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua
[12:42:35.508][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua
[12:42:35.508][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/debug.lua
[12:42:35.508][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua , size = 15.185 KB
[12:42:35.518][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua
[12:42:35.518][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua
[12:42:35.518][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/basic.lua
[12:42:35.518][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua , size = 0.302 KB
[12:42:35.519][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua
[12:42:35.519][info] [#0:script/workspace/loading.lua:89]: Skip loaded file: file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua
[12:42:35.519][info] [#0:script/workspace/loading.lua:113]: ++++As library of:	file:///home/bilal/.vscode/extensions/sumneko.lua-3.6.26-linux-x64/server/meta/Lua%205.4%20en-us%20utf8/builtin.lua
[12:42:35.519][info] [#0:script/workspace/loading.lua:173]: Loaded files takes [0.058] sec: <fallback>
[12:42:35.519][info] [#0:script/workspace/loading.lua:182]: Compile files takes [0.000] sec: <fallback>
[12:42:35.519][info] [#0:script/workspace/loading.lua:183]: Loaded finish:	<fallback>
[12:42:35.519][info] [#0:script/workspace/workspace.lua:379]: Preload finish at:	<fallback>
[12:42:35.520][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/dev/lua/font-name/decoders/sfnt.lua , size = 6.697 KB
[12:42:35.526][info] [#0:script/workspace/loading.lua:101]: Preload file at: file:///home/bilal/dev/lua/font-name/init.lua , size = 0.507 KB
[12:42:35.526][info] [#0:script/workspace/loading.lua:173]: Loaded files takes [0.062] sec: file:///home/bilal/dev/lua/font-name
[12:42:35.526][info] [#0:script/workspace/loading.lua:182]: Compile files takes [0.000] sec: file:///home/bilal/dev/lua/font-name
[12:42:35.526][info] [#0:script/workspace/loading.lua:183]: Loaded finish:	file:///home/bilal/dev/lua/font-name
[12:42:35.526][info] [#0:script/workspace/workspace.lua:379]: Preload finish at:	file:///home/bilal/dev/lua/font-name
[12:42:35.529][info] [#0:script/provider/diagnostic.lua:557]: Diagnostics scope [file:///home/bilal/dev/lua/font-name], files count:[13]
[12:42:35.542][info] [#0:script/provider/diagnostic.lua:574]: Diagnostics scope [file:///home/bilal/dev/lua/font-name] finished, takes [0.014] sec.
[12:48:12.387][info] [#0:script/service/service.lua:144]: 
========= Medical Examination Report =========
    --------------- Memory ---------------
        Total: 14.263 MB
        # 00 : 13.917 MB
        # 01 : 0.052 MB
        # 02 : 0.103 MB
        # 03 : 0.052 MB
        # 04 : 0.139 MB
    --------------- Coroutine ---------------
        Total:     10
        Running:   0
        Suspended: 0
        Normal:    0
        Dead:      10
    --------------- Cache ---------------
        Total: 1
        Dead:  0
    ---------------  RPC  ---------------
        Holdon:   0
        Waiting:  0
==============================================

Metadata

Metadata

Assignees

No one assigned

    Labels

    Info NeededMore information is required

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions