How to install and use?

[sunbearc22]

I just came across your project and am attempting to use it.

I installed it using this command: luarocks install --local wezterm-types as I don't use folke/lazy.nvim to manage my nvim plugins but uses pack.

However NVIM diagnostics don't seem to recognize the wezterm-type as shown below:

[DrKJeff16]

If you're not using lazydev.nvim I think you'd have to include the installation path in your LSP configuration, concretely in your workspace.library setting.

A crude example:

return {
  cmd = { 'lua-language-server' },
  filetypes = { 'lua' },
  settings = {
    Lua = {
      completion = { callSnippet = 'Replace', keywordSnippet = 'Replace' },
      workspace = {
        library = {
          vim.fn.expand('~/.luarocks/share/lua/5.1'), -- REPLACE WITH YOUR LUAROCKS PATH OR PLUGIN INSTALL DIRECTORY
        },
      },
    },
  },
}

[sunbearc22]

@DrKJeff16 Yes it worked. How do I resolve this new warning that I am seeing?

When my code uses your type hint library while other users of my code do not use your type hint library, would this mean they won't be able to use my code since the declared type hints are unknown to their editor?

[DrKJeff16]

How do I resolve this new warning that I am seeing?

@sunbearc22 I think I fixed this in my latest commit. If you're using LuaRocks then give me a sec while I make another release so I can push it to LuaRocks. Won't take me more than a couple mins.

---

When my code uses your type hint library while other users of my code do not use your type hint library, would this mean they won't be able to use my code since the declared type hints are unknown to their editor?

They would be able to use your code just fine, just that their LSP might throw warnings because the data types are not known to the LSP Client.

However, there are two cases:

A. Your Code is Imported as a WezTerm Plugin

wezterm.plugin.require('<your-plugin>')

If you are writing a WezTerm plugin then annotations will not be detected by a user's LSP (to my knowledge). I can annotate your WezTerm plugin here so that your types are able to be imported from here.

B. Your Code is Imported Directly

require('your.plugin')

If a user imports your code through Lua's require() builtin, and they don't have this plugin installed, they will indeed get warnings from their LSP client.

A solution might be to replicate the types defined here that you use in your own code, but I'd imagine it wouldn't be a comfortable task...

---

For both cases stated previously I highly encourage you recommended this plugin to your users. Maybe even set it as a soft dependency, your choice...

[DrKJeff16]

@sunbearc22 Okay, you can update wezterm-types in LuaRocks. Please notify me if the warning persists.

[sunbearc22]

$ luarocks remove --local wezterm-types
Checking stability of dependencies in the absence of
wezterm-types 1.4.0-1...

Removing wezterm-types 1.4.0-1...
Removal successful.

$ luarocks install --local wezterm-types
Installing https://luarocks.org/wezterm-types-2.5.1-1.src.rock


wezterm-types 2.5.1-1 depends on lua >= 5.1 (5.1-1 provided by VM: success)
wezterm-types 2.5.1-1 is now installed in /home/user1/.luarocks (license: MIT)

The warning disappeared. Also notice it is now showing as WezTerm not Wezterm. Thanks.

May I know what type hints represent these objects: wezterm.GLOBAL table, MuxWindow, Window, MuxTab/, Pane, PaneInformation?

[DrKJeff16]

• wezterm.GLOBAL
• MuxWindow
• Window
• MuxTab
• Pane
• PaneInformation

[dorukozerr]

I wanted to post again to this discussion because it might be useful.

@lalvarezt I'm really sorry that I submitted to wrong place earlier initially. But I think you misunderstood me, I did not wanted show alternative. When I move type definitions to annotations folder they fully worked with my setup, I thought that might be a good idea to include it to setup guide. I changed it to symlink to get updates, kinda polluted the other post sorry again.

Sharing here again

git clone [email protected]:DrKJeff16/wezterm-types.git ~/.sandbox/wezterm-types
# or
luarocks install --local wezterm-types 
# then you can create symlink
ln -s ~/.sandbox/wezterm-types/lua/wezterm/types/ ~/.config/wezterm/annotations
# or
ln -s ~/.luarocks/share/lua/5.5/wezterm/types/ ~/.config/wezterm/annotations

I tested both usage and they work. I just couldn't make it work with Lua.workspace.library configuration + luarocks install probably I'm missing something or its because of my setup.

[lalvarezt]

It's not a big deal 😅. I was just suggesting you moved it to a different place

Edit: let me have a look later and get back to you

[dorukozerr]

I found the problem,

• My config file did not get loaded because it was not in workspace roots pattern. Yesterday I worked with some other Lua config module and I thought project scoped LSP config file was correct but it was working only because annotations folder. It was this setup I did follow.

{
  "Lua.workspace.library": ["~/.sandbox/wezterm-types"]
}

When I put this in my root LSP config file or project based one it works without a problem. Also because there was no .git folder in my wezterm config folder it was not treated as valid workspace root pattern too. Problem was on my end :)