1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# lua-language-server
[](https://github.com/LuaLS/lua-language-server/actions/workflows/build.yml)
[](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
***Lua development just got a whole lot better*** ๐ง
The Lua language server provides various language features for Lua to make development easier and faster. With around half a million installs on Visual Studio Code, it is the most popular extension for Lua language support.
## Features
- โ๏ธ Supports `Lua 5.4`, `Lua 5.3`, `Lua 5.2`, `Lua 5.1`, and `LuaJIT`
- ๐ Over 20 supported [annotations](https://github.com/LuaLS/lua-language-server/wiki/Annotations) for documenting your code
- โช Go to definition
- ๐ฆบ Dynamic [type checking](https://github.com/LuaLS/lua-language-server/wiki/Type-Checking)
- ๐ Find references
- โ ๏ธ [Diagnostics/Warnings](https://github.com/LuaLS/lua-language-server/wiki/Diagnostics)
- ๐ต๏ธ [Syntax checking](https://github.com/LuaLS/lua-language-server/wiki/Syntax-Errors)
- ๐ Element renaming
- ๐จ๏ธ Hover to view details on variables, functions, and more
- ๐๏ธ Autocompletion
- ๐ Support for [libraries](https://github.com/LuaLS/lua-language-server/wiki/Libraries)
- ๐
[Code formatting](https://github.com/LuaLS/lua-language-server/wiki/Formatter)
- ๐ฌ [Spell checking](https://github.com/LuaLS/lua-language-server/wiki/Formatter)
- ๐ ๏ธ Custom [plugins](https://github.com/LuaLS/lua-language-server/wiki/Plugins)
- ๐ [Documentation Generation](https://github.com/LuaLS/lua-language-server/wiki/Export-Documentation)
## Install
The language server can be installed for use in Visual Studio Code, NeoVim, and any [other clients](https://microsoft.github.io/language-server-protocol/implementors/tools/) that support the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/). The language server can be configured using a [configuration file](https://github.com/LuaLS/lua-language-server/wiki/Configuration-File). For a more detailed intro, check out the [getting started page in the wiki](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started).
### Visual Studio Code
[](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
The language server and Visual Studio Code client can be installed from [the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sumneko.lua).
### NeoVim
[](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#lua_ls)
View the installation instructions for NeoVim in the [nvim-lspconfig repo](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#lua_ls).
For a guide to getting started from scratch using Mason, read [Heiker's guide](https://dev.to/vonheikemen/getting-started-with-neovims-native-lsp-client-in-the-year-of-2022-the-easy-way-bp3).
### Command Line
[](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#command-line)
Check the [wiki for a guide](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#command-line) to install the language server for use on the command line. This allows the language server to be used with [other clients](https://microsoft.github.io/language-server-protocol/implementors/tools/) that follow the [language server protocol](https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/).
### Community Install Methods
The install methods below are maintained by community members.
[asdf plugin](https://github.com/bellini666/asdf-lua-language-server)
## Links
- [Changelog](https://github.com/LuaLS/lua-language-server/blob/master/changelog.md)
- [Wiki](https://github.com/LuaLS/lua-language-server/wiki)
- [FAQ](https://github.com/LuaLS/lua-language-server/wiki/FAQ)
- [Report an issue][issues]
- [Suggest a feature][issues]
- [Discuss](https://github.com/LuaLS/lua-language-server/discussions)
> If you find any mistakes, please [report it][issues] or open a [pull request][pulls] if you have a fix of your own โค๏ธ
>
> ๅฆๆไฝ ๅ็ฐไบไปปไฝ้่ฏฏ๏ผ่ฏท[ๅ่ฏๆ][issues]ๆไฝฟ็จ[Pull Requests][pulls]ๆฅ็ดๆฅไฟฎๅคใโค๏ธ
[issues]: https://github.com/LuaLS/lua-language-server/issues
[pulls]: https://github.com/LuaLS/lua-language-server/pulls
## Available Languages
- `en-us` ๐บ๐ธ
- `zh-cn` ๐จ๐ณ
- `zh-tw` ๐น๐ผ
- `pt-br` ๐ง๐ท
> **Note**
> All translations are provided and collaborated on by the community. If you find an inappropriate or harmful translation, [please report it immediately](https://github.com/LuaLS/lua-language-server/issues).
Are you able to [provide a translation](https://github.com/LuaLS/lua-language-server/wiki/Translations)? It would be greatly appreciated!
Thank you to [all contributors of translations](https://github.com/LuaLS/lua-language-server/commits/master/locale)!
## Privacy
The language server had **opt-in** telemetry that collected usage data and sent it to the development team to help improve the extension. Read our [privacy policy](https://github.com/LuaLS/lua-language-server/wiki/Home#privacy) to learn more. Telemetry was removed in `v3.6.5` and is no longer part of the language server.
## Contributors
## Credit
Software that the language server (or the development of it) uses:
* [bee.lua](https://github.com/actboy168/bee.lua)
* [luamake](https://github.com/actboy168/luamake)
* [LPegLabel](https://github.com/sqmedeiros/lpeglabel)
* [LuaParser](https://github.com/LuaLS/LuaParser)
* [ScreenToGif](https://github.com/NickeManarin/ScreenToGif)
* [vscode-languageclient](https://github.com/microsoft/vscode-languageserver-node)
* [lua.tmbundle](https://github.com/textmate/lua.tmbundle)
* [EmmyLua](https://emmylua.github.io)
* [lua-glob](https://github.com/LuaLS/lua-glob)
* [utility](https://github.com/LuaLS/utility)
* [vscode-lua-doc](https://github.com/actboy168/vscode-lua-doc)
* [json.lua](https://github.com/actboy168/json.lua)
* [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle)
* [inspect.lua](https://github.com/kikito/inspect.lua)
|
