Skip to content
Shoji

Migration guide

This guide documents breaking changes between Shoji versions and how to update your configuration.

Unreleased

Layout renamed: fullscreen → monocle

The fullscreen layout has been renamed to monocle to avoid confusion with macOS native fullscreen mode.

Update your configuration:

-- Before
enabled_layouts = { "tall", "fullscreen" }
default_layout = "fullscreen"


-- After
enabled_layouts = { "tall", "monocle" }
default_layout = "monocle"

Update your keybindings:

-- Before
spoon.Shoji:bindHotkeys({
  set_layout_fullscreen = { { "ctrl", "alt" }, "f" },
})


-- After
spoon.Shoji:bindHotkeys({
  set_layout_monocle = { { "ctrl", "alt" }, "f" },
})

Alert duration validation

The alert_duration configuration option now has a maximum value of 10 seconds. If you had a higher value configured, it will be rejected during validation.

-- Before (would work but block UI)
alert_duration = 999


-- After (maximum is 10 seconds)
alert_duration = 10

General upgrade process

  1. Backup your configuration before upgrading
  2. Read the changelog for your target version
  3. Update configuration following the migration notes above
  4. Reload Hammerspoon (or restart)
  5. Check the console for any warnings or errors