smart_workspace_switcher.wezterm

To use the plugin, you must have zoxide installed on your system. Follow these steps in your wezterm.lua configuration:

1. Require the plugin using the GitHub URL.
2. Apply the default keybindings to your configuration object using workspace_switcher.apply_to_config(config).

Note: This project is archived and no longer maintained.

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

-- Assuming 'config' is your Wezterm configuration object
workspace_switcher.apply_to_config(config)

Instead of using apply_to_config, you can manually define keybindings in your config.keys table. Use workspace_switcher.switch_workspace() to open the switcher and workspace_switcher.switch_to_prev_workspace() to cycle to the previous workspace.

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(),
  }
}

You can pass an extra_args table to switch_workspace to further filter the zoxide query. The string provided is concatenated to the command: zoxide query -l <extra_args>.

For example, to filter results using rg (ripgrep) against a list of projects in ~/.projects, pass the pipe command as the argument.

workspace_switcher.switch_workspace({ extra_args = " | rg -Fxf ~/.projects" })

You can override the get_choices function to change what appears in the fuzzy finder.

• To show only existing workspaces (and ignore zoxide results), use workspace_switcher.choices.get_workspace_elements({}).
• To use the default behavior with custom logic, you can utilize the helper functions:
  • 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}?)

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

You can define a workspace_formatter function to change how workspace labels are rendered in the UI using Wezterm's formatting API.

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

The following configuration keys are available on the workspace_switcher object:

• default_workspace: Set a default workspace name (e.g., config.default_workspace = "~").
• zoxide_path: Define a custom path to the zoxide executable (e.g., workspace_switcher.zoxide_path = "/path/to/zoxide").
• workspace_formatter: A function used to format workspace labels.
• get_choices: A function used to define the list of elements in the fuzzy finder.