Skip to content

Settings from client and .luarc.json not getting merged #2483

Open
Open
Settings from client and .luarc.json not getting merged#2483

Description

@HiPhish
HiPhish
opened on Jan 16, 2024

How are you using the lua-language-server?

NeoVim

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Global settings from the client and local settings from the .luarc.json file should get merged. In my case I have the following .luarc.json:

{
	"$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
  	"workspace.ignoreDir": ["test/xdg"]
}

There is no workspace.ignoreDir setting in my client config.

Actual Behaviour

The settings from .luarc.json are not applied. I have to add the ignoreDir setting to my client configuration for it to do something.

Reproduction steps

N/A

Additional Notes

I am testing a Neovim plugin (HiPhish/rainbow-delimiters.nvim), and the test setup requires me to place a symlink to the plugin root directory inside on of its sub-directories (rainbow-delimiters). When the language server starts scanning the plugin directory it ends up running in circles. Adding this directory to the ingoreDir list stops the infinite loop and the language server can scan all files normally.

I cannot place all my settings inside the local .luarc.json because the settings for Neovim configuration and plugin development cannot be known ahead of time, they must be generated. I can place the workspace.ignoreDir setting in my own client configuration, but this won't help people who want to contribute to my plugin.

What I need is for the language server to merge both configurations into one. The order should be from least to most significant:

  1. client configuration
  2. local configuration
  3. custom configuration file (maybe?)

Log File

file_home_hiphish_.local_share_nvim_site_pack_my-plugins_start_rainbow-delimiters.nvim.log

service.log

Activity

  1. EPadronU commented on Sep 5, 2026

    @EPadronU
    EPadronU
    on Sep 5, 2026

    In case it may help anyone:

    ---@param client vim.lsp.Client
local function load_local_settings(client)
  local root_dir = client.root_dir

  if not root_dir then
    return
  end

  local luarc_path = root_dir .. "/.luarc.json"

  -- Bail out silently if the file does not exist
  if not vim.uv.fs_stat(luarc_path) then
    return
  end

  -- Read and decode the JSON settings file
  local ok, settings = pcall(function()
    return vim.fn.json_decode(vim.fn.readfile(luarc_path))
  end)

  if not ok or type(settings) ~= "table" then
    vim.notify("[lua_ls] Failed to parse .luarc.json", vim.log.levels.WARN)
    return
  end

  -- Merge into the client's active settings and notify the server
  client.settings = vim.tbl_deep_extend("force", client.settings or {}, settings)

  client:notify("workspace/didChangeConfiguration", { settings = client.settings })
end

vim.lsp.config("lua_ls", {
  on_init = load_local_settings,
})

vim.lsp.enable("lua_ls")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions