chore(hammerspoon): add configuration

https://github.com/Hammerspoon/hammerspoon

.dotbot.conf.yaml

@@ -14,6 +14,7 @@
     ~/.editorconfig: editorconfig
     ~/.gitconfig: gitconfig
     ~/.gitignore: gitignore
+    ~/.hammerspoon: hammerspoon
     ~/.pandoc: pandoc
     ~/.wget: wget
     ~/.zshrc: zshrc

hammerspoon/caffeine.lua

@@ -0,0 +1,20 @@
+-- Replace Caffeine.app with 18 lines of Lua :D
+local caffeine = hs.menubar.new()
+
+function setCaffeineDisplay(state)
+  local result
+  if state then
+    result = caffeine:setIcon("~/.hammerspoon/icons/sun.pdf")
+  else
+    result = caffeine:setIcon("~/.hammerspoon/icons/moon.pdf")
+  end
+end
+
+function caffeineClicked()
+  setCaffeineDisplay(hs.caffeinate.toggle("displayIdle"))
+end
+
+if caffeine then
+  caffeine:setClickCallback(caffeineClicked)
+  setCaffeineDisplay(hs.caffeinate.get("displayIdle"))
+end

hammerspoon/functions.lua

@@ -0,0 +1,128 @@
+----------------------
+-- Helper Functions --
+----------------------
+
+-- Get list of screens and refresh that list whenever screens are plugged or unplugged:
+local screens = hs.screen.allScreens()
+local screenwatcher = hs.screen.watcher.new(function()
+  screens = hs.screen.allScreens()
+end)
+screenwatcher:start()
+
+
+-- Move a window a number of pixels in x and y
+function nudge(xpos, ypos)
+  local win = hs.window.focusedWindow()
+  local f = win:frame()
+  f.x = f.x + xpos
+  f.y = f.y + ypos
+  win:setFrame(f)
+end
+
+
+-- Resize a window by moving the bottom
+function yank(xpixels, ypixels)
+  local win = hs.window.focusedWindow()
+  local f = win:frame()
+
+  f.w = f.w + xpixels
+  f.h = f.h + ypixels
+  win:setFrame(f)
+end
+
+
+-- Resize window for chunk of screen.
+-- For x and y: use 0 to expand fully in that dimension, 0.5 to expand halfway
+-- For w and h: use 1 for full, 0.5 for half
+function push(x, y, w, h)
+  local win = hs.window.focusedWindow()
+  local f = win:frame()
+  local screen = win:screen()
+  local max = screen:frame()
+
+  f.x = max.x + (max.w*x)
+  f.y = max.y + (max.h*y)
+  f.w = max.w*w
+  f.h = max.h*h
+  win:setFrame(f)
+end
+
+
+-- Move to monitor x. Checks to make sure monitor exists, if not moves to last monitor that exists
+function moveToMonitor(x)
+  local win = hs.window.focusedWindow()
+  local newScreen = nil
+  while not newScreen do
+    newScreen = screens[x]
+    x = x-1
+  end
+
+  win:moveToScreen(newScreen)
+end
+
+-- Move to next screen
+local function moveToNextScreen(win)
+  win = win or window.focusedWindow()
+  win:moveToScreen(win:screen():next())
+end
+
+-- Move to previous screen
+local function moveToPreviousScreen(win)
+  win = win or window.focusedWindow()
+  win:moveToScreen(win:screen():previous())
+end
+
+-- This places a red circle around the mouse pointer
+local mouseCircle = nil
+local mouseCircleTimer = nil
+
+function mouseHighlight()
+  -- Delete an existing highlight if it exists
+  if mouseCircle then
+    mouseCircle:delete()
+    if mouseCircleTimer then
+      mouseCircleTimer:stop()
+    end
+  end
+  -- Get the current co-ordinates of the mouse pointer
+  mousepoint = hs.mouse.get()
+  -- Prepare a big red circle around the mouse pointer
+  mouseCircle = hs.drawing.circle(hs.geometry.rect(mousepoint.x-40, mousepoint.y-40, 80, 80))
+  mouseCircle:setStrokeColor({["red"]=1,["blue"]=0,["green"]=0,["alpha"]=1})
+  mouseCircle:setFill(false)
+  mouseCircle:setStrokeWidth(5)
+  mouseCircle:show()
+
+  -- Set a timer to delete the circle after 3 seconds
+  mouseCircleTimer = hs.timer.doAfter(2, function() mouseCircle:delete() end)
+end
+
+-- Get all valid windows
+function getAllValidWindows()
+  local allWindows = hs.window.allWindows()
+  local windows = {}
+  local index = 1
+  for i = 1, #allWindows do
+    local w = allWindows[i]
+    if w:screen() then
+      windows[index] = w
+      index = index + 1
+    end
+  end
+  return windows
+end
+
+-- Auto Reload Config
+function reloadConfig(files)
+    doReload = false
+    for _,file in pairs(files) do
+        if file:sub(-4) == ".lua" then
+            doReload = true
+        end
+    end
+    if doReload then
+        hs.reload()
+    end
+end
+hs.pathwatcher.new(os.getenv("HOME") .. "/.hammerspoon/", reloadConfig):start()
+hs.alert.show("Hammerspoon")

hammerspoon/init.lua

@@ -0,0 +1,233 @@
+require("functions")
+require("caffeine")
+
+local application = hs.application
+local window      = hs.window
+local layout      = hs.layout
+local screen      = hs.screen
+local hotkey      = hs.hotkey
+local hints       = hs.hints
+
+
+-------------------
+-- Configuration --
+-------------------
+
+-- Animation
+window.animationDuration = 0
+
+-- Hints
+hints.fontName        = "Helvetica-Bold"
+hints.fontSize        = 18
+hints.showTitleThresh = 0
+-- hints.style           = "vimperator" -- Buggy, gets slow after a while
+
+-- Allow searching for alternate names
+application.enableSpotlightForNameSearches(true)
+
+------------
+-- Aliase --
+------------
+
+-- Keys
+local KEY_SCAM = { "⇧", "⌃", "⌥", "⌘" }
+local KEY_SCA  = { "⇧", "⌃", "⌥" }
+local KEY_SCM  = { "⇧", "⌃", "⌘" }
+local KEY_CAM  = { "⌃", "⌥", "⌘" }
+local KEY_CA   = { "⌃", "⌥" }
+local KEY_CM   = { "⌃", "⌘" }
+local KEY_SAM  = { "⇧", "⌥", "⌘" }
+local KEY_AM   = { "⌥", "⌘" }
+
+-- Displays
+local DISPLAY_PRIMARY = screen.primaryScreen()
+local DISPLAY_SECONDARY = screen.findByName("DELL U2719DC")
+local DISPLAY_NOTEBOOK = "Color LCD"
+
+-- Sizes
+local LEFT_MOST  = hs.geometry.unitrect(0, 0, 0.6, 1)
+local LEFT_LESS  = hs.geometry.unitrect(0, 0, 0.4, 1)
+local RIGHT_MOST = hs.geometry.unitrect(0.4, 0, 0.6, 1)
+local RIGHT_LESS = hs.geometry.unitrect(0.6, 0, 0.4, 1)
+local FULLSCREEN = hs.geometry.unitrect(0, 0, 1, 1)
+local RIGHT_HALF = hs.geometry.unitrect(0.5, 0, 0.5, 1)
+local LEFT_HALF  = hs.geometry.unitrect(0, 0, 0.5, 1)
+
+-------------
+-- Layouts --
+-------------
+
+-- Format reminder:
+-- {"App name", "Window name", "Display Name", "unitrect", "framerect", "fullframerect"},
+
+-- Two Monitors and Notebook
+local LAYOUT_TRI = {
+  {"Brave Browser",             nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Code",                      nil, DISPLAY_PRIMARY,   FULLSCREEN, nil, nil},
+  {"DEVONthink 3",              nil, DISPLAY_PRIMARY,   FULLSCREEN, nil, nil},
+  {"Evernote",                  nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Firefox Developer Edition", nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Kalender",                  nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Keybase",                   nil, DISPLAY_NOTEBOOK,  LEFT_HALF,  nil, nil},
+  {"Mail",                      nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Microsoft Outlook",         nil, DISPLAY_PRIMARY,   FULLSCREEN, nil, nil},
+  {"Nachrichten",               nil, DISPLAY_NOTEBOOK,  RIGHT_HALF, nil, nil},
+  {"Riot",                      nil, DISPLAY_NOTEBOOK,  RIGHT_HALF, nil, nil},
+  {"Slack",                     nil, DISPLAY_PRIMARY,   FULLSCREEN, nil, nil},
+  {"Spotify",                   nil, DISPLAY_SECONDARY, FULLSCREEN, nil, nil},
+  {"Telegram",                  nil, DISPLAY_NOTEBOOK,  LEFT_HALF,  nil, nil},
+  {"Things",                    nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"Zeplin",                    nil, DISPLAY_SECONDARY, FULLSCREEN, nil, nil},
+  {"iA Writer",                 nil, DISPLAY_NOTEBOOK,  FULLSCREEN, nil, nil},
+  {"iTerm2",                    nil, DISPLAY_PRIMARY,   FULLSCREEN, nil, nil},
+}
+-- One Monitor and Notebook
+local LAYOUT_DUAL = {
+  {"Brave Browser",             nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Code",                      nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"DEVONthink 3",              nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Evernote",                  nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Firefox Developer Edition", nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Kalender",                  nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Keybase",                   nil, DISPLAY_NOTEBOOK, LEFT_HALF,  nil, nil},
+  {"Mail",                      nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Microsoft Outlook",         nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Nachrichten",               nil, DISPLAY_PRIMARY,  RIGHT_HALF, nil, nil},
+  {"Riot",                      nil, DISPLAY_NOTEBOOK, RIGHT_HALF, nil, nil},
+  {"Slack",                     nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Sonos",                     nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"Spotify",                   nil, DISPLAY_NOTEBOOK, FULLSCREEN, nil, nil},
+  {"Telegram",                  nil, DISPLAY_PRIMARY,  LEFT_HALF,  nil, nil},
+  {"Things",                    nil, DISPLAY_NOTEBOOK, FULLSCREEN, nil, nil},
+  {"iA Writer",                 nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+  {"iTerm2",                    nil, DISPLAY_PRIMARY,  FULLSCREEN, nil, nil},
+}
+
+--  One Monitor
+local LAYOUT_SINGLE = {
+  {"Brave Browser",             nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Code",                      nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"DEVONthink 3",              nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Evernote",                  nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Firefox Developer Edition", nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Kalender",                  nil, DISPLAY_PRIMARY, LEFT_MOST,  nil, nil},
+  {"Keybase",                   nil, DISPLAY_PRIMARY, LEFT_HALF,  nil, nil},
+  {"Mail",                      nil, DISPLAY_PRIMARY, RIGHT_MOST, nil, nil},
+  {"Microsoft Outlook",         nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Nachrichten",               nil, DISPLAY_PRIMARY, RIGHT_LESS, nil, nil},
+  {"Riot",                      nil, DISPLAY_PRIMARY, RIGHT_HALF, nil, nil},
+  {"Slack",                     nil, DISPLAY_PRIMARY, LEFT_MOST,  nil, nil},
+  {"Sonos",                     nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Spotify",                   nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"Telegram",                  nil, DISPLAY_PRIMARY, LEFT_MOST,  nil, nil},
+  {"Things",                    nil, DISPLAY_PRIMARY, RIGHT_LESS, nil, nil},
+  {"iA Writer",                 nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+  {"iTerm2",                    nil, DISPLAY_PRIMARY, FULLSCREEN, nil, nil},
+}
+
+------------------
+-- Key Bindings --
+------------------
+
+-- Movement hotkeys
+-- hotkey.bind(KEY_AM, "down",  function() nudge(0, 100) end)
+-- hotkey.bind(KEY_AM, "up",    function() nudge(0, -100) end)
+-- hotkey.bind(KEY_AM, "right", function() nudge(100, 0) end)
+-- hotkey.bind(KEY_AM, "left",  function() nudge(-100, 0) end)
+
+-- Resize hotkeys
+hotkey.bind(KEY_SAM, "up",    function() yank(0, -100) end)
+hotkey.bind(KEY_SAM, "down",  function() yank(0, 100) end)
+hotkey.bind(KEY_SAM, "right", function() yank(100, 0) end)
+hotkey.bind(KEY_SAM, "left",  function() yank(-100, 0) end)
+
+-- Push to screen edge
+hotkey.bind(KEY_CAM, "left",  function() push(0, 0, 0.5, 1) end)
+hotkey.bind(KEY_CAM, "right", function() push(0.5, 0, 0.5, 1) end)
+hotkey.bind(KEY_CAM, "up",    function() push(0, 0, 1, 0.5) end)
+hotkey.bind(KEY_CAM, "down",  function() push(0, 0.5, 1, 0.5) end)
+
+-- Centered window with some room to see the desktop
+hotkey.bind(KEY_SCM, "l", function() push(0.05, 0.05, 0.9, 0.9) end)
+hotkey.bind(KEY_SCM, "m", function() push(0.1, 0.1, 0.8, 0.8) end)
+hotkey.bind(KEY_SCM, "s", function() push(0.15, 0.15, 0.7, 0.7) end)
+
+-- Fullscreen
+hotkey.bind(KEY_CAM, "0", function() push(0, 0, 1, 1) end)
+
+-- Quarter Screens
+hotkey.bind(KEY_CAM, "q", function() push(0, 0, 0.5, 0.5) end)
+hotkey.bind(KEY_CAM, "w", function() push(0.5, 0, 0.5, 0.5) end)
+hotkey.bind(KEY_CAM, "a", function() push(0, 0.5, 0.5, 0.5) end)
+hotkey.bind(KEY_CAM, "s", function() push(0.5, 0.5, 0.5, 0.5) end)
+
+-- Part Screens
+hotkey.bind(KEY_CAM, "4", function() push(0, 0, 0.6, 1) end)
+hotkey.bind(KEY_CAM, "5", function() push(0, 0, 0.4, 1) end)
+hotkey.bind(KEY_CAM, "6", function() push(0.4, 0, 0.6, 1) end)
+hotkey.bind(KEY_CAM, "7", function() push(0.6, 0, 0.4, 1) end)
+
+-- Move a window between monitors (preserve size)
+hotkey.bind(KEY_CM,  "1",    function() window.focusedWindow():moveOneScreenNorth() end)
+hotkey.bind(KEY_CM,  "2",    function() window.focusedWindow():moveOneScreenSouth() end)
+hotkey.bind(KEY_CM,  "3",    function() window.focusedWindow():moveOneScreenWest() end)
+hotkey.bind(KEY_CM,  "up",   function() window.focusedWindow():moveOneScreenNorth() end)
+hotkey.bind(KEY_CM,  "down", function() window.focusedWindow():moveOneScreenSouth() end)
+hotkey.bind(KEY_CM,  "right", function() window.focusedWindow():moveOneScreenEast() end)
+hotkey.bind(KEY_CM,  "left", function() window.focusedWindow():moveOneScreenWest() end)
+hotkey.bind(KEY_CM,  "k",    function() window.focusedWindow():moveOneScreenNorth() end)
+hotkey.bind(KEY_CM,  "j",    function() window.focusedWindow():moveOneScreenSouth() end)
+hotkey.bind(KEY_CM,  "l",    function() window.focusedWindow():moveOneScreenEast() end)
+hotkey.bind(KEY_CM,  "h",    function() window.focusedWindow():moveOneScreenWest() end)
+
+-- Move a window between monitors (change to fullscreen)
+hotkey.bind(KEY_SCM, "1",    function() window.focusedWindow():moveOneScreenNorth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "2",    function() window.focusedWindow():moveOneScreenSouth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "3",    function() window.focusedWindow():moveOneScreenWest(); window.focusedWindow():moveOneScreenWest(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "up",   function() window.focusedWindow():moveOneScreenNorth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "down", function() window.focusedWindow():moveOneScreenSouth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "right", function() window.focusedWindow():moveOneScreenEast(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "left", function() window.focusedWindow():moveOneScreenWest(); window.focusedWindow():moveOneScreenWest(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "k",    function() window.focusedWindow():moveOneScreenNorth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "j",    function() window.focusedWindow():moveOneScreenSouth(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "l",    function() window.focusedWindow():moveOneScreenEast(); push(0, 0, 1, 1) end)
+hotkey.bind(KEY_SCM, "h",    function() window.focusedWindow():moveOneScreenWest(); window.focusedWindow():moveOneScreenWest(); push(0, 0, 1, 1) end)
+
+-- Application shortcuts
+hotkey.bind(KEY_SCAM, "A", function() application.launchOrFocus("Affinity Designer") end)
+hotkey.bind(KEY_SCAM, "B", function() application.launchOrFocus("Brave Browser") end)
+hotkey.bind(KEY_SCAM, "C", function() application.launchOrFocus("Visual Studio Code") end)
+hotkey.bind(KEY_SCAM, "D", function() application.launchOrFocus("DEVONthink 3") end)
+hotkey.bind(KEY_SCAM, "E", function() application.launchOrFocus("Evernote") end)
+hotkey.bind(KEY_SCAM, "F", function() application.launchOrFocus("Firefox Developer Edition") end)
+hotkey.bind(KEY_SCAM, "K", function() application.launchOrFocus("Calendar") end)
+hotkey.bind(KEY_SCAM, "L", function() application.launchOrFocus("Microsoft Outlook") end)
+hotkey.bind(KEY_SCAM, "M", function() application.launchOrFocus("Mail") end)
+hotkey.bind(KEY_SCAM, "N", function() application.launchOrFocus("Messages") end)
+hotkey.bind(KEY_SCAM, "O", function() application.launchOrFocus("Obsidian") end)
+hotkey.bind(KEY_SCAM, "P", function() application.launchOrFocus("Podcasts") end)
+hotkey.bind(KEY_SCAM, "S", function() application.launchOrFocus("Slack") end)
+hotkey.bind(KEY_SCAM, "T", function() application.launchOrFocus("Things3") end)
+hotkey.bind(KEY_SCAM, "W", function() application.launchOrFocus("iA Writer") end)
+hotkey.bind(KEY_SCAM, "Y", function() application.launchOrFocus("Music") end)
+hotkey.bind(KEY_SCAM, "Z", function() application.launchOrFocus("Zeplin") end)
+
+-- Place red circle around mouse
+hotkey.bind(KEY_SCAM, "space", mouseHighlight)
+
+-- Config reloading. manual (from getting started guide):
+hotkey.bind(KEY_CAM, "delete", function() hs.reload() end)
+
+-- Focus
+hotkey.bind(KEY_CAM, 'k', function() window.focusedWindow():focusWindowNorth() end)
+hotkey.bind(KEY_CAM, 'j', function() window.focusedWindow():focusWindowSouth() end)
+hotkey.bind(KEY_CAM, 'l', function() window.focusedWindow():focusWindowEast() end)
+hotkey.bind(KEY_CAM, 'h', function() window.focusedWindow():focusWindowWest() end)
+
+-- Hints
+hotkey.bind(KEY_CAM, "space", function() hints.windowHints(getAllValidWindows()) end)
+
+-- Layouts
+hotkey.bind(KEY_SCAM, "1", function() layout.apply(LAYOUT_SINGLE) end)
+hotkey.bind(KEY_SCAM, "2", function() layout.apply(LAYOUT_DUAL) end)
+hotkey.bind(KEY_SCAM, "3", function() layout.apply(LAYOUT_TRI) end)