Skip to content

Commit b301c48

Browse files
committed
3.5.2
1 parent 260b07e commit b301c48

File tree

13 files changed

+111
-98
lines changed

13 files changed

+111
-98
lines changed

README.md

Lines changed: 77 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,107 @@
11
# lua-language-server
22

33

4-
![version](https://vsmarketplacebadge.apphb.com/version-short/sumneko.lua.svg)
4+
[![version](https://vsmarketplacebadge.apphb.com/version-short/sumneko.lua.svg)](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
55
![installs](https://vsmarketplacebadge.apphb.com/installs-short/sumneko.lua.svg)
66
![downloads](https://vsmarketplacebadge.apphb.com/downloads-short/sumneko.lua.svg)
7+
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/sumneko/lua-language-server.svg)](https://github.com/sumneko/lua-language-server/issues "Average time to resolve an issue")
78

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

11-
![avatar](https://github.com/sumneko/vscode-lua/raw/master/images//Install%20In%20VSCode.gif)
10+
***Lua development just got a whole lot better*** 🧠
1211

13-
## Change Log
14-
https://github.com/sumneko/lua-language-server/blob/master/changelog.md
12+
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.
1513

16-
## Wiki
17-
https://github.com/sumneko/lua-language-server/wiki
14+
## Features
1815

19-
## Feature
16+
- 📄 Over 20 supported [annotations](https://github.com/sumneko/lua-language-server/wiki/Annotations) for documenting your code
17+
- ↪ Go to definition
18+
- 🦺 Dynamic [type checking](https://github.com/sumneko/lua-language-server/wiki/Type-Checking)
19+
- 🔍 Find references
20+
- ⚠️ [Diagnostics/Warnings](https://github.com/sumneko/lua-language-server/wiki/Diagnostics)
21+
- 🕵️ [Syntax checking](https://github.com/sumneko/lua-language-server/wiki/Syntax-Errors)
22+
- 📝 Element renaming
23+
- 🗨️ Hover to view details on variables, functions, and more
24+
- 🖊️ Autocompletion
25+
- 📚 Support for [libraries](https://github.com/sumneko/lua-language-server/wiki/Libraries)
26+
- 💅 [Code formatting](https://github.com/sumneko/lua-language-server/wiki/Formatter)
27+
- 💬 [Spell checking](https://github.com/sumneko/lua-language-server/wiki/Formatter)
28+
- 🛠️ Custom [plugins](https://github.com/sumneko/lua-language-server/wiki/Plugins)
2029

21-
- [x] Goto Definition
22-
- [x] Find All References
23-
- [x] Hover
24-
- [x] Diagnostics
25-
- [x] Rename
26-
- [x] Auto Completion
27-
- [x] IntelliSense
28-
- [x] Signature Help
29-
- [x] Document Symbols
30-
- [x] Workspace Symbols
31-
- [x] Syntax Check
32-
- [x] Highlight
33-
- [x] Code Action
34-
- [x] EmmyLua Annotation
35-
- [x] Multi Workspace
36-
- [x] Semantic Tokens
37-
- [x] Formatter
30+
## Install
3831

39-
## Version
32+
The language server can easily be installed for use in VS Code, but it can also be used by other clients using the command line.
4033

41-
- [x] Lua 5.1
42-
- [x] Lua 5.2
43-
- [x] Lua 5.3
44-
- [x] Lua 5.4
45-
- [x] LuaJIT
34+
### Visual Studio Code
35+
[![Install in VS Code](https://img.shields.io/badge/Install%20For-VS%20Code-blue?style=for-the-badge&logo=visualstudiocode "Install in VS Code")](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
4636

47-
If you find any mistakes, please [tell me][issues] or use [Pull Requests][@meta] to fix them directly.
37+
The language server and Visual Studio Code client can be installed from [the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sumneko.lua).
4838

49-
如果你发现了任何错误,请[告诉我][issues]或使用[Pull Requests][@meta]来直接修复。
39+
![](https://github.com/sumneko/vscode-lua/raw/master/images//Install%20In%20VSCode.gif)
40+
41+
### Command Line
42+
[![Install for command line](https://img.shields.io/badge/Install%20For-Command%20Line-blue?style=for-the-badge&logo=windowsterminal "Install for command line")](https://github.com/sumneko/lua-language-server/wiki/Getting-Started#command-line)
43+
44+
Check the [wiki for a guide](https://github.com/sumneko/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 for NeoVim and other clients that follow the language server protocol.
45+
46+
## Supported Lua Versions
47+
| Version | Supported |
48+
| :-----: | :------------: |
49+
| Lua 5.1 | ![][checkmark] |
50+
| Lua 5.2 | ![][checkmark] |
51+
| Lua 5.3 | ![][checkmark] |
52+
| Lua 5.4 | ![][checkmark] |
53+
| LuaJIT | ![][checkmark] |
54+
55+
## Links
56+
- [Changelog](https://github.com/sumneko/lua-language-server/blob/master/changelog.md)
57+
- [Wiki](https://github.com/sumneko/lua-language-server/wiki)
58+
- [FAQ](https://github.com/sumneko/lua-language-server/wiki/FAQ)
59+
- [Report an issue][issues]
60+
- [Suggest a feature][issues]
61+
- [Discuss](https://github.com/sumneko/lua-language-server/discussions)
62+
63+
> If you find any mistakes, please [report it][issues] or open a [pull request][pulls] if you have a fix of your own ❤️
64+
>
65+
> 如果你发现了任何错误,请[告诉我][issues]或使用[Pull Requests][pulls]来直接修复。❤️
5066
5167
[issues]: https://github.com/sumneko/lua-language-server/issues
52-
[@meta]: https://github.com/sumneko/lua-language-server/tree/master/meta/template
68+
[pulls]: https://github.com/sumneko/lua-language-server/pulls
69+
70+
## Available Languages
5371

54-
## Locale
72+
- `en-us` 🇺🇸
73+
- `zh-cn` 🇨🇳
74+
- `zh-tw` 🇹🇼
75+
- `pt-br` 🇧🇷
5576

56-
- [x] en-us
57-
- [x] zh-cn
58-
- [x] zh-tw (thanks [AlexCai2019](https://github.com/AlexCai2019))
59-
- [x] pt-br (thanks [Jeferson Ferreira](https://github.com/jefersonf))
6077

61-
Please [help me][en-US] improve the quality of `en-US`.
78+
> ℹ 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/sumneko/lua-language-server/issues).
79+
80+
Are you able to [provide a translation](https://github.com/sumneko/lua-language-server/wiki/Translations)? It would be greatly appreciated!
81+
82+
Thank you to [all contributors of translations](https://github.com/sumneko/lua-language-server/commits/master/locale)!
6283

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

65-
## Build
66-
The extensions in the VSCode market already come with pre-compiled binary files, usually you don't need to compile them.
86+
## Configuration
87+
Configuration of the server can be done in a number of ways, which are explained more in-depth in the [wiki](https://github.com/sumneko/lua-language-server/wiki/Configuration-File).
88+
89+
### Visual Studio Code
90+
You can use the [settings editor](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor) or edit the [raw JSON file](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson).
6791

68-
Other clients can first try to download and use [pre-compiled binary files](https://github.com/sumneko/lua-language-server/wiki/PreCompiled-Binaries).
92+
### Other
93+
See the [configuration file wiki page](https://github.com/sumneko/lua-language-server/wiki/Configuration-File).
6994

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

72-
## Setting
96+
## Privacy
97+
This language server has **opt-in** telemetry that 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/Home#privacy) to learn more.
7398

74-
* In VSCode: Just use the setting of VSCode.
75-
* Standalone: See https://github.com/sumneko/lua-language-server/wiki/Setting
99+
100+
## Contributors
101+
![GitHub Contributors Image](https://contrib.rocks/image?repo=sumneko/lua-language-server)
76102

77103
## Credit
104+
Software that the language server (or the development of it) uses:
78105

79106
* [bee.lua](https://github.com/actboy168/bee.lua)
80107
* [luamake](https://github.com/actboy168/luamake)
@@ -91,27 +118,5 @@ If you need to compile by yourself, please refer to [here](https://github.com/su
91118
* [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle)
92119
* [inspect.lua](https://github.com/kikito/inspect.lua)
93120

94-
## Acknowledgement
95-
96-
* [actboy168](https://github.com/actboy168)
97-
* [Dmitry Sannikov](https://github.com/dasannikov)
98-
* [Jayden Charbonneau](https://github.com/Reshiram110)
99-
* [Stjepan Bakrac](https://github.com/z16)
100-
* [Peter Young](https://github.com/young40)
101-
* [Li Xiaobin](https://github.com/Xiaobin0860)
102-
* [Fedora7](https://github.com/Fedora7)
103-
* [Allen Shaw](https://github.com/shuxiao9058)
104-
* [Bartel](https://github.com/Letrab)
105-
* [Ruin0x11](https://github.com/Ruin0x11)
106-
* [uhziel](https://github.com/uhziel)
107-
* [火凌之](https://github.com/PhoenixZeng)
108-
* [CppCXY](https://github.com/CppCXY)
109-
* [Ketho](https://github.com/Ketho)
110-
* [Folke Lemaitre](https://github.com/folke)
111-
* [Vikas Raj](https://github.com/numToStr)
112-
* [kevinhwang91](https://github.com/kevinhwang91)
113-
* [Cassolette](https://github.com/Cassolette)
114-
115-
## Telemetry
116-
117-
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.
121+
122+
[checkmark]: https://gist.githubusercontent.com/carsakiller/362482775731de88cdafeeca9f6a392e/raw/cd3976e92a85aafe1f33e3f9fe3d0e0bd451902c/checkmark.svg

changelog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# changelog
22

3+
## 3.5.2
4+
`2022-8-1`
5+
* `FIX` [#1395](https://github.com/sumneko/lua-language-server/issues/1395)
6+
* `FIX` [#1403](https://github.com/sumneko/lua-language-server/issues/1403)
7+
* `FIX` [#1405](https://github.com/sumneko/lua-language-server/issues/1405)
8+
* `FIX` [#1406](https://github.com/sumneko/lua-language-server/issues/1406)
9+
* `FIX` [#1418](https://github.com/sumneko/lua-language-server/issues/1418)
10+
311
## 3.5.1
412
`2022-7-26`
513
* `NEW` supports [color](https://github.com/sumneko/lua-language-server/pull/1379)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2905,5 +2905,5 @@
29052905
"sponsor": {
29062906
"url": "https://github.com/sumneko/lua-language-server/issues/484"
29072907
},
2908-
"version": "3.5.1"
2908+
"version": "3.5.2"
29092909
}

package.nls.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"config.diagnostics.lowercase-global": "Enable lowercase global variable definition diagnostics.",
5656
"config.diagnostics.luadoc": "* circle-doc-class\n* doc-field-no-class\n* duplicate-doc-alias\n* duplicate-doc-field\n* duplicate-doc-param\n* undefined-doc-class\n* undefined-doc-name\n* undefined-doc-param\n* unknown-cast-variable\n* unknown-diag-code\n* unknown-operator",
5757
"config.diagnostics.neededFileStatus": "* Opened: only diagnose opened files\n* Any: diagnose all files\n* None: disable this diagnostic\n\nEnd with `!` means override the group setting `diagnostics.groupFileStatus`.\n",
58-
"config.diagnostics.newfield-call": "在字面量表中,2行代码之间缺少分隔符,在语法上被解析为了一次索引操作",
58+
"config.diagnostics.newfield-call": "Enable newfield call diagnostics. It is raised when the parenthesis of a function call appear on the following line when defining a field in a table.",
5959
"config.diagnostics.newline-call": "Enable newline call diagnostics. Is's raised when a line starting with `(` is encountered, which is syntactically parsed as a function call on the previous line.",
6060
"config.diagnostics.redefined": "* redefined-local",
6161
"config.diagnostics.redefined-local": "Enable redefined local variable diagnostics.",
@@ -112,7 +112,7 @@
112112
"config.runtime.nonstandardSymbol": "Supports non-standard symbols. Make sure that your runtime environment supports these symbols.",
113113
"config.runtime.path": "When using `require`, how to find the file based on the input name.\nSetting this config to `?/init.lua` means that when you enter `require 'myfile'`, `${workspace}/myfile/init.lua` will be searched from the loaded files.\nif `runtime.pathStrict` is `false`, `${workspace}/**/myfile/init.lua` will also be searched.\nIf you want to load files outside the workspace, you need to set `Lua.workspace.library` first.\n",
114114
"config.runtime.pathStrict": "When enabled, `runtime.path` will only search the first level of directories, see the description of `runtime.path`.",
115-
"config.runtime.plugin": "Plugin path. Please read [wiki](https://github.com/sumneko/lua-language-server/wiki/Plugin) to learn more.",
115+
"config.runtime.plugin": "Plugin path. Please read [wiki](https://github.com/sumneko/lua-language-server/wiki/Plugins) to learn more.",
116116
"config.runtime.pluginArgs": "Additional arguments for the plugin.",
117117
"config.runtime.special": "The custom global variables are regarded as some special built-in variables, and the language server will provide special support\nThe following example shows that 'include' is treated as' require '.\n```json\n\"Lua.runtime.special\" : {\n \"include\" : \"require\"\n}\n```\n",
118118
"config.runtime.unicodeName": "Allows Unicode characters in name.",
@@ -123,7 +123,7 @@
123123
"config.semantic.variable": "Semantic coloring of variables/fields/parameters.",
124124
"config.signatureHelp.enable": "Enable signature help.",
125125
"config.spell.dict": "Custom words for spell checking.",
126-
"config.telemetry.enable": "Enable telemetry to send your editor information and error logs over the network. Read our privacy policy [here](https://github.com/sumneko/lua-language-server/wiki/Privacy-Policy).\n",
126+
"config.telemetry.enable": "Enable telemetry to send your editor information and error logs over the network. Read our privacy policy [here](https://github.com/sumneko/lua-language-server/wiki/Home#privacy).\n",
127127
"config.type.castNumberToInteger": "Allowed to assign the `number` type to the `integer` type.",
128128
"config.type.weakNilCheck": "When checking the type of union type, ignore the `nil` in it.\n\nWhen this setting is `false`, the `number|nil` type cannot be assigned to the `number` type. It can be with `true`.\n",
129129
"config.type.weakUnionCheck": "Once one subtype of a union type meets the condition, the union type also meets the condition.\n\nWhen this setting is `false`, the `number|boolean` type cannot be assigned to the `number` type. It can be with `true`.\n",

package.nls.pt-br.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
"config.runtime.nonstandardSymbol": "Supports non-standard symbols. Make sure that your runtime environment supports these symbols.",
113113
"config.runtime.path": "When using `require`, how to find the file based on the input name.\nSetting this config to `?/init.lua` means that when you enter `require 'myfile'`, `${workspace}/myfile/init.lua` will be searched from the loaded files.\nif `runtime.pathStrict` is `false`, `${workspace}/**/myfile/init.lua` will also be searched.\nIf you want to load files outside the workspace, you need to set `Lua.workspace.library` first.\n",
114114
"config.runtime.pathStrict": "When enabled, `runtime.path` will only search the first level of directories, see the description of `runtime.path`.",
115-
"config.runtime.plugin": "Plugin path. Please read [wiki](https://github.com/sumneko/lua-language-server/wiki/Plugin) to learn more.",
115+
"config.runtime.plugin": "Plugin path. Please read [wiki](https://github.com/sumneko/lua-language-server/wiki/Plugins) to learn more.",
116116
"config.runtime.pluginArgs": "Additional arguments for the plugin.",
117117
"config.runtime.special": "The custom global variables are regarded as some special built-in variables, and the language server will provide special support\nThe following example shows that 'include' is treated as' require '.\n```json\n\"Lua.runtime.special\" : {\n \"include\" : \"require\"\n}\n```\n",
118118
"config.runtime.unicodeName": "Allows Unicode characters in name.",
@@ -123,7 +123,7 @@
123123
"config.semantic.variable": "Semantic coloring of variables/fields/parameters.",
124124
"config.signatureHelp.enable": "Enable signature help.",
125125
"config.spell.dict": "Custom words for spell checking.",
126-
"config.telemetry.enable": "Enable telemetry to send your editor information and error logs over the network. Read our privacy policy [here](https://github.com/sumneko/lua-language-server/wiki/Privacy-Policy).\n",
126+
"config.telemetry.enable": "Enable telemetry to send your editor information and error logs over the network. Read our privacy policy [here](https://github.com/sumneko/lua-language-server/wiki/Home#privacy).\n",
127127
"config.type.castNumberToInteger": "Allowed to assign the `number` type to the `integer` type.",
128128
"config.type.weakNilCheck": "When checking the type of union type, ignore the `nil` in it.\n\nWhen this setting is `false`, the `number|nil` type cannot be assigned to the `number` type. It can be with `true`.\n",
129129
"config.type.weakUnionCheck": "Once one subtype of a union type meets the condition, the union type also meets the condition.\n\nWhen this setting is `false`, the `number|boolean` type cannot be assigned to the `number` type. It can be with `true`.\n",

0 commit comments

Comments
 (0)