Skip to content

feat(dev.wezterm): add type annotations#102

Merged
DrKJeff16 merged 3 commits into
mainfrom
feat/dev-wezterm
Feb 17, 2026
Merged

feat(dev.wezterm): add type annotations#102
DrKJeff16 merged 3 commits into
mainfrom
feat/dev-wezterm

Conversation

@DrKJeff16
Copy link
Copy Markdown
Owner

@DrKJeff16 DrKJeff16 commented Feb 17, 2026

Source(s)


Description

I've added type annotations for @ChrisGVE's dev.wezterm.

Thank you @ChrisGVE for annotating your plugin!


Screenshots Or Code Snippets

To activate:

---@type Dev
local dev = wezterm.plugin.require("https://github.com/ChrisGVE/dev.wezterm")

This integration also adds the following events to wezterm.on():

  • "dev.wezterm-plugin-not-found"
  • "dev.wezterm.invalid_hashkey"
  • "dev.wezterm.invalid_opts"
  • "dev.wezterm.no_keywords"
  • "dev.wezterm.require_path_not_set"
---Either no `hashkey` or an invalid one provided.
---
---@param event "dev.wezterm.invalid_hashkey" This is for `dev.wezterm` only!
---@param callback function
function Wezterm.on(event, callback) end

---Invalid options provided to plugin setup.
---
---@param event "dev.wezterm.invalid_opts" This is for `dev.wezterm` only!
---@param callback function
function Wezterm.on(event, callback) end

---No keywords were provided for searching the plugin.
---
---@param event "dev.wezterm.no_keywords" This is for `dev.wezterm` only!
---@param callback function
function Wezterm.on(event, callback) end

---The plugin was not found and thus `package.path` could not be set.
---
---@param event "dev.wezterm.require_path_not_set" This is for `dev.wezterm` only!
---@param callback function
function Wezterm.on(event, callback) end

---The provided keywords did not allow for the plugin to be found.
---
---@param event "dev.wezterm-plugin-not-found" This is for `dev.wezterm` only!
---@param callback function
function Wezterm.on(event, callback) end

Signed-off-by: Guennadi Maximov C <[email protected]>
@DrKJeff16 DrKJeff16 self-assigned this Feb 17, 2026
@DrKJeff16 DrKJeff16 added documentation Improvements or additions to documentation enhancement New feature or request new-types A PR addresses new data types and/or fields labels Feb 17, 2026
@DrKJeff16 DrKJeff16 merged commit d3d32ec into main Feb 17, 2026
3 checks passed
@DrKJeff16 DrKJeff16 deleted the feat/dev-wezterm branch February 17, 2026 19:56
@DrKJeff16 DrKJeff16 added merged This PR has been merged successfully! labels Feb 18, 2026
@DrKJeff16 DrKJeff16 added the plugin This concerns annotations for a WezTerm plugin. label Feb 26, 2026
@ChrisGVE
Copy link
Copy Markdown

ChrisGVE commented Mar 6, 2026

Hello Jeff, Sorry, I've been quite busy... and couldn't check your three messages. Is there anything I should do besides thanking you in my readme?

@DrKJeff16
Copy link
Copy Markdown
Owner Author

Hello Jeff, Sorry, I've been quite busy... and couldn't check your three messages. Is there anything I should do besides thanking you in my readme?

I just want your users to have an easier time using your plugins through my annotations :)

@DrKJeff16 DrKJeff16 changed the title feat(dev-wezterm): add type annotations feat(dev.wezterm): add type annotations Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request merged This PR has been merged successfully! new-types A PR addresses new data types and/or fields plugin This concerns annotations for a WezTerm plugin.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants