The language server can be run using the below command:
.\bin\lua-language-server.exe
./bin/lua-language-server
./bin/lua-language-server
If you use the Visual Studio Code extension, the language server is run for
you. Arguments and flags can be used by adding them to the
misc.parameters setting.
optional
Type: string
The main Lua script file from the root of this repository. If omitted, the application will attempt to load bin/../main.lua.
There are many optional flags that can alter how the server operates.
Type: string
Generate documentation from a workspace. The files will be output in your log path.
Example: --doc=C:/Users/Me/Documents/myLuaProject/
Type: string
The path to output generated documentation at. See --doc for more info.
Example: --doc=C:/Users/Me/Documents/myLuaProjectDocumentation
Type: string
Where the log should be written to. Defaults to ./log
Example: --logpath=D:/luaServer/logs
Type: string
The minimum level of logging that should appear in the logfile. Can be used to log more detailed info for debugging and error reporting.
Options:
- error
- warn
- info
- debug
- trace
Example: --loglevel=trace
Type: string
Where the standard Lua library definition files should be generated to. Defaults to ./meta
Example: --metapath=D:/sumnekoLua/metaDefintions
Type: string
The language to use. Defaults to en-us. Options can be found in locale/ .
Example: --locale=zh-cn
Type: string
The location of the configuration file that will be loaded. Can be relative to the workspace. When provided, config files from elsewhere (such as from VS Code) will no longer be loaded.
Example: --configpath=sumnekoLuaConfig.lua
Type: string
Get the version of the Lua language server. This will print it to the command line and immediately exit.
Type: string
Perform a "diagnosis report" where the results of the diagnosis are written to the logpath.
Example: --check=C:\Users\Me\path\to\workspace
Type: string
Default: Warning
To be used with --check. The minimum level of diagnostic that should be logged.
Items with lower priority than the one listed here will not be written to the
file. Options include, in order of priority:
- Error
- Warning
- Information
- Hint
Example: --checklevel=Information
Type: boolean
Allows the use of root/home directory as the workspace.
Type: number
Will communicate to a client over the specified TCP port instead of through stdio.
Example: --socket=5050
Type: boolean
Enables development mode. This allows plugins to write to the logpath.