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
This commit is contained in:
figsoda 2023-02-11 21:30:20 -05:00 committed by GitHub
parent ee00aa22dc
commit 6669f2d8eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 8 deletions

View file

@ -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

View file

@ -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 = {

View file

@ -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()

View file

@ -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