smart_workspace_switcher.wezterm

A smart Wezterm workspace switcher inspired by t-smart-tmux-session-manager and its successor 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

require the plugin:

local wezterm = require("wezterm")
local workspace_switcher = wezterm.plugin.require("https://github.com/MLFlexer/smart_workspace_switcher.wezterm")

Apply default keybinding to config:

workspace_switcher.apply_to_config(config)

Or make your own keybinding, see Configuration - Keybinding

Configuration:

Keybinding

Add custom keybinding

config.keys = {
  -- ...
  -- your other keybindings
  {
  key = "s",
  mods = "ALT",
  action = workspace_switcher.switch_workspace(),
  }
}

Changing default workspace name

config.default_workspace = "~"

Additional filtering

Users may also choose to include extra_args in the call to switch_workspace. The string contents of this value are appended to the call to zoxide query -l. This can be used to further filter the results of the query. For example, imagine one has a predefined list of projects from which they wish to select. It might be a file, ~/.projects, with contents like:

/Users/you/projects/gitlab.com/foo/bar
/Users/you/projects/github.com/MLFlexer/smart_workspace_switcher.wezterm

If you want your project switcher only to select projects from this list, but still make use of the zoxide query ordering, you can call the plugin as:

config.keys = {
  -- ...
  -- your other keybindings
  {
  key = "s",
  mods = "ALT",
  action = workspace_switcher.switch_workspace(" | rg -Fxf ~/.projects"),
  }
}

Update right-status with the path

Adding the path as a part of the right-status can be done with the smart_workspace_switcher.workspace_chosen event which is emitted when choosing the workspace.

wezterm.on("smart_workspace_switcher.workspace_switcher.chosen", function(window, path)
  local base_path = string.gsub(path, "(.*[/\\])(.*)", "%2")
  window:set_right_status(wezterm.format({
    { Foreground = { Color = colors.colors.ansi[5] } },
    { Text = base_path .. "  " },
  }))
end)

wezterm.on("smart_workspace_switcher.workspace_switcher.created", function(window, path)
  local base_path = string.gsub(path, "(.*[/\\])(.*)", "%2")
  window:set_right_status(wezterm.format({
    { Foreground = { Color = colors.colors.ansi[5] } },
    { Text = base_path .. "  " },
  }))
end)

Events

Use the events which are emitted when choosing the workspace to add a callback function. The following events are available:

smart_workspace_switcher.workspace_switcher.start - when the fuzzy finder starts
smart_workspace_switcher.workspace_switcher.selected - when a element is selected
smart_workspace_switcher.workspace_switcher.created - after a new workspace is created and switched to upon selecting
smart_workspace_switcher.workspace_switcher.chosen - after switching to a new workspace upon selecting

See example for use below:

wezterm.on("smart_workspace_switcher.workspace_switcher.chosen", function(window, path)
  wezterm.log_info("THIS IS EMITTED FROM THE CALLBACK")
end)

Workspace formatter

Set a custom workspace formatter, see Wezterm formatting docs

workspace_switcher.set_workspace_formatter(function(label)
  return wezterm.format({
    { Attribute = { Italic = true } },
    { Foreground = { Color = "green" } },
    { Background = { Color = "black" } },
    { Text = "󱂬: " .. label },
  })
end)

Zoxide path

Define path to zoxide:

workspace_switcher.set_zoxide_path("/path/to/zoxide)

theherk / smart_workspace_switcher.wezterm