Skip to content

Commit c35abfd

Browse files
committed
feat(sync-panes.wez): add type annotations
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
1 parent 53b53c1 commit c35abfd

5 files changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ This project also features type annotations for various WezTerm plugins.
9696
| [smart-splits.nvim](https://github.com/mrjones2014/smart-splits.nvim) | [Documentation](docs/smart-splits.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.smart-splits.txt) |
9797
| [smart_workspace_switcher.wezterm](https://github.com/MLFlexer/smart_workspace_switcher.wezterm) | [Documentation](docs/smart-workspace-switcher.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.smart_workspace_switcher.txt) |
9898
| [stack.wez](https://github.com/bad-noodles/stack.wez) | [Documentation](docs/stack.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.stack.txt) |
99+
| [sync-panes.wez](https://github.com/annie444/sync-panes.wez) | [Documentation](docs/sync-panes.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.sync-panes.txt) |
99100
| [tabline.wez](https://github.com/michaelbrusegard/tabline.wez) | [Documentation](docs/tabline.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.tabline.txt) |
100101
| [tabsets.wezterm](https://github.com/srackham/tabsets.wezterm) | [Documentation](docs/tabsets.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.tabsets.txt) |
101102
| [toggle_terminal.wez](https://github.com/zsh-sage/toggle_terminal.wez) | [Documentation](docs/toggle-terminal.md) | [Neovim Helpdoc](doc/wezterm-types-plugin.toggle-terminal.txt) |

doc/wezterm-types-plugin.sync-panes.txt

Whitespace-only changes.

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ We will keep adding more community plugins as we find them.
3232
- [smart-splits.nvim](./smart-splits.md)
3333
- [smart_workspace_switcher.wezterm](./smart-workspace-switcher.md)
3434
- [stack.wez](./stack.md)
35+
- [sync-panes.wez](./sync-panes.md)
3536
- [tabline.wez](./tabline.md)
3637
- [tabsets.wezterm](./tabsets.md)
3738
- [toggle_terminal.wez](./toggle-terminal.md)

docs/sync-panes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### `sync-panes.wez`
2+
3+
You can import type annotations for [`annie444/sync-panes.wez`](https://github.com/annie444/sync-panes.wez) as shown below:
4+
5+
```lua
6+
---@type SyncPanes
7+
local sync_panes = wezterm.plugin.require("https://github.com/annie444/sync-panes.wez")
8+
```
9+
10+
<!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---@meta
2+
---@diagnostic disable:unused-local
3+
4+
---@class SyncPanesOpts
5+
---@field backspace? string
6+
---@field border? boolean
7+
---@field border_color? string
8+
---@field indicator? boolean
9+
---@field indicator_color? string
10+
---@field key_table_name? string
11+
---@field status_text? string
12+
---@field toggle_key? string
13+
---@field toggle_mods? string
14+
15+
---@class SyncPanes
16+
---@field toggle { EmitEvent: string }
17+
local M = {}
18+
19+
---@param config Config
20+
---@param opts? SyncPanesOpts
21+
---@return Config config
22+
function M.apply_to_config(config, opts) end
23+
24+
---@param window Window
25+
---@return boolean synced
26+
function M.is_synced(window) end
27+
28+
-- vim: set ts=2 sts=2 sw=2 et ai si sta:

0 commit comments

Comments
 (0)