summaryrefslogtreecommitdiff
path: root/README.md
blob: c7cb6cb012bdd8badef3f16a53dd832e2e32f868 (plain)
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
# lua-language-server

| Windows | Linux | macOS |
| ------- | ----- | ----- |
| [![Build Status](https://dev.azure.com/sumneko/lua-language-server/_apis/build/status/sumneko.lua-language-server?branchName=master&jobName=windows)](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master) | [![Build Status](https://dev.azure.com/sumneko/lua-language-server/_apis/build/status/sumneko.lua-language-server?branchName=master&jobName=linux)](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master) | [![Build Status](https://dev.azure.com/sumneko/lua-language-server/_apis/build/status/sumneko.lua-language-server?branchName=master&jobName=macos)](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master)

## 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] Syntax Check
- [x] Highlight
- [x] Code Action
- [x] EmmyLua Annotation
- [ ] Multi Workspace
- [ ] Type Format

## Preview

### Goto Definition

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

### Find All References

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

### Hover

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

### Diagnostics

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

### Rename

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

### Auto Completion

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

### Signature Help

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

### Emmy Annotation

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

## How to use on macOS/Linux

You need to build `lua-language-server` yourself on macOS/Linux.

* Install [sumneko.lua] in VSCode
* Install [extension-path] in VSCode
* Install [ninja]
* Clone source code
```
git clone https://github.com/sumneko/lua-language-server
cd lua-language-server
git submodule update --init --recursive
```
* Open repo and execute tasks in VSCode
    1. PreCompile
    2. Compile
    3. Install
* Restart VSCode and open your lua project
* Enjoy

[ninja]: https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages
[sumneko.lua]: https://marketplace.visualstudio.com/items?itemName=sumneko.lua
[extension-path]: https://marketplace.visualstudio.com/items?itemName=actboy168.extension-path

## 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][@lua] to fix them directly.

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

[issues]: https://github.com/sumneko/lua-language-server/issues
[@lua]: https://github.com/sumneko/lua-language-server/tree/master/server/libs/%40lua

## Locale

- [x] en-US
- [x] zh-CN

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

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

## 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)
* [rcedit](https://github.com/electron/rcedit)
* [ScreenToGif](https://github.com/NickeManarin/ScreenToGif)
* [vscode-languageclient](https://github.com/microsoft/vscode-languageserver-node)
* [lua.tmbundle](https://github.com/textmate/lua.tmbundle)
* [Lua 5.3 中文翻译](https://cloudwu.github.io/lua53doc/manual.html)
* [EmmyLua](https://emmylua.github.io)
* [lua-glob](https://github.com/sumneko/lua-glob)
* [lua-uri](https://github.com/sumneko/lua-uri)
* [JSON4Lua](http://github.com/craigmj/json4lua/)

## 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)