Dev setup for init.lua and plugin development with full signature help, docs and completion for the nvim lua API.
- EmmyLua library for the nvim lua API for:
- completion
- hover docs
- function signatures
- properly configures the
require
path withlua/?.lua
andlua/?/init.lua
. - adds all plugins in
opt
andstart
to the workspace so you get completion for all installed plugins - properly configure the vim runtime
- Neovim >= 0.5.0
- completion plugin like nvim-compe or completion-nvim
Install the plugin with your preferred package manager:
use "folke/lua-dev.nvim"
Plug 'folke/lua-dev.nvim'
lua-dev comes with the following defaults:
{
library = {
vimruntime = true, -- runtime path
types = true, -- full signature, docs and completion of vim.api, vim.treesitter, vim.lsp and others
plugins = true, -- installed opt or start plugins in packpath
-- you can also specify the list of plugins to make available as a workspace library
-- plugins = { "nvim-treesitter", "plenary.nvim", "telescope.nvim" },
},
runtime_path = false, -- enable this to get completion in require strings. Slow!
-- pass any additional options that will be merged in the final lsp config
lspconfig = {
-- cmd = {"lua-language-server"},
-- on_attach = ...
},
}
Be aware that this will configure Sumneko to work for Neovim init.lua and plugin development. This setup is NOT intended to be used for any other types of projects.
local luadev = require("lua-dev").setup({
-- add any options here, or leave empty to use the default settings
-- lspconfig = {
-- cmd = {"lua-language-server"}
-- },
})
local lspconfig = require('lspconfig')
lspconfig.sumneko_lua.setup(luadev)
Neovim includes a script to generated the nvim docs. That script also creates message pack files containing all the API metadata in a structured way. Unfortunately these files are not packaged in the releases.
Using the message pack files, I converted all the API data to EmmyLua annotations and make them available for the Sumneko LSP as a workspace library.
-
vim.fn
functions are currently not part of the EmmyLua library since no message pack files are generated. Implemented using vim-lsp - function return types are always
any
, since that information is missing
- docs for options and functions are based on the work of vim-lsp