feat(lua_ls): update recommended settings

[lewis6991]

See: neovim/neovim#24592

• Only override settings if there is no .luarc.json(c) file present.
• Prefer setting workspace to VIMRUNTIME over 'runtimepath'

[icp1994]

After applying changes from this patch, I get diagnostics warnings for "Undefined global vim" even though I have included that settings.

Previous setup:

lspconfig.lua_ls.setup({
	settings = {
		Lua = {
			runtime = {
				version = "LuaJIT",
			},
			diagnostics = {
				globals = { "vim" },
			},
			workspace = {
				library = vim.api.nvim_get_runtime_file("", true),
				checkThirdParty = false,
			},
		},
	},
})

Current setup

lspconfig.lua_ls.setup({
	on_attach = on_attach,
	capabilities = capabilities,
	on_init = function(client)
		local path = client.workspace_folders[1].name
		if not vim.loop.fs_stat(path .. "/.luarc.json") then
			client.config.settings = vim.tbl_deep_extend("force", client.config.settings.Lua, {
				runtime = {
					version = "LuaJIT",
				},
				diagnostics = {
					globals = { "vim" },
				},
				workspace = {
					library = { vim.env.VIMRUNTIME },
					checkThirdParty = false,
				},
			})
			client.notify("workspace/didChangeConfiguration", { settings = client.config.settings })
		end
	end,
})

NVIM v0.9.1

[lewis6991]

Are you sure you haven't got a misconfigured .luarc.json in your workspace?

[icp1994]

No, but also just found out #2755 :p