Skip to content

Commit 7178899

Browse files
committed
feat(wezterm-sync): add type annotations
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
1 parent f68ca2e commit 7178899

5 files changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ This project also features type annotations for various WezTerm plugins.
9292
| [ribbon.wz](https://github.com/sravioli/ribbon.wz) | [docs/ribbon.md](./docs/ribbon.md) | [:h wezterm-types-plugin.ribbon.txt](./doc/wezterm-types-plugin.ribbon.txt) |
9393
| [rosepine](https://github.com/neapsix/wezterm) | [docs/rosepine.md](./docs/rosepine.md) | [:h wezterm-types-plugin.rosepine.txt](./doc/wezterm-types-plugin.rosepine.txt) |
9494
| [sessionizer.wezterm](https://github.com/mikkasendke/sessionizer.wezterm) | [docs/sessionizer.md](./docs/sessionizer.md) | [:h wezterm-types-plugin.sessionizer.txt](./doc/wezterm-types-plugin.sessionizer.txt) |
95-
| [sigil.wz](https://github.com/sravioli/sigil.wz) | [docs/sigil.md](./docs/sigil.md) | [:h wezterm-types-plugin.sigil.txt](./doc/wezterm-types-plugin.sigil.txt) |
95+
| [sigil.wz](https://github.com/sravioli/sigil.wz) | [docs/sigil.md](./docs/sigil.md) | [:h wezterm-types-plugin.sigil.txt](./doc/wezterm-types-plugin.sigil.txt) |
9696
| [smart-splits.nvim](https://github.com/mrjones2014/smart-splits.nvim) | [docs/smart-splits.md](./docs/smart-splits.md) | [:h wezterm-types-plugin.smart-splits.txt](./doc/wezterm-types-plugin.smart-splits.txt) |
9797
| [smart_workspace_switcher.wezterm](https://github.com/MLFlexer/smart_workspace_switcher.wezterm) | [docs/smart-workspace-switcher.md](./docs/smart-workspace-switcher.md) | [:h wezterm-types-plugin.smart_workspace_switcher.txt](./doc/wezterm-types-plugin.smart_workspace_switcher.txt) |
9898
| [stack.wez](https://github.com/bad-noodles/stack.wez) | [docs/stack.md](./docs/stack.md) | [:h wezterm-types-plugin.stack.txt](./doc/wezterm-types-plugin.stack.txt) |
@@ -111,6 +111,7 @@ This project also features type annotations for various WezTerm plugins.
111111
| [wezterm-replay](https://github.com/btrachey/wezterm-replay) | [docs/replay.md](./docs/replay.md) | [:h wezterm-types-plugin.replay.txt](./doc/wezterm-types-plugin.replay.txt) |
112112
| [wezterm-sessions](https://github.com/abidibo/wezterm-sessions) | [docs/wezterm-sessions.md](./docs/wezterm-sessions.md) | [:h wezterm-types-plugin.wezterm-sessions.txt](./doc/wezterm-types-plugin.wezterm-sessions.txt) |
113113
| [wezterm-status](https://github.com/yriveiro/wezterm-status) | [docs/wezterm-status.md](./docs/wezterm-status.md) | [:h wezterm-types-plugin.wezterm-status.txt](./doc/wezterm-types-plugin.wezterm-status.txt) |
114+
| [wezterm-sync](https://github.com/dfsramos/wezterm-sync) | [docs/sync.md](./docs/sync.md) | [:h wezterm-types-plugin.sync.txt](./doc/wezterm-types-plugin.sync.txt) |
114115
| [wezterm-tabs](https://github.com/yriveiro/wezterm-tabs) | [docs/wezterm-tabs.md](./docs/wezterm-tabs.md) | [:h wezterm-types-plugin.wezterm-tabs.txt](./doc/wezterm-types-plugin.wezterm-tabs.txt) |
115116
| [wezterm-theme-rotator](https://github.com/koh-sh/wezterm-theme-rotator) | [docs/wezterm-theme-rotator.md](./docs/wezterm-theme-rotator.md) | [:h wezterm-types-plugin.wezterm-theme-rotator.txt](./doc/wezterm-types-plugin.wezterm-theme-rotator.txt) |
116117
| [workspace-picker.wezterm](https://github.com/isseii10/workspace-picker.wezterm) | [docs/workspace-picker.md](./docs/workspace-picker.md) | [:h wezterm-types-plugin.workspace-picker.txt](./doc/wezterm-types-plugin.workspace-picker.txt) |

doc/wezterm-types-plugin.sync.txt

Whitespace-only changes.

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ We will keep adding more community plugins as we find them.
4747
- [wezterm-replay](./replay.md)
4848
- [wezterm-sessions](./wezterm-sessions.md)
4949
- [wezterm-status](./wezterm-status.md)
50+
- [wezterm-sync](./sync.md)
5051
- [wezterm-tabs](./wezterm-tabs.md)
5152
- [wezterm-theme-rotator](./wezterm-theme-rotator.md)
5253
- [workspace-picker.wezterm](./workspace-picker.md)

docs/sync.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### `wezterm-sync`
2+
3+
You can import type annotations for
4+
[`dfsramos/wezterm-sync`](https://github.com/dfsramos/wezterm-sync) as shown below:
5+
6+
```lua
7+
---@type Sync
8+
local sync = wezterm.plugin.require("https://github.com/dfsramos/wezterm-sync")
9+
```
10+
11+
<!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->

lua/wezterm/types/plugins/sync.lua

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---@meta
2+
---@diagnostic disable:unused-local
3+
4+
---@class SyncOpts
5+
---@field gist_id? string
6+
7+
---@class Sync
8+
local M = {}
9+
10+
---@param config Config
11+
---@param opts? SyncOpts
12+
function M.apply_to_config(config, opts) end
13+
14+
-- vim: set ts=2 sts=2 sw=2 et ai si sta:

0 commit comments

Comments
 (0)