vim.g rename

[drowning-cat]

Does emmylua support renaming vim.g variables in Neovim like lua-language-server does?

vim.g.var = 1 -- rename to `vim.g.var_1`
vim.g.var = 1

Installed via Mason, version 0.25.1, with no .emmyrc.json yet. I also tried the configuration from justinmk:config/nvim/init.lua.

[CppCXY]

Our rename is based on references and definitions. If we can't find a definition, we give up the rename—this is the safe approach. We won't be too aggressive here.

[drowning-cat]

Do you know of an appropriate approach for this? Renaming global variables is a very important feature for me, since they are scattered across multiple files.

As I understand from your response, we can explicitly define types for vim.g variables like this:

-- vim.g is a random name
---@class vim.g
---@field [string] any
---@field var integer
vim.g = vim.g

But with this approach, we lose autocomplete for the vim.g variables defined in VIMRUNTIME, such as vim.g.colors_name. Also, the types are separate from the actual variables.

Config

vim.lsp.config("emmylua_ls", {
  cmd = { "emmylua_ls" },
  filetypes = { "lua" },
  root_markers = { { ".emmyrc.json", ".luarc.json" }, ".git" },
  --- TODO: missing @type lspconfig.settings.emmylua_ls
  settings = {
    emmylua = {
      runtime = {
        version = "LuaJIT",
      },
      workspace = {
        library = {
          vim.env.VIMRUNTIME,
          -- For LSP Settings Type Annotations: https://github.com/neovim/nvim-lspconfig#lsp-settings-type-annotations
          vim.api.nvim_get_runtime_file("lua/lspconfig", false)[1],
        },
      },
      diagnostics = {
        globals = { "vim" },
      },
    },
  },
})
vim.lsp.enable("emmylua_ls")

P.S. Thank you for the response! I hope it will be helpful to folks like me.