plugins.lsp.servers.lua_ls.settings.hint.enable

Whether inline hints should be enabled or not.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.arrayIndex

  • "Enable" - Show hint in all tables
  • "Auto" - Only show hint when there is more than 3 items or the table is mixed (indexes and keys)
  • "Disable" - Disable array index hints

Type: null or one of “Enable”, “Auto”, “Disable” or raw lua code

Default: null

Plugin default: "Auto"

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.await

If a function has been defined as @async, display an await hint when it is being called.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.paramName

Whether parameter names should be hinted when typing out a function call.

  • "All" - All parameters are hinted
  • "Literal" - Only literal type parameters are hinted
  • "Disable" - No parameter hints are shown

Type: null or one of “All”, “Literal”, “Disable” or raw lua code

Default: null

Plugin default: "All"

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.paramType

Show a hint for parameter types at a function definition. Requires the parameters to be defined with @param.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.semicolon

Whether to show a hint to add a semicolon to the end of a statement.

  • "All" - Show on every line
  • "SameLine" - Show between two statements on one line
  • "Disable" - Never hint a semicolon

Type: null or one of “All”, “SameLine”, “Disable” or raw lua code

Default: null

Plugin default: "SameLine"

Declared by:

plugins.lsp.servers.lua_ls.settings.hint.setType

Show a hint to display the type being applied at assignment operations.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: