I believe the currently included ones are around 3 MB (source), so they account for about 10% of the total size of the language server. It is still a big improvement for organization and collaboration, though 🙂

There isn't much “porting” to do. The addons are nearly identical to the environment emulation libraries that have existed for a while.

Yeah, I'm thinking that if it'd be in a repo, there's no need to update your extension anymore, and they need to update the plugin instead.

Hello 👋

I plan to add to config.json so that addons can depend on each other. This should be completed before the libraries are removed. Currently, I am experimenting and trying to move the addon manager to the language server, so it can be cross-editor. Until these are completed, I recommend just adding to your description that another addon is required 🙂.

move the addon manager to the language server, so it can be cross-editor

as someone that does a lot of lua development and doe not vscode, I see this as a must have.

honestly, if a little bit of bloat means I get the same experience out of the language server on any platform and not have to dredge the documentation of 10 repos to figure out how to set all this up or have to maintain everyone's editor specific config - huge win.

at the day job we have several hundred libraries and dozens of developers all using different editors and local setups. As a rule we do not commit editor specific settings to repos and lean on agnostic configuration so everyone is on a level playing ground and not try to force people into using an editor.

I plan to add a ${addon} variable that points to the addon installation path... wherever that may be. The settings file not being distributable has always annoyed me.

I need it!

Hey @carsakiller, I wanted to check in and see support for an ${addon}-like variable was still in the works. This would be a huge help for simplifying the onboarding process for our team!

I looked around within the codebase to see where this change could be introduced but didn't come up with much. If you could point me in the right direction here, I'd be happy to add it in and open a PR.

Regardless, thanks for all of your hard work here!

@forestbelton, I had forgotten about this 😵‍💫. I took a poke around and appear to have come up with a potential solution.

An update. I've been trying still to make it work, and I think I've been able to. First, I narrowed it down to something that wasn't working, to see if I could fix it. I tried this:

-- approach 3. This does NOT work
-- * Adds userThirdParty directory, but doesn't refer to it in library.
-- (this is the snippet from https://github.com/LelouchHe/xmake-luals-addon/pull/1/files)
require('lspconfig').lua_ls.setup {
    settings = {
        Lua = {
            workspace = {
                userThirdParty = {
                   vim.fn.expand('~/personal/configs/lua-language-server-addons/')
                }
            }
        }
    }
}
-- approach 4. This does NOT work.... with busted, but works with xmake!!
-- * Adds userThirdParty directory, but doesn't refer to it in library.
-- * Adds checkThirdParty, which is in other working examples
require('lspconfig').lua_ls.setup {
    settings = {
        Lua = {
            workspace = {
                checkThirdParty = 'ApplyInMemory',
                userThirdParty = {
                   vim.fn.expand('~/personal/configs/lua-language-server-addons/')
                }
            }
        }
    }
}

The 3rd approach was not working for me, but I tried the 4th, and by chance I realized that it was working for an xmake.lua file, which was detecting fine the xmake specific global functions. But it was failing for a plain Lua project that used busted, so I dug up, and realized that the xmake addon/LuaCATS has a rule to enable itself on xmake.lua files, but the busted one has nothing... So I made a change, and with that, it works, at last.

It would be nice to know still about the ${addon} placeholder being "cross editor", because it doesn't seem so to me. In fact, the busted addon sets luassert in workspace.library using ${3rd}/luassert/library. If this goes away, I don't see how this addon will achieve this feature.

Thanks.

Lua.workspace.library is an array of paths to library files.

Lua.workspace.userThirdParty is an array of paths where addons can be found. If the addon has words or files that define when it should be activated, then the language server can do it automatically for you.

${3rd} refers to the libraries that are built into the Language server, that we plan to remove in the future.

And ${addons} is used by the addon manager, but the location will probably move somewhere cross-platform in the future.