plugins.lsp.servers.lua_ls.settings.workspace.checkThirdParty

Whether third party libraries can be automatically detected and applied. Third party libraries can set up the environment to be as close as possible to your target runtime environment. See meta/3rd to view what third party libraries are currently supported.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.ignoreDir

An array of paths that will be ignored and not included in the workspace diagnosis. Uses .gitignore grammar. Can be a file or directory.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  ".vscode"
]

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.ignoreSubmodules

Whether git submodules should be ignored and not included in the workspace diagnosis.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.library

An array of abosolute or workspace-relative paths that will be added to the workspace diagnosis - meaning you will get completion and context from these library files. Can be a file or directory. Files included here will have some features disabled such as renaming fields to prevent accidentally renaming your library files. Read more on the Libraries page.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.maxPreload

The maximum amount of files that can be diagnosed. More files will require more RAM.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 5000

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.preloadFileSize

Files larger than this value (in KB) will be skipped when loading for workspace diagnosis.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 500

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.supportScheme

Lua file schemes to enable the language server for.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "file"
  "untitled"
  "git"
]

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.useGitIgnore

Whether files that are in .gitignore should be ignored by the language server when performing workspace diagnosis.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.lsp.servers.lua_ls.settings.workspace.userThirdParty

An array of paths to custom third party libraries. This path should point to a directory where all of your custom libraries are, not just to one of the libraries. If the below is your file structure, this setting should be "myLuaLibraries" - of course this should be an absolute path though.

📦 myLuaLibraries/
    ├── 📂 myCustomLibrary/
    │   ├── 📂 library/
    │   └── 📜 config.lua
    └── 📂 anotherCustomLibrary/
        ├── 📂 library/
        └── 📜 config.lua

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: [ ]

Declared by: