feat: add .luarc.json

[lewis6991]

Update and promote contrib/luarc.json to .luarc.json.

• Nvim's LSP settings are now maintained.
• This will make diagnostics consistent across users.
• Will be required for CI: replace luacheck with luals (for headless/automated linting) #24563

---

Adapting LSP configuration

Use something like the following so RTP isn't added to projects with a .luarc.json.

Via nvim-lspconfig

local nvim_lsp = require('lspconfig')

nvim_lsp.lua_ls.setup {
  on_init = function(client)
    local path = client.workspace_folders[1].name
    if not vim.uv.fs_stat(path..'/.luarc.json') then
      -- Make the server aware of Neovim runtime files
      client.config.settings.Lua.workspace.library = { vim.env.VIMRUNTIME }
      -- or for everything:
      -- client.config.settings.Lua.workspace.library = vim.api.nvim_get_runtime_file("", true)
      client.notify("workspace/didChangeConfiguration", {
        settings = client.config.settings
      })
    end
  end
}

Manually

local function find_root(path, markers)
  local match = vim.fs.find(markers, { path = path, upward = true })[1]
  if not match then
    return
  end
  local stat = vim.loop.fs_stat(match)
  local isdir = stat and stat.type == "directory"
  return vim.fn.fnamemodify(match, isdir and ':p:h:h' or ':p:h')
end

vim.api.nvim_create_autocmd('FileType', {
  pattern = 'lua',
  group = vim.api.nvim_create_autocmd('luals', {}),
  callback = function(args)
    vim.lsp.start({
      name = 'luals',
      filetype = 'lua',
      cmd = { 'lua-language-server' },
      root_dir = find_root(args.file, {'.luarc.json', '.git'}),
      on_init = function(client)
        local path = client.workspace_folders[1].name
        if not vim.uv.fs_stat(path..'/.luarc.json') then
          -- Make the server aware of Neovim runtime files
          client.config.settings.Lua.workspace.library = { vim.env.VIMRUNTIME }
          -- or for everything:
          -- client.config.settings.Lua.workspace.library = vim.api.nvim_get_runtime_file("", true)
          client.notify("workspace/didChangeConfiguration", {
            settings = client.config.settings
          })
        end
      end,
    })
  end,
})

[gpanders]

I'm not opposed to this, my only thought is that if I want to modify .luarc.json to add e.g. neodev.nvim to the library paths, is there a way to do that without my worktree constantly being dirty?

[lewis6991]

There's no need for neodev anymore.

Or is there?

I've added meta files for everything now. Anything that's missing should be added as PR's here (via options.lua or eval.lua) instead of relying on third party code.

[gpanders]

There's no need for neodev anymore.

Or is there?

I've added meta files for everything now. Anything that's missing should be added as PR's here (via options.lua or eval.lua) instead of relying on third party code.

Good point, you're probably right.

[MariaSolOs]

There's no need for neodev anymore.

@lewis6991 Could you please elaborate on this? I actually struggled recently with duplicate results when using neodev, but when disabling I was unsure of how exactly to configure lua_ls in order to get vim's API support. Should these default settings from nvim-lspconfig be enough?

[clason]

I too would like to know how this should be used in combination with the default config for, say, working on plugins or init.lua. Right know, luals loads everything multiple times...

[lewis6991]

Neodev is half broken right now because it includes $VIMRUNTIME and all its generated types. So you will get duplicate types using it.

neodev should be disabled when working on the Neovim codebase. The neodev README explains how to do this.

Neodev also isn't really needed when working on plugins. You just need a .luarc.json with $VIMRUNTIME included in library.

For the most part neodev isn't really necessary anymore.

[clason]

I'm not using neodev, though; just manual config.

[MariaSolOs]

@lewis6991 by disabling neodev in this codebase you mean using neoconf? I didn’t find anything else mentioning that in the README, but I might have missed it.

So I’m now confused about whether I need neodev at all, but I’m still unsure of what modifications I need to do to my lua_ls config :/

[lewis6991]

Don't include:

    workspace = {
        -- Make the server aware of Neovim runtime files
        library = vim.api.nvim_get_runtime_file("", true),
      }

When attaching to core.

[clason]

Snippet?

[MariaSolOs]

Don't include:

    workspace = {
        -- Make the server aware of Neovim runtime files
        library = vim.api.nvim_get_runtime_file("", true),
      }

When attaching to core.

Pardon my ignorance, but wdym by attaching to core?

[lewis6991]

Pardon my ignorance, but wdym by attaching to core?

This repository.

[lewis6991]

Snippet?

Maybe look at my config. https://github.com/lewis6991/dotfiles/blob/main/config/nvim/lua/lewis6991/lsp.lua

Basically, just don't set library.

In fact all my settings aren't required for nvim-core.

[clason]

Well, but if I need library when working on, say, nvim-treesitter? Or my own config?

[lewis6991]

Well, but if I need library when working on, say, nvim-treesitter?

Either add a .luarc.json to nvim-treesitter (like I do). Or dynamically setup library based on the root directory. Or don't set library when root marker is nvim core.

Setting VIMRUNTIME for nvim core is incorrect anyway since it points to a different VIMRUNTIME.

[clason]

So you just made many people's lives more complicated. Color me unimpressed.

[MariaSolOs]

Pardon my ignorance, but wdym by attaching to core?

This repository.

Does this mean that I need to build neovim from source? I’m confused lol. As someone that just wants to get completions for vim APIs when tweaking my .config/nvim files, it sounds like I can just ditch neodev, make no further changes to my LSP configuration, and it should just work?

Sorry I’m slow. I’m not very smart at 1am.

Anyway I think we should probably talk to Folke when he’s back from vacation because it would be a good idea to make these clarifications in neodev.

[clason]

As someone that just wants to get completions for vim APIs when tweaking my .config/nvim files

In this case, this PR is completely irrelevant, and nothing has changed for you. (The file is only used when editing files in a cloned neovim repo.)

[MariaSolOs]

As someone that just wants to get completions for vim APIs when tweaking my .config/nvim files

In this case, this PR is completely irrelevant, and nothing has changed for you. (The file is only used when editing files in a cloned neovim repo.)

Oh lol 😂 well sorry then for the spam

[lewis6991]

Added some Lua snippets for LSP configuration to the description.

[lewis6991]

Raised: neovim/nvim-lspconfig#2750

[towry]

@MariaSolOs Seems neodev plugin is not needed.

1. I have created a .luarc.json file in my neovim config folder with following content:

{
  "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
  "workspace": {
    "library": [
      "/usr/local/share/nvim/runtime/lua",
      "/Users/towry/.local/share/nvim/lazy/nvim-cmp/lua"
    ]
  }
}

2. Update neovim to the latest nightly build.
3. Update nvim-lspconfig plugin.
4. Remove neodev plugin and setup.

Here are the effects:

---

• https://github.com/LuaLS/lua-language-server/wiki/Libraries#configuration-file

[lewis6991]

You can replace /usr/local/share/nvim/runtime/lua with $VIMRUNTIME and the other line can maybe use $XDG_DATA_HOME.

[MariaSolOs]

@towry @lewis6991 thanks a lot for the clarifications and helpful snippets <3

In this case, this PR is completely irrelevant, and nothing has changed for you. (The file is only used when editing files in a cloned neovim repo.)

Also FWIW I do have a neovim clone and I do want to become an active contributor, so this is still relevant to me :)

[MariaSolOs]

@lewis6991 why does your snippet for on_init return true? From what I can see here, the return value is ignored on success.

Sorry if it's a silly question, just making sure I'm not missing something.

[lewis6991]

I think you are right.

I used https://github.com/neovim/nvim-lspconfig/wiki/Project-local-settings as a template, but that must be outdated.

[neovim-discourse]

This pull request has been mentioned on Neovim Discourse. There might be relevant details there:

https://neovim.discourse.group/t/how-to-configure-lsp-for-editing-init-lua-to-aid-in-setting-up-neovim/4269/1