README.md


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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# lua-language-server

![build](https://github.com/sumneko/lua-language-server/workflows/build/badge.svg)
![version](https://vsmarketplacebadge.apphb.com/version-short/sumneko.lua.svg)
![installs](https://vsmarketplacebadge.apphb.com/installs-short/sumneko.lua.svg)
![downloads](https://vsmarketplacebadge.apphb.com/downloads-short/sumneko.lua.svg)

## Install In VSCode
https://marketplace.visualstudio.com/items?itemName=sumneko.lua

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images//Install%20In%20VSCode.gif)

## Change Log
https://github.com/sumneko/lua-language-server/blob/master/changelog.md

## Wiki
https://github.com/sumneko/lua-language-server/wiki

## Feature

- [x] Goto Definition
- [x] Find All References
- [x] Hover
- [x] Diagnostics
- [x] Rename
- [x] Auto Completion
- [x] IntelliSense
- [x] Signature Help
- [x] Document Symbols
- [x] Workspace Symbols
- [x] Syntax Check
- [x] Highlight
- [x] Code Action
- [x] EmmyLua Annotation
- [x] Multi Workspace
- [x] Semantic Tokens
- [ ] Type Format

## Preview

### Goto Definition

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images//Goto%20Definition.gif)

### Find All References

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images//Find%20All%20References.gif)

### Hover

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Hover.gif)

### Diagnostics

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Diagnostics.gif)

### Rename

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Rename.gif)

### Auto Completion

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Auto%20Completion.gif)

### Signature Help

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Signature%20Help.gif)

### Emmy Annotation

![avatar](https://github.com/sumneko/vscode-lua/raw/master/images/Emmy%20Annotation.gif)

## Version

- [x] Lua 5.1
- [x] Lua 5.2
- [x] Lua 5.3
- [x] Lua 5.4
- [x] LuaJIT

If you find any mistakes, please [tell me][issues] or use [Pull Requests][@meta] to fix them directly.

如果你发现了任何错误，请[告诉我][issues]或使用[Pull Requests][@meta]来直接修复。

[issues]: https://github.com/sumneko/lua-language-server/issues
[@meta]: https://github.com/sumneko/lua-language-server/tree/master/meta/template

## Locale

- [x] en-us
- [x] zh-cn
- [x] pt-br (thanks [Jeferson Ferreira](https://github.com/jefersonf))

Please [help me][en-US] improve the quality of `en-US`.

[en-US]: https://github.com/sumneko/lua-language-server/tree/master/locale/en-us

## Build
The extensions in the VSCode market already come with pre-compiled binary files, usually you don't need to compile them.

Other clients can first try to download and use [pre-compiled binary files](https://github.com/sumneko/lua-language-server/wiki/PreCompiled-Binaries).

If you need to compile by yourself, please refer to [here](https://github.com/sumneko/lua-language-server/wiki/Build-and-Run)

## Setting

* In VSCode: Just use the setting of VSCode.
* Standalone: See https://github.com/sumneko/lua-language-server/wiki/Setting

## Credit

* [bee.lua](https://github.com/actboy168/bee.lua)
* [luamake](https://github.com/actboy168/luamake)
* [lni](https://github.com/actboy168/lni)
* [LPegLabel](https://github.com/sqmedeiros/lpeglabel)
* [LuaParser](https://github.com/sumneko/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/sumneko/lua-glob)
* [utility](https://github.com/sumneko/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)

## Acknowledgement

* [actboy168](https://github.com/actboy168)
* [Dmitry Sannikov](https://github.com/dasannikov)
* [Jayden Charbonneau](https://github.com/Reshiram110)
* [Stjepan Bakrac](https://github.com/z16)
* [Peter Young](https://github.com/young40)
* [Li Xiaobin](https://github.com/Xiaobin0860)
* [Fedora7](https://github.com/Fedora7)
* [Allen Shaw](https://github.com/shuxiao9058)
* [Bartel](https://github.com/Letrab)
* [Ruin0x11](https://github.com/Ruin0x11)
* [uhziel](https://github.com/uhziel)
* [火凌之](https://github.com/PhoenixZeng)
* [CppCXY](https://github.com/CppCXY)
* [Ketho](https://github.com/Ketho)
* [Folke Lemaitre](https://github.com/folke)
* [Vikas Raj](https://github.com/numToStr)
* [kevinhwang91](https://github.com/kevinhwang91)
* [Cassolette](https://github.com/Cassolette)

## Telemetry

This language server collects usage data and sends it to the development team to help improve the extension. Read our [privacy policy](https://github.com/sumneko/lua-language-server/wiki/Privacy-Policy) to learn more and how to disable any telemetry.