LuaLS / LuaLS/lua-language-server

Inlay hints, underlines, and signcolumns don't appear in Neovim until scrolling or editing

未关闭
#3,344 4 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

How are you using the lua-language-server?

NeoVim

Which OS are you using?

Linux

What is the issue affecting?

Annotations

Expected Behaviour

Inlay hints, underlines, and signcolumns should immediately load. One workaround is to press o, Esc, then u upon startup.

inlay hints and signcolumn

Another workaround is to delay the inline hints, but that doesn't fix the underlines and signcolumns. Remove the and False in my init.lua or use https://github.com/MysticalDevil/inlay-hints.nvim/pull/15. :LspRestart is not a good solution as it causes glitches and errors.

The bug is only with lua_ls. Other LSPs like basedpyright, clangd, and ts_ls do not require workarounds and load immediately or shortly.

Actual Behaviour

Inlay hints are missing before scrolling:

missing inlay hints before scrolling

Even after scrolling, the signcolumn and the underlines are missing:

missing signcolumn after scrolling

Randomly and rarely, the bug doesn't occur.

Reproduction steps

Use this .config/nvim/init.lua:

-- ~/.config/nvim/init.lua
-- Tested with go1.25.6 and neovim=0.12.0~ubuntu1+git202601110811-d62bbe24cb-793e58f65d-e9f8804254~ubuntu25.10.1
-- If you want to reset Neovim before installing this, run: rm -rf ~/.cache/nvim ~/.local/share/nvim

-- Load lazy.nvim. Press q to dismiss the installer.
-- Also, don't edit a Lua file on the 1st launch or there'll be a treesitter error
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
	local lazyrepo = "https://github.com/folke/lazy.nvim.git"
	local out = vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
	if vim.v.shell_error ~= 0 then
		vim.api.nvim_echo({
			{ "Failed to clone lazy.nvim:\n", "ErrorMsg" },
			{ out,                            "WarningMsg" },
			{ "\nPress any key to exit..." },
		}, true, {})
		vim.fn.getchar()
		os.exit(1)
	end
end
vim.opt.rtp:prepend(lazypath)
vim.g.mapleader = " "
vim.g.maplocalleader = "\\"

-- "go to declaration" isn't supported by your Lua/Go LSP.
-- "go to definition"'s similar and works
vim.keymap.set('n', 'gd', vim.lsp.buf.definition)

require("lazy").setup({
	spec = {
		-- Fix lazy.nvim-caused treesitter error
		-- Tested with tree-sitter --version: tree-sitter 0.26.3
		{ "nvim-treesitter/nvim-treesitter", lazy = false, build = ":TSUpdate" },
		{
			"saghen/blink.cmp",
			dependencies = "rafamadriz/friendly-snippets",
			version = "1.*",
			opts = {
				completion = {
					ghost_text = { enabled = true }, -- Syntax autocompletion
				}
			},
		},
		{
			"mason-org/mason-lspconfig.nvim",
			opts = {
				ensure_installed = {
					"basedpyright", -- MysticalDevil/inlay-hints suggests this not pyright
					"clangd",
					"gopls",
					"lua_ls",
					-- "stylua" -- Not required when lua_ls is installed
					"ts_ls",
				},
			},
			dependencies = {
				{ "mason-org/mason.nvim", opts = {} },
				"neovim/nvim-lspconfig",
			},
			-- mason-lspconfig is enough for stylua; no need for mason-tool-installer
		},
		-- textDocument.inlayHint is missing and doesn't do anything
		-- I wanted to use this plugin but need the workaround below
		-- 		{
		-- 			"MysticalDevil/inlay-hints.nvim",
		-- 			event = "LspAttach",
		-- 			config = function()
		-- 				require("inlay-hints").setup()
		-- 			end,
		-- 		},
	},
	checker = { enabled = true },
})
require("nvim-treesitter").install({ "lua", "vimdoc" }):wait(300000) -- Fix errors

-- Workaround to reinvent MysticalDevil/inlay-hints.nvim for lua_ls.
-- If you want to use MysticalDevil/inlay-hints.nvim, then remove this section.
-- Without this section, if inlay hints don't appear at first, just randomly edit the file e.g. press <o> <ESC> <u>.
-- With or without this section, for Lua, there's a bug where the signcolumn only appears after editing.
vim.api.nvim_create_autocmd("LspAttach", {
	callback = function(args)
		local client = vim.lsp.get_client_by_id(args.data.client_id)
		if not client then
			return -- https://vi.stackexchange.com/a/46784/51656
		end
		function enable_inlay_hints()
			if vim.lsp.inlay_hint then
				vim.lsp.inlay_hint.enable(true, { 0 }) -- https://stackoverflow.com/a/77678959/10477326
			end
		end

		if client.name == "lua_ls" and False then -- Disabled workaround to showcase this bug to GitHub issues
			-- Workaround: Delay to ensure inlay hints work at the start of opened Lua files
			vim.defer_fn(enable_inlay_hints, 500)
		else
			enable_inlay_hints()
		end
	end,
})

-- require("lspconfig") is now vim.lsp.config
vim.lsp.config("lua_ls", {
	settings = {
		Lua = {
			completion = {
				callSnippet = "Replace",
			},
			misc = {
				parameters = { "--loglevel=trace" }
			}
		}
	}
})

-- Below is adapted from MysticalDevil/inlay-hints.nvim's README
-- I removed some default/outdated parameters
vim.lsp.config("gopls", {
	settings = {
		gopls = {
			usePlaceholders = true,
			hints = {
				rangeVariableTypes = true,
				parameterNames = true,
				constantValues = true,
				assignVariableTypes = true,
				compositeLiteralFields = true,
				compositeLiteralTypes = true,
				functionTypeParameters = true,
			},
		},
	},
})

vim.lsp.config("tsserver", {
	settings = {
		typescript = {
			inlayHints = {
				includeInlayParameterNameHints = "all",
				includeInlayFunctionParameterTypeHints = true,
				includeInlayVariableTypeHints = true,
				includeInlayPropertyDeclarationTypeHints = true,
				includeInlayFunctionLikeReturnTypeHints = true,
				includeInlayEnumMemberValueHints = true,
			},
		},
		javascript = {
			inlayHints = {
				includeInlayParameterNameHints = "all",
				includeInlayFunctionParameterTypeHints = true,
				includeInlayVariableTypeHints = true,
				includeInlayPropertyDeclarationTypeHints = true,
				includeInlayFunctionLikeReturnTypeHints = true,
				includeInlayEnumMemberValueHints = true,
			},
		},
	},
})

Then open the same file to edit in the Neovim editor by executing nvim ~/.config/nvim/init.lua.

Additional Notes

No response

Log File

service.log

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,使用提供的 ~/.config/nvim/init.lua 和 nvim ~/.config/nvim/init.lua 命令复现问题。阅读 LspAttach 回调,将 lua_ls 与列出的其他 LSPs 进行比较,并检查 service.log 中是否存在相关的时序或发布错误。当无需编辑、滚动或重启 LSP,inlay hints、下划线和 signcolumns 就能立即显示时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
linux, lua, neovim
领域
devtools, tooling
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。