Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ body:
label: Log File
description: >
Please provide your log file. Refer to the wiki to find your log file:
https://github.com/LuaLS/lua-language-server/wiki/FAQ#where-can-i-find-the-log-file
https://luals.github.io/wiki/faq#where-can-i-find-the-log-file
- type: markdown
attributes:
value: |
Expand Down
51 changes: 21 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,36 @@

***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.
The Lua language server provides various language features for Lua to make development easier and faster. With nearly a million installs in Visual Studio Code, it is the most popular extension for Lua language support.

[See our website for more info](https://luals.github.io).

## 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
- 📄 Over 20 supported [annotations](https://luals.github.io/wiki/annotations/) for documenting your code
- ↪ Go to definition
- 🦺 Dynamic [type checking](https://github.com/LuaLS/lua-language-server/wiki/Type-Checking)
- 🦺 Dynamic [type checking](https://luals.github.io/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)
- ⚠️ [Diagnostics/Warnings](https://luals.github.io/wiki/diagnostics/)
- 🕵️ [Syntax checking](https://luals.github.io/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)
- 📚 Support for [libraries](https://luals.github.io/wiki/settings/#workspacelibrary)
- 💅 [Code formatting](https://luals.github.io/wiki/formatter/)
- 💬 [Spell checking](https://luals.github.io/wiki/diagnostics/#spell-check)
- 🛠️ Custom [plugins](https://luals.github.io/wiki/plugins/)
- 📖 [Documentation Generation](https://luals.github.io/wiki/export-docs/)

## 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
[![Install in VS Code](https://img.shields.io/badge/VS%20Code-Install-blue?style=for-the-badge&logo=visualstudiocode "Install in VS 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
[![Install for NeoVim](https://img.shields.io/badge/NeoVim-Install-blue?style=for-the-badge&logo=neovim "Install for 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).
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/).

### Command Line
[![Install for command line](https://img.shields.io/badge/Command%20Line-Install-blue?style=for-the-badge&logo=windowsterminal "Install for command line")](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#command-line)
See [installation instructions on our website](https://luals.github.io/#install).

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/).
[![Install in VS Code](https://img.shields.io/badge/VS%20Code-Install-blue?style=for-the-badge&logo=visualstudiocode "Install in VS Code")](https://luals.github.io/#vscode-install)
[![Install for NeoVim](https://img.shields.io/badge/NeoVim-Install-blue?style=for-the-badge&logo=neovim "Install for NeoVim")](https://luals.github.io/#neovim-install)
[![Other](https://img.shields.io/badge/Other-Install-blue?style=for-the-badge&logo=windowsterminal "Install for command line")](https://luals.github.io/#other-install)

### Community Install Methods
The install methods below are maintained by community members.
Expand All @@ -55,8 +46,8 @@ The install methods below are maintained by community members.

## 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)
- [Wiki](https://luals.github.io/wiki)
- [FAQ](https://luals.github.io/wiki/faq)
- [Report an issue][issues]
- [Suggest a feature][issues]
- [Discuss](https://github.com/LuaLS/lua-language-server/discussions)
Expand All @@ -79,13 +70,13 @@ The install methods below are maintained by community members.
> **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!
Are you able to [provide a translation](https://luals.github.io/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.
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://luals.github.io/privacy#language-server) to learn more. Telemetry was removed in `v3.6.5` and is no longer part of the language server.


## Contributors
Expand Down
8 changes: 4 additions & 4 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.

## 2.6.7
`2022-3-9`
* `NEW` offline diagnostic, [read more](https://github.com/LuaLS/lua-language-server/wiki/Offline-Diagnostic)
* `NEW` diagnosis report, [read more](https://luals.github.io/wiki/diagnosis-report/)
* `CHG` `VSCode`: 1.65 has built in new `Lua` syntax files, so this extension no longer provides syntax files, which means you can install other syntax extensions in the marketplace. If you have any suggestions or issues, please [open issues here](https://github.com/LuaLS/lua.tmbundle).
* `CHG` telemetry: the prompt will only appear in VSCode to avoid repeated prompts in other platforms due to the inability to automatically modify the settings.
* `FIX` [#965](https://github.com/LuaLS/lua-language-server/issues/965)
Expand Down Expand Up @@ -930,7 +930,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.

## 2.6.0
`2022-1-13`
* `NEW` supports multi-workspace in server side, for developers of language clients, please [read here](https://github.com/LuaLS/lua-language-server/wiki/Multi-workspace-supports) to learn more.
* `NEW` supports multi-workspace in server side, for developers of language clients, please [read here](https://luals.github.io/wiki/developing/#multiple-workspace-support) to learn more.
* `NEW` setting:
+ `Lua.hint.arrayIndex`
+ `Lua.semantic.enable`
Expand Down Expand Up @@ -1297,7 +1297,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.

## 2.1.0
`2021-7-2`
* `NEW` supports local config file, using `--configpath="config.json"`, [learn more here](https://github.com/LuaLS/lua-language-server/wiki/Setting-without-VSCode)
* `NEW` supports local config file, using `--configpath="config.json"`, [learn more here](https://luals.github.io/wiki/usage/#--configpath)
* `NEW` goto `type definition`
* `NEW` infer type by callback param:
```lua
Expand Down Expand Up @@ -1452,7 +1452,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.

## 1.20.0
`2021-3-27`
* `CHG` telemetry: change to opt-in, see [#462](https://github.com/LuaLS/lua-language-server/issues/462) and [Privacy-Policy](https://github.com/LuaLS/lua-language-server/wiki/Privacy-Policy)
* `CHG` telemetry: change to opt-in, see [#462](https://github.com/LuaLS/lua-language-server/issues/462) and [Privacy-Policy](https://luals.github.io/privacy/#language-server)
* `FIX` [#467](https://github.com/LuaLS/lua-language-server/issues/467)

## 1.19.1
Expand Down
4 changes: 2 additions & 2 deletions doc/en-us/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -1853,7 +1853,7 @@ false

# runtime.plugin

Plugin path. Please read [wiki](https://github.com/LuaLS/lua-language-server/wiki/Plugins) to learn more.
Plugin path. Please read the [wiki](https://luals.github.io/wiki/plugins) to learn more.

## type

Expand Down Expand Up @@ -2291,4 +2291,4 @@ Array<string>

```jsonc
[]
```
```
8 changes: 4 additions & 4 deletions doc/pt-br/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ object<string, string>
```jsonc
{
/*
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
*/
"ambiguity-1": "Any",
/*
Expand Down Expand Up @@ -1007,7 +1007,7 @@ object<string, string>
```jsonc
{
/*
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
*/
"ambiguity-1": "Warning",
/*
Expand Down Expand Up @@ -1853,7 +1853,7 @@ false

# runtime.plugin

Plugin path. Please read [wiki](https://github.com/LuaLS/lua-language-server/wiki/Plugins) to learn more.
Plugin path. Please read the [wiki](https://luals.github.io/wiki/plugins) to learn more.

## type

Expand Down Expand Up @@ -2291,4 +2291,4 @@ Array<string>

```jsonc
[]
```
```
10 changes: 5 additions & 5 deletions doc/zh-cn/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ object<string, string>
```jsonc
{
/*
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
*/
"ambiguity-1": "Any",
/*
Expand Down Expand Up @@ -1006,7 +1006,7 @@ object<string, string>
```jsonc
{
/*
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
优先级歧义,如:`num or 0 + 1`,推测用户的实际期望为 `(num or 0) + 1`
*/
"ambiguity-1": "Warning",
/*
Expand Down Expand Up @@ -1659,7 +1659,7 @@ string

# misc.parameters

VSCode中启动语言服务时的[命令行参数](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#arguments)。
VSCode中启动语言服务时的[命令行参数](https://luals.github.io/wiki/usage/#arguments)。

## type

Expand Down Expand Up @@ -1852,7 +1852,7 @@ false

# runtime.plugin

插件路径,请查阅[文档](https://github.com/LuaLS/lua-language-server/wiki/Plugins)了解用法。
插件路径,请查阅[文档](https://luals.github.io/wiki/plugins)了解用法。

## type

Expand Down Expand Up @@ -2290,4 +2290,4 @@ Array<string>

```jsonc
[]
```
```
6 changes: 3 additions & 3 deletions doc/zh-tw/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -1659,7 +1659,7 @@ string

# misc.parameters

VSCode中啟動語言伺服時的[命令列參數](https://github.com/LuaLS/lua-language-server/wiki/Getting-Started#arguments)。
VSCode中啟動語言伺服時的[命令列參數](https://luals.github.io/wiki/usage#arguments)。

## type

Expand Down Expand Up @@ -1852,7 +1852,7 @@ false

# runtime.plugin

延伸模組路徑,請查閱[文件](https://github.com/LuaLS/lua-language-server/wiki/Plugins)瞭解用法。
延伸模組路徑,請查閱[文件](https://luals.github.io/wiki/plugins)瞭解用法。

## type

Expand Down Expand Up @@ -2290,4 +2290,4 @@ Array<string>

```jsonc
[]
```
```
Loading