Question 1

How do I install wezterm-types in Neovim?

Accepted Answer

Install it via LuaRocks or a package manager like lazy.nvim, then configure lazydev.nvim or the built-in LSP to include the library path, as detailed in the README's Neovim section. This enables autocompletion in your WezTerm config files.

Question 2

Does wezterm-types work with VSCode on Windows?

Accepted Answer

Yes, but it requires cloning the repository into your WezTerm config directory (e.g., ~/.config/wezterm) and ensuring LuaLS is set up in VSCode. The process is less automated than for Neovim and may need manual adjustments for Windows paths.

Question 3

What's the difference between wezterm-types and the official WezTerm docs?

Accepted Answer

wezterm-types provides interactive type annotations for LuaLS, enabling real-time autocompletion and error checking in editors, while the official docs are static references. However, the README advises double-checking with the docs for any unclear types.

Question 4

wezterm-types or manual LuaLS annotations: which is better?

Accepted Answer

wezterm-types is superior for most users because it offers pre-built, community-vetted annotations for core WezTerm and many plugins, saving time. Manual annotations require deep Lua knowledge and are prone to errors, making this project the practical choice.

Question 5

How to add type support for a custom WezTerm plugin?

Accepted Answer

Request it via a GitHub issue in the wezterm-types repository, as the project relies on community contributions. Alternatively, you can fork the repo and add annotations yourself, but this requires understanding LuaCATS format and may not be merged quickly.

Question 6

Is wezterm-types necessary for basic WezTerm setup?

Accepted Answer

No, for simple configurations using default settings, you can rely on the official documentation without types. wezterm-types shines when customizing complex Lua configs or using multiple plugins, where autocompletion prevents errors.

wezterm-types

What is wezterm-types?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions