|
| 1 | +# lua-language-server |
| 2 | + |
| 3 | +| Windows | Linux | macOS | |
| 4 | +| ------- | ----- | ----- | |
| 5 | +| [](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master) | [](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master) | [](https://dev.azure.com/sumneko/lua-language-server/_build/latest?definitionId=1&branchName=master) |
| 6 | + |
| 7 | +## Feature |
| 8 | + |
| 9 | +- [x] Goto Definition |
| 10 | +- [x] Find All References |
| 11 | +- [x] Hover |
| 12 | +- [x] Diagnostics |
| 13 | +- [x] Rename |
| 14 | +- [x] Auto Completion |
| 15 | +- [x] IntelliSense |
| 16 | +- [x] Signature Help |
| 17 | +- [x] Document Symbols |
| 18 | +- [x] Syntax Check |
| 19 | +- [x] Highlight |
| 20 | +- [x] Code Action |
| 21 | +- [x] EmmyLua Annotation |
| 22 | +- [ ] Multi Workspace |
| 23 | +- [ ] Type Format |
| 24 | + |
| 25 | +## Preview |
| 26 | + |
| 27 | +### Goto Definition |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +### Find All References |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +### Hover |
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | +### Diagnostics |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +### Rename |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +### Auto Completion |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +### Signature Help |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +### Emmy Annotation |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +## How to use on macOS/Linux |
| 60 | + |
| 61 | +You need to build `lua-language-server` yourself on macOS/Linux. |
| 62 | + |
| 63 | +* Install [sumneko.lua] in VSCode |
| 64 | +* Install [extension-path] in VSCode |
| 65 | +* Install [ninja] |
| 66 | +* Clone source code |
| 67 | +``` |
| 68 | +git clone https://github.com/sumneko/lua-language-server |
| 69 | +cd lua-language-server |
| 70 | +git submodule update --init --recursive |
| 71 | +``` |
| 72 | +* Open repo and execute tasks in VSCode |
| 73 | + 1. PreCompile |
| 74 | + 2. Compile |
| 75 | + 3. Install |
| 76 | +* Restart VSCode and open your lua project |
| 77 | +* Enjoy |
| 78 | + |
| 79 | +[ninja]: https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages |
| 80 | +[sumneko.lua]: https://marketplace.visualstudio.com/items?itemName=sumneko.lua |
| 81 | +[extension-path]: https://marketplace.visualstudio.com/items?itemName=actboy168.extension-path |
| 82 | + |
| 83 | +## Version |
| 84 | + |
| 85 | +- [x] Lua 5.1 |
| 86 | +- [x] Lua 5.2 |
| 87 | +- [x] Lua 5.3 |
| 88 | +- [x] Lua 5.4 |
| 89 | +- [x] LuaJIT |
| 90 | + |
| 91 | +If you find any mistakes, please [tell me][issues] or use [Pull Requests][@lua] to fix them directly. |
| 92 | + |
| 93 | +如果你发现了任何错误,请[告诉我][issues]或使用[Pull Requests][@lua]来直接修复。 |
| 94 | + |
| 95 | +[issues]: https://github.com/sumneko/lua-language-server/issues |
| 96 | +[@lua]: https://github.com/sumneko/lua-language-server/tree/master/server/libs/%40lua |
| 97 | + |
| 98 | +## Locale |
| 99 | + |
| 100 | +- [x] en-US |
| 101 | +- [x] zh-CN |
| 102 | + |
| 103 | +Please [help me][en-US] improve the quality of `en-US`. |
| 104 | + |
| 105 | +[en-US]: https://github.com/sumneko/vscode-lua-language-server/tree/master/server/locale/en-US |
| 106 | + |
| 107 | +## Credit |
| 108 | + |
| 109 | +* [bee.lua](https://github.com/actboy168/bee.lua) |
| 110 | +* [luamake](https://github.com/actboy168/luamake) |
| 111 | +* [lni](https://github.com/actboy168/lni) |
| 112 | +* [LPegLabel](https://github.com/sqmedeiros/lpeglabel) |
| 113 | +* [LuaParser](https://github.com/sumneko/LuaParser) |
| 114 | +* [rcedit](https://github.com/electron/rcedit) |
| 115 | +* [ScreenToGif](https://github.com/NickeManarin/ScreenToGif) |
| 116 | +* [vscode-languageclient](https://github.com/microsoft/vscode-languageserver-node) |
| 117 | +* [lua.tmbundle](https://github.com/textmate/lua.tmbundle) |
| 118 | +* [Lua 5.3 中文翻译](https://cloudwu.github.io/lua53doc/manual.html) |
| 119 | +* [EmmyLua](https://emmylua.github.io) |
| 120 | +* [lua-glob](https://github.com/sumneko/lua-glob) |
| 121 | +* [lua-uri](https://github.com/sumneko/lua-uri) |
| 122 | +* [JSON4Lua](http://github.com/craigmj/json4lua/) |
| 123 | + |
| 124 | +## Acknowledgement |
| 125 | + |
| 126 | +* [actboy168](https://github.com/actboy168) |
| 127 | +* [Dmitry Sannikov](https://github.com/dasannikov) |
| 128 | +* [Jayden Charbonneau](https://github.com/Reshiram110) |
| 129 | +* [Stjepan Bakrac](https://github.com/z16) |
| 130 | +* [Peter Young](https://github.com/young40) |
| 131 | +* [Li Xiaobin](https://github.com/Xiaobin0860) |
| 132 | +* [Fedora7](https://github.com/Fedora7) |
| 133 | +* [Allen Shaw](https://github.com/shuxiao9058) |
| 134 | +* [Bartel](https://github.com/Letrab) |
0 commit comments