From ed950e41c5ff7ee779d28cc3e33a9456e7d211ff Mon Sep 17 00:00:00 2001 From: carsakiller Date: Fri, 24 Mar 2023 23:32:58 -0400 Subject: [PATCH 1/5] refactor: move Lua version support to features --- README.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index c1262add8..da759ed29 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ The Lua language server provides various language features for Lua to make devel ## 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 - ↪ Go to definition - 🦺 Dynamic [type checking](https://github.com/LuaLS/lua-language-server/wiki/Type-Checking) @@ -43,14 +44,6 @@ The language server and Visual Studio Code client can be installed from [the VS 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 NeoVim and [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/). -## Supported Lua Versions -| Version | Supported | -| :-----: | :------------: | -| Lua 5.1 | ![✅][checkmark] | -| Lua 5.2 | ![✅][checkmark] | -| Lua 5.3 | ![✅][checkmark] | -| Lua 5.4 | ![✅][checkmark] | -| LuaJIT | ![✅][checkmark] | ## Links - [Changelog](https://github.com/LuaLS/lua-language-server/blob/master/changelog.md) @@ -116,6 +109,3 @@ Software that the language server (or the development of it) uses: * [json.lua](https://github.com/actboy168/json.lua) * [EmmyLuaCodeStyle](https://github.com/CppCXY/EmmyLuaCodeStyle) * [inspect.lua](https://github.com/kikito/inspect.lua) - - -[checkmark]: https://user-images.githubusercontent.com/61925890/183228083-d3aa4eca-30c7-4b9f-aaab-26ce3d8a14fb.png From c87720ed9d070362741cd9313e3f0e34b6060474 Mon Sep 17 00:00:00 2001 From: carsakiller Date: Fri, 24 Mar 2023 23:33:26 -0400 Subject: [PATCH 2/5] remove large gif --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index da759ed29..86f0ba1ce 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,6 @@ The language server can easily be installed for use in VS Code, but it can also The language server and Visual Studio Code client can be installed from [the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=sumneko.lua). -![](https://github.com/LuaLS/vscode-lua/raw/master/images//Install%20In%20VSCode.gif) - ### 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) From c4f9e9d8e787f308dbfe07705daa7b2f3e62b878 Mon Sep 17 00:00:00 2001 From: carsakiller Date: Fri, 24 Mar 2023 23:34:44 -0400 Subject: [PATCH 3/5] refactor: move configuration section to install --- README.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index 86f0ba1ce..ba4f9b411 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,7 @@ The Lua language server provides various language features for Lua to make devel - 📖 [Documentation Generation](https://github.com/LuaLS/lua-language-server/wiki/Export-Documentation) ## Install - -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. +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 the be configured using a [configuration file](https://github.com/LuaLS/lua-language-server/wiki/Configuration-File). ### 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) @@ -73,15 +72,6 @@ Are you able to [provide a translation](https://github.com/LuaLS/lua-language-se Thank you to [all contributors of translations](https://github.com/LuaLS/lua-language-server/commits/master/locale)! -## Configuration -Configuration of the server can be done in a number of ways, which are explained more in-depth in the [wiki](https://github.com/LuaLS/lua-language-server/wiki/Configuration-File). - -### Visual Studio Code -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). - -### Other -See the [configuration file wiki page](https://github.com/LuaLS/lua-language-server/wiki/Configuration-File). - ## 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. From 9b4c819c5d4f865ff36fdfb9d83d8b6d6a8ef0e9 Mon Sep 17 00:00:00 2001 From: carsakiller Date: Fri, 24 Mar 2023 23:41:54 -0400 Subject: [PATCH 4/5] add: NeoVim install guide --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ba4f9b411..29e26fbed 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,11 @@ The language server can be installed for use in Visual Studio Code, NeoVim, and 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://dev.to/vonheikemen/getting-started-with-neovims-native-lsp-client-in-the-year-of-2022-the-easy-way-bp3) + +You can read [Heiker's guide](https://dev.to/vonheikemen/getting-started-with-neovims-native-lsp-client-in-the-year-of-2022-the-easy-way-bp3) for getting set up from scratch. + ### 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) From 20282092af67ce3dabe59e2417c04d30fe0b7d44 Mon Sep 17 00:00:00 2001 From: carsakiller Date: Fri, 24 Mar 2023 23:42:20 -0400 Subject: [PATCH 5/5] add: community install methods --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29e26fbed..58bdc4e2a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ The Lua language server provides various language features for Lua to make devel - 📖 [Documentation Generation](https://github.com/LuaLS/lua-language-server/wiki/Export-Documentation) ## 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 the be configured using a [configuration file](https://github.com/LuaLS/lua-language-server/wiki/Configuration-File). +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) @@ -44,8 +44,12 @@ You can read [Heiker's guide](https://dev.to/vonheikemen/getting-started-with-ne ### 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) -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 NeoVim and [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/). +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/). +### Community Install Methods +The install methods below are maintained by community members. + +[asdf plugin](https://github.com/bellini666/asdf-lua-language-server) ## Links - [Changelog](https://github.com/LuaLS/lua-language-server/blob/master/changelog.md)