LuaLS / LuaLS/lua-language-server

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

Open
#3,344 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### 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`:

```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 .
-- 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](https://github.com/user-attachments/files/24930088/service.log)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the provided ~/.config/nvim/init.lua and the `nvim ~/.config/nvim/init.lua` command. Read the LspAttach callback, compare lua_ls with the other listed LSPs, and inspect service.log for relevant timing or publication errors. Done means inlay hints, underlines, and signcolumns appear immediately without editing, scrolling, or restarting the LSP.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux, lua, neovim
Domain
devtools, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.