aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfigsoda <figsoda@pm.me>2023-02-11 21:30:20 -0500
committerGitHub <noreply@github.com>2023-02-12 10:30:20 +0800
commit6669f2d8ebc38cfb9e639145569f94be5556d916 (patch)
tree934155be3fa1d7d69fa1c3331dbd729d4ddd3fae
parentdocs: update server_configurations.md (diff)
downloadnvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar.gz
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar.bz2
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar.lz
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar.xz
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.tar.zst
nvim-lspconfig-6669f2d8ebc38cfb9e639145569f94be5556d916.zip
feat: rename sumneko_lua -> lua_ls (#2439)
* feat: rename sumneko_lua -> lua_language_server * refactor(sumneko_lua): use vim.deprecate * refactor: handle deprecated server aliases in one place * refactor: put server aliases in a function * feat: rename lua_language_server -> lua_ls
-rw-r--r--lua/lspconfig.lua22
-rw-r--r--lua/lspconfig/server_configurations/lua_ls.lua (renamed from lua/lspconfig/server_configurations/sumneko_lua.lua)12
-rw-r--r--test/lspconfig_spec.lua2
-rw-r--r--test/minimal_init.lua2
4 files changed, 30 insertions, 8 deletions
diff --git a/lua/lspconfig.lua b/lua/lspconfig.lua
index cf6ac633..c6e3b2d1 100644
--- a/lua/lspconfig.lua
+++ b/lua/lspconfig.lua
@@ -9,9 +9,31 @@ function M.available_servers()
return M.util.available_servers()
end
+---@class Alias
+---@field to string The new name of the server
+---@field version string The version that the alias will be removed in
+---@param name string
+---@return Alias
+local function server_alias(name)
+ local aliases = {
+ sumneko_lua = {
+ to = 'lua_ls',
+ version = '0.2.0',
+ },
+ }
+
+ return aliases[name]
+end
+
local mt = {}
function mt:__index(k)
if configs[k] == nil then
+ local alias = server_alias(k)
+ if alias then
+ vim.deprecate(k, alias.to, alias.version, 'lspconfig')
+ k = alias.to
+ end
+
local success, config = pcall(require, 'lspconfig.server_configurations.' .. k)
if success then
configs[k] = config
diff --git a/lua/lspconfig/server_configurations/sumneko_lua.lua b/lua/lspconfig/server_configurations/lua_ls.lua
index 0f89bbd6..7ab54cf8 100644
--- a/lua/lspconfig/server_configurations/sumneko_lua.lua
+++ b/lua/lspconfig/server_configurations/lua_ls.lua
@@ -38,11 +38,11 @@ return {
},
docs = {
description = [[
-https://github.com/sumneko/lua-language-server
+https://github.com/luals/lua-language-server
Lua language server.
-`lua-language-server` can be installed by following the instructions [here](https://github.com/sumneko/lua-language-server/wiki/Getting-Started#command-line).
+`lua-language-server` can be installed by following the instructions [here](https://github.com/luals/lua-language-server/wiki/Getting-Started#command-line).
The default `cmd` assumes that the `lua-language-server` binary can be found in `$PATH`.
@@ -55,7 +55,7 @@ initial requests (completion, location) upon starting as well as time to first d
Completion results will include a workspace indexing progress message until the server has finished indexing.
```lua
-require'lspconfig'.sumneko_lua.setup {
+require'lspconfig'.lua_ls.setup {
settings = {
Lua = {
runtime = {
@@ -79,9 +79,9 @@ require'lspconfig'.sumneko_lua.setup {
}
```
-See `lua-language-server`'s [documentation](https://github.com/sumneko/lua-language-server/blob/master/locale/en-us/setting.lua) for an explanation of the above fields:
-* [Lua.runtime.path](https://github.com/sumneko/lua-language-server/blob/076dd3e5c4e03f9cef0c5757dfa09a010c0ec6bf/locale/en-us/setting.lua#L5-L13)
-* [Lua.workspace.library](https://github.com/sumneko/lua-language-server/blob/076dd3e5c4e03f9cef0c5757dfa09a010c0ec6bf/locale/en-us/setting.lua#L77-L78)
+See `lua-language-server`'s [documentation](https://github.com/luals/lua-language-server/blob/master/locale/en-us/setting.lua) for an explanation of the above fields:
+* [Lua.runtime.path](https://github.com/luals/lua-language-server/blob/076dd3e5c4e03f9cef0c5757dfa09a010c0ec6bf/locale/en-us/setting.lua#L5-L13)
+* [Lua.workspace.library](https://github.com/luals/lua-language-server/blob/076dd3e5c4e03f9cef0c5757dfa09a010c0ec6bf/locale/en-us/setting.lua#L77-L78)
]],
default_config = {
diff --git a/test/lspconfig_spec.lua b/test/lspconfig_spec.lua
index b899c09d..1df3464a 100644
--- a/test/lspconfig_spec.lua
+++ b/test/lspconfig_spec.lua
@@ -332,7 +332,7 @@ describe('lspconfig', function()
exec_lua [[
local lspconfig = require("lspconfig")
local actual = nil
- local _ = lspconfig.sumneko_lua
+ local _ = lspconfig.lua_ls
local _ = lspconfig.tsserver
lspconfig.rust_analyzer.setup {}
return require("lspconfig.util").available_servers()
diff --git a/test/minimal_init.lua b/test/minimal_init.lua
index 841cb67c..8b27728d 100644
--- a/test/minimal_init.lua
+++ b/test/minimal_init.lua
@@ -52,7 +52,7 @@ end
-- Add the server that troubles you here
local name = 'pyright'
-local cmd = { 'pyright-langserver', '--stdio' } -- needed for elixirls, omnisharp, sumneko_lua
+local cmd = { 'pyright-langserver', '--stdio' } -- needed for elixirls, lua_ls, omnisharp
if not name then
print 'You have not defined a server name, please edit minimal_init.lua'
end