Lua Language Server

The Lua language server provides a wide range of development features for Lua, including support for multiple Lua versions and advanced IDE capabilities.

Supported Lua Versions

• Lua 5.5
• Lua 5.4
• Lua 5.3
• Lua 5.2
• Lua 5.1
• LuaJIT

Key Features

• Code Intelligence: Go to definition, Find references, Autocompletion, and Hover to view details.
• Analysis: Dynamic type checking, Diagnostics/Warnings, Syntax checking, and Spell checking.
• Refactoring & Formatting: Element renaming and Code formatting.
• Documentation: Support for over 20 annotations and Documentation Generation.
• Extensibility: Support for libraries and Custom plugins.

The Lua language server can be installed for use in Visual Studio Code, NeoVim, and any other client that supports the Language Server Protocol (LSP).

For specific installation instructions tailored to your environment, visit the official website: https://luals.github.io/#install.

Adjust how the type system validates assignments and unions.

• type.castNumberToInteger: Allows assigning number to integer.
• type.weakNilCheck: If false, a union type like number|nil cannot be assigned to number. If true, it can.
• type.weakUnionCheck: If false, a union type like number|boolean cannot be assigned to number. If true, it can.

Modify the severity level of specific diagnostics.

To override the global group setting diagnostics.groupSeverity, append an exclamation mark ! to the value.

Available values:

• "Error"
• "Warning"
• "Information"
• "Hint"
• "Error!", "Warning!", "Information!", "Hint!" (overrides group setting)

Control how and when workspace-wide diagnostics are triggered to balance CPU usage and feedback latency.

• diagnostics.workspaceDelay: Latency in milliseconds before diagnostics run (default: 3000).
• diagnostics.workspaceEvent: Trigger mechanism:
  • "OnChange": Trigger when the file changes.
  • "OnSave": Trigger when the file is saved (default).
  • "None": Disable workspace diagnostics.
• diagnostics.workspaceRate: Run rate percentage (0-100). Lowering this reduces CPU usage (default: 100).

Enable the built-in code formatter and provide custom configuration.

• format.enable: Set to true to enable the formatter (default: true).
• format.defaultConfig: An object containing default format configuration. Note that .editorconfig files in the workspace take higher priority.

Control when specific diagnostics are triggered based on the file's state. You can specify whether diagnostics should run for all files, only opened files, or be disabled entirely.

To override the global group setting diagnostics.groupFileStatus, append an exclamation mark ! to the value.

Available values:

• "Any": Diagnose all files.
• "Opened": Only diagnose opened files.
• "None": Disable this diagnostic.
• "Any!", "Opened!", "None!": Overrides the group setting.

{
    "ambiguity-1": "Any",
    "assign-type-mismatch": "Opened",
    "await-in-sync": "None"
}

Manage how the language server interacts with your project files and external libraries.

• workspace.checkThirdParty: Automatic detection for libraries like OpenResty, LÖVE, skynet, etc. Options: "Ask", "Apply", "ApplyInMemory", "Disable".
• workspace.ignoreDir: Files/directories to ignore (uses .gitignore grammar).
• workspace.ignoreSubmodules: Whether to ignore submodules.
• workspace.library: Directories to load as external code libraries. Files here are treated as read-only (e.g., renaming fields won't modify them).
• workspace.maxPreload: Maximum number of preloaded files.
• workspace.preloadFileSize: Skip files larger than this value (KB) when preloading.
• workspace.useGitIgnore: Whether to use .gitignore for the ignore list.
• workspace.userThirdParty: Paths to private third-party library configuration files.

You can customize the behavior and severity of various Lua diagnostics (e.g., Warning, Hint, Information) by configuring the diagnostic keys in your settings. This allows you to enable or disable specific checks like unused-local, undefined-global, or spell-check.

{
    "ambiguity-1": "Warning",
    "unused-local": "Hint",
    "spell-check": "Information",
    "unreachable-code": "Hint"
}

Set the behavior for automatic code formatting while typing.

Use the typeFormat.config object to control:

• auto_complete_end: Automatically complete end at suitable positions.
• auto_complete_table_sep: Automatically append a separator at the end of table declarations.
• format_line: Whether a line is formatted at all.

"typeFormat.config" : {
    "auto_complete_end": "true",
    "auto_complete_table_sep": "true",
    "format_line": "true"
}