https://github.com/MLFlexer/smart_workspace_switcher.wezterm
A smart wezterm workspace switcher plugin inspired by joshmedeski/t-smart-tmux-session-manager
https://github.com/MLFlexer/smart_workspace_switcher.wezterm
plugin sesh session session-management session-manager wezterm wezterm-config wezterm-plugin wezterm-session workspace workspace-management workspace-manager workspaces
Last synced: 14 days ago
JSON representation
A smart wezterm workspace switcher plugin inspired by joshmedeski/t-smart-tmux-session-manager
- Host: GitHub
- URL: https://github.com/MLFlexer/smart_workspace_switcher.wezterm
- Owner: MLFlexer
- License: mit
- Created: 2023-07-13T08:25:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T18:21:29.000Z (11 months ago)
- Last Synced: 2024-11-14T19:26:23.604Z (11 months ago)
- Topics: plugin, sesh, session, session-management, session-manager, wezterm, wezterm-config, wezterm-plugin, wezterm-session, workspace, workspace-management, workspace-manager, workspaces
- Language: Lua
- Homepage:
- Size: 58.6 KB
- Stars: 76
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wezterm - MLFlexer/smart_workspace_switcher.wezterm - Switch between workspaces with fuzzy finding and `zoxide`. (Session)
README
# smart_workspace_switcher.wezterm
A smart Wezterm workspace switcher inspired by [t-smart-tmux-session-manager](https://github.com/joshmedeski/t-smart-tmux-session-manager) and its successor [sesh](https://github.com/joshmedeski/sesh)
## Usage
💨 Level up your workflow by switching between workspaces ⚡ ***BLAZINGLY FAST*** ⚡ with 1️⃣ keypress, the power of fuzzy finding and zoxide! 💨
## Dependencies
* zoxide
### Setup
1. Require the plugin:
```lua
local wezterm = require("wezterm")
local workspace_switcher = wezterm.plugin.require("https://github.com/MLFlexer/smart_workspace_switcher.wezterm")
```
2. Apply the default keybinding to the config:
```lua
workspace_switcher.apply_to_config(config)
```
Or create your own keybinding, see [Configuration - Keybinding](#Keybinding).
### Configuration:
#### Keybinding
To add a custom keybinding:
```lua
config.keys = {
-- ...
-- your other keybindings
{
key = "s",
mods = "LEADER",
action = workspace_switcher.switch_workspace(),
},
{
key = "S",
mods = "LEADER",
action = workspace_switcher.switch_to_prev_workspace(),
}
}
```
#### Changing the Default Workspace Name
You can set a default workspace name:
```lua
config.default_workspace = "~"
```
#### Additional Filtering
You can include `extra_args` in the call to `switch_workspace` to filter the results of the zoxide query further. The `extra_args` is just a string concatenated to the command like so: `zoxide query -l `. For example, to select projects from a predefined list in `~/.projects`, call the plugin like this:
```lua
workspace_switcher.switch_workspace({ extra_args = " | rg -Fxf ~/.projects" })
```
#### Changing elements of the fuzzy finder
You can change the list of elements of the fuzzy finder by setting a new function for `get_choices` likes so:
```lua
local workspace_switcher = wezterm.plugin.require("https://github.com/MLFlexer/smart_workspace_switcher.wezterm")
workspace_switcher.get_choices = function(opts)
-- this will ONLY show the workspace elements, NOT the Zoxide results
return workspace_switcher.choices.get_workspace_elements({})
end
```
By default the function uses the following functions to create a list:
```lua
workspace_switcher.choices.get_workspace_elements({ id: string, label: string }[])
workspace_switcher.choices.get_zoxide_elements({ id: string, label: string }[], {extra_args?: string, workspace_ids?: workspace_ids}?)
```
#### Updating the Right Status with the Path
To add the selected path to the right status bar, use the `smart_workspace_switcher.workspace_switcher.chosen` event emitted when choosing a workspace:
```lua
wezterm.on("smart_workspace_switcher.workspace_switcher.chosen", function(window, workspace)
local gui_win = window:gui_window()
local base_path = string.gsub(workspace, "(.*[/\\])(.*)", "%2")
gui_win:set_right_status(wezterm.format({
{ Foreground = { Color = "green" } },
{ Text = base_path .. " " },
}))
end)
wezterm.on("smart_workspace_switcher.workspace_switcher.created", function(window, workspace)
local gui_win = window:gui_window()
local base_path = string.gsub(workspace, "(.*[/\\])(.*)", "%2")
gui_win:set_right_status(wezterm.format({
{ Foreground = { Color = "green" } },
{ Text = base_path .. " " },
}))
end)
```
#### Events
The following events are available and can be used to trigger custom behavior:
* `smart_workspace_switcher.workspace_switcher.start` - Triggered when the fuzzy finder starts.
* `smart_workspace_switcher.workspace_switcher.canceled` - Triggered if no element is chosen.
* `smart_workspace_switcher.workspace_switcher.selected` - Triggered when an element is selected.
* `smart_workspace_switcher.workspace_switcher.created` - Triggered after creating and switching to a new workspace.
* `smart_workspace_switcher.workspace_switcher.chosen` - Triggered after switching to a workspace.
* `smart_workspace_switcher.workspace_switcher.switched_to_prev` - Triggered after switching to a previous workspace.
> [!NOTE]
> The `created` and `chosen` events emit [MuxWindow](https://wezfurlong.org/wezterm/config/lua/mux-window/) objects while the others emit [GuiWindow](https://wezfurlong.org/wezterm/config/lua/window/index.html) objects.
Example usage:
```lua
wezterm.on("smart_workspace_switcher.workspace_switcher.chosen", function(window, workspace)
wezterm.log_info("THIS IS EMITTED FROM THE CALLBACK")
end)
```
#### Workspace Formatter
Set a custom workspace formatter using the following example. For more information, see the [Wezterm formatting docs](https://wezfurlong.org/wezterm/config/lua/wezterm/format.html):
```lua
workspace_switcher.workspace_formatter = function(label)
return wezterm.format({
{ Attribute = { Italic = true } },
{ Foreground = { Color = "green" } },
{ Background = { Color = "black" } },
{ Text = ": " .. label },
})
end
```
#### Zoxide Path
To define a custom path to `zoxide`:
```lua
workspace_switcher.zoxide_path = "/path/to/zoxide"
```