Diagnosis Report

⚠️ Warning

This wiki has been replaced by the wiki on our website. This wiki will be removed in the future.

Diagnosis Report

A diagnosis report is a file that can be generated by the language server that provides the same info a client usually receives.

Create a Report

You can use the command line to perform a diagnosis of your workspace and export the results to a file. This report will use the .luarc.json in the target workspace (unless otherwise specified with --configpath)

The command should looks like this:

lua-language-server --check E:\programming\myLuaProject --checklevel=warning

The server will exit once the report is complete. The report will be written to check.json in your logpath (unless otherwise specified with --logpath).

How it Works

The check command will start a virtual client that opens all files in the target workspace, retrieves all diagnostic info, and writes it to a file.

ℹ️ Note: Since each file is being opened, "Opened" has the same effect as "Any" for Lua.diagnostics.neededFileStatus and Lua.diagnostics.groupFileStatus.