Giter Site home page Giter Site logo

boomker / spacehammer Goto Github PK

View Code? Open in Web Editor NEW
20.0 1.0 2.0 94.23 MB

🚀 空格键作为 Hyper 的 Hammerspoon 配置, 上手简单并且功能强大, 集多套开源优秀配置于一身

License: MIT License

Lua 99.83% Shell 0.17%
emoji lua hyper input-method jsonformat windowmanagement clipboardtools istatusmenu hammerspoon macos

spacehammer's Introduction

icon
icon icon icon

  • 如果你觉得本项目提供的功能对你有用,请帮忙点一个 Star,不胜感激,谢谢!
  • 若 README 图片无法显示,请确保挂了梯子,并且 PAC 文件中配置 ||githubusercontent.com,或者直接使用全局模式

目录

Table of Contents (点击展开目录)

项目背景

之前长期使用的一款快捷键启动 APP spacelauncher, 时不时弹窗提示"老兄用了这么久, 要不要考虑购买, 不买也说点什么吧", 然而它长期来没有新添加功能, 购买欲望不大, 于是想到用 Hammerspoon 来实现


Hyper键理念

  • 受到上述 spacelauncher 使用习惯的影响, 使用 Space + 字母键 来启动/切换应用. 另外我有两个 Space 键(XDM, 了解下分裂式空格客制化键盘), 多余的空格键不利用太可惜了.
  • 如何实现 Space 作为 Hyper 键? 改键神器 Karabiner-Elements 申请出战. 添加如下配置到 ~/.config/karabiner/karabiner.json 即可.
Karabiner-Elements 配置 (点击展开JSON 配置)
{
    "description": "Change spacebar to HyperKey if pressed with other keys.",
    "manipulators": [
        {
            "from": {
                "key_code": "spacebar",
                "modifiers": {
                    "optional": [
                        "any"
                    ]
                }
            },
            "to": [
                {
                    "key_code": "right_shift",
                    "modifiers": [
                        "right_control",
                        "right_option"
                    ]
                }
            ],
            "to_if_alone": [
                {
                    "hold_down_milliseconds": 300,
                    "key_code": "spacebar"
                }
            ],
            "type": "basic"
        }
    ]
}

TODO

  • 按键组, 序列键(HyperKey + W + M)

    • S→[S, D]: 打开系统设置项或弹出快捷键 Sheet 面板 ✅
    • W→[H,J,K,L], 窗口快速调整大小与布局 ✅
  • 快捷启禁用

    • 指定的模块功能
    • 指定的配置文件, 根据 wifi 变更自动切换
  • 查询当前应用的菜单并模拟点击执行 ✅

  • 优化展示当前应用的所有快捷键 Sheet

    • item 格式美化 ✅
    • 查询
  • 显示HammerSpoon 定义的热键 ✅

  • 一组热键在不同的应用中有不同的作用

  • 剪贴板工具, 附加文本处理 ✅

  • 增强型PopClip, 按字母键触发


如何安装

本工程所有脚本都基于 Hammerspoon 运行,请先下载安装 Hammerspoon,然后再执行如下命令:

curl -fsSL https://raw.githubusercontent.com/boomker/spacehammer/main/install.sh | sh

如上面这条 curl 命令下载不了 install.sh,则请打开终端代理后重试或手动下载 install.sh 后执行

最后,Menubar 中点击 Hammerspoon Reload Config 按钮即可


手动更新

手动安装更新:

cd ~/.hammerspoon
git pull origin main

如果发现冲突,请解决冲突后再执行 git pull origin main


自动更新

除手动更新外,本工程还支持自动检查更新并安装,可在功能菜单中关闭自动更新.

自动更新原理如下:

  • .config 文件(用户配置文件)加入到 .gitignore 文件中
  • 定期执行 git pull origin main
  • 如果发现冲突,则 console 打印自动更新失败相关提示信息,此时请手动安装更新,参考:手动更新
  • 如果发现默认配置版本号 > 用户本地 .config 文件的配置版本号,则在保留用户原有配置的基础上,将新增配置合并到用户本地 .config 文件中,并更新配置版本号

本工程提供功能

功能菜单

鼠标单击功能项,即可启用/禁用功能项


窗口管理

你可以丢掉大多数同类收费 App 了

实现了两种方式,总有一种适合你

  1. 原始模式: 一个快捷键对应只能操作一个窗口的布局(size 和 location),Hyper+W 进入
    • Tile 模式: Hyper+W 进入,一个快捷键可以同时操作当前 Space 下多个 App 窗口
  2. Grid模式:预配置多种窗口布局组,每组布局(Grid) 对应一个快捷键轮切, Hyper+G 进入

Hyper+W,进入窗口管理之传统模式。按下Tab键查看按键提示

  • 支持两种模式(持久和非持久),可配置任选其一
  • 支持同类 APP 多个窗口网格布局,水平垂直平铺布局,可轮转布局
  • 支持同一 Space 不同 APP 的多个窗口网格布局,水平垂直平铺布局,可轮转布局
  • 支持一键关闭同类 APP 所有窗口
  • 支持一键关闭除当前APP 窗口外的其他窗口
  • 支持窗口组(不同 APP 窗口) 自动布局(需预配置,通过 chooser 触发)
  • 支持一键 Tile 当前 Space 所有 App 窗口
    • 可同步操作所有窗口的 size
    • 可快速在窗口间变换焦点
    • 可快速交换两窗口位置
    • 支持多种 布局切换(双栏,高度优先,宽度优先,全屏)
    • 支持在多屏多 Space 下仍可保持之前布局状态,操作体验更自然🆒

Hyper+G,进入窗口管理之 Grid 轮切模式。按下Tab键查看按键提示

窗口管理之 Tile 模式,效果如下


应用快启快切

给指定的应用APP配置快捷键, 一键启动并前台聚焦, 指定的 APP 启动之后,再次按下对应的(启动键)可实现切换应用 按下Hyper Tab 还能在当前桌面空间(什么是 工作空间?)轮切应用窗口

  • 支持APP 应用名称全匹配 和 模糊匹配(大小写不敏感,应用名称缩写),应用BundleID 配置
  • 支持配置应用窗口初始布局(启动后) 和全局布局(每次HS热键切换后),以及指定屏幕显示
  • 支持配置应用窗口聚焦后自动调整布局,即任意方式切换后都自动调整, 有一定性能影响

表情包搜索

快捷键 Hyper E 唤醒表情包搜索功能,输入关键词,上下键用于选择、预览表情包;左右键用于翻页;回车键用于发送表情包;Esc 关闭搜索窗口


iStatuMenus

实时显示CPU,Mem,SSD,网速(每三秒刷新一次),点击还有其他信息


超级 S 键

Hyper+S 进入该模式。该模式可执行如下操作

  • Sheet,S查看当前 APP 的所有快捷键,H查看本项目的所有快捷键

  • System 级操作

  • Screen 多个位置的鼠标光标移动操作

  • Space 新增和移除操作

  • Secret(密码)粘贴到当前编辑区,解决一些网站不能输入密码问题

详细功能请按Tab键查看,如下图类似:

其中的「F: 开启专注模式」效果如下:


应用菜单搜索

按下Hyper M 即可弹出当前应用的所有菜单搜索框, 如下图效果


输入法切换

默认分配了如下快捷键:

快捷键 功能
Hyper C 搜狗拼音输入法
Hyper X ABC

以上快捷键是手动切换, 还可以配置在聚焦指定 APP 窗口后自动切换输入法(同类 APP 可以丢掉了)

输入法切换成功后,右下角会有提示徽标

TODO:

  • Bugfix: 在使用快捷键切换 space 时可能会无法自动切换输入法

按键回显

注:目前暂且实现了简单的按键回显,和 KeyCastr 相比在功能上仍相差甚远,如:

  • 不支持多画布
  • 画布不支持拖拽
  • 缺少动画效果
  • ...

快捷键列表面板

  • 查看当前APP应用的快捷键 任意界面下按 Hyper + S + S 显示/隐藏快捷键列表
  • 查看本项目配置的所有快捷键列表 任意界面下按 Hyper +S + H 显示/隐藏快捷键列表

Hyper组合键重映射

可将系统或三方应用的快捷键映射到 Hyper + 任意组合键, 这样做可以把高频用到的快捷键映射到一组 Hyper的组合键, 可以更方便按下


剪贴板工具

  • 任意界面下按 Hyper V 显示/隐藏 剪贴板面板
  • 可以对剪贴板上的条目内容做一些简单的处理, 还能预览处理结果
    

JSON 格式化转换

  • 任意界面下按 Hyper T 显示/隐藏 JSON 格式化窗口

下班提醒

每天 18:00 提醒下班 (自行修改脚本),鼠标点击可关闭动画


默认快捷键列表

应用启动

快捷键 功能
Hyper . 在同一应用的多个窗口之间切换
Hyper Tab 在不同应用之间的多个窗口切换
Hyper J 切换到上次激活的应用窗口
Hyper Q 打开 QQ
Hyper 8 打开 网易云音乐
Hyper 9 打开 微信
Hyper 0 打开 企业微信
Hyper L 打开 Visual Studio Code
Hyper F 打开 Path Finder
Hyper K 打开 Chrome
Hyper B 打开 Firefo
Hyper A 打开 ApiPost
Hyper D 打开 Dbeaver
Hyper U 打开 FDM
Hyper I 打开 iTerm2

窗口管理

快捷键 功能
Hyper W H 左半屏
Hyper W L 右半屏
Hyper W K 上半屏
Hyper W J 下半屏
Hyper W Y 左上角
Hyper W U 右上角
Hyper W I 左下角
Hyper W O 右下角
Hyper W C 居中
Hyper W M︎ 最大化
Hyper W P 全屏
Hyper W Z 撤销上次窗口操作
Hyper W E 将窗口移动到左侧屏幕
Hyper W N 将窗口移动到右侧屏幕
Hyper W T 将窗口移动到上方屏幕
Hyper W B 将窗口移动到下方屏幕
Hyper W S 将窗口移动到上一个 Space
Hyper W D 将窗口移动到下一个 Space
Hyper W E 扩展窗口尺寸
Hyper W S 收缩窗口尺寸
Hyper W H 窗口移靠屏幕左边缘
Hyper W L 窗口移靠屏幕右边缘
Hyper W J 窗口移靠屏幕上边缘
Hyper W K 窗口移靠屏幕下边缘
Hyper W Y 窗口大小1/4屏幕并移靠屏幕左上角
Hyper W U 窗口大小1/4屏幕并移靠屏幕右上角
Hyper W I 窗口大小1/4屏幕并移靠屏幕左下角
Hyper W O 窗口大小1/4屏幕并移靠屏幕右下角
Hyper W G 同一应用的所有窗口自动网格式布局
Hyper W F 同一应用的所有窗口自动水平均分或垂直均分
Hyper W R 轮切同一应用的所有窗口水平或垂直均分布局
Hyper W X 关闭同一应用所有窗口
Hyper W V 关闭除当前窗口外 同一应用的其他窗口
Hyper W G 同一工作空间下的所有窗口自动网格式布局
Hyper W F 同一工作空间下的所有窗口自动水平均分或垂直均分
Hyper W R 轮切同一工作空间下的所有窗口水平或垂直均分布局

剪贴板工具

快捷键 功能
Hyper V 剪贴板面板开关键
Q quit, 退出
Return 回车确认键直接粘贴到当前应用
S 保存会话, 多次保存会覆盖之前的
R 恢复上次保存的会话(剪贴板第一条内容)
G 默认浏览器中使用 Google搜索或 打开链接
H 在 Github 中搜索
D 保存剪贴板里的内容到桌面
N 使用 neovide 打开
V 使用 VSCode 打开
B Base64 解码
B Base64 编码
U URL 解码
U URL 编码
M 计算 MD5 值
M Markdown 转 HTML
T 去除字符串两边的多余空格和换行

重映射组合键

快捷键 功能
Hyper Y EudicLightPeek 翻译单词
Hyper M Bartender 搜索应用图标并模拟点击
Hyper O BobOCR 图片文字识别
Hyper N Snipaste 截图
Hyper P Snipaste 贴图
Hyper Z 显示桌面
Hyper [ 跳到下一个桌面空间
Hyper ] 跳到上一个桌面空间
, 跳到第一个桌面空间

其他功能模块快捷键

快捷键 功能
Hyper S 显示/隐藏当前应用快捷键列表面板
Hyper C 手动切换到中文输入法
Hyper X 手动切换到英文输入法
Hyper E Emoji 搜索开关键
Hyper T JSON 格式化转换窗口开关键
V 密码粘贴快捷键

关于

关于应用 bundle id

应用的 BundleId,可通过如下方式拿到:

osascript -e 'id of app "Name of App"'

当然你可以直接使用应用的名称, 注意不是中文


关于工程目录结构

.hammerspoon
├── .config                         # 用户本地配置文件
├── .emoji                          # 表情包缓存目录
├──  .gitignore
├──  bin                           # 二进制包目录
│  └──  blueutil                   # 开源蓝牙工具
├──  configs                       # 配置文件目录
│  ├──  applicationConfig.lua      # App 应用快捷启动切换配置
│  ├──  baseConfig.lua             # 基础配置
│  ├──  config.lua                 # 项目入口配置
│  ├──  menu.lua                   # 菜单栏配置
│  ├──  reload.lua                 # 重载本项目
│  ├──  remapingShortcuts.lua      # 自定义按键映射
│  ├──  shortcuts.lua              # 项目主要按键映射配置
│  ├──  windowConfig.lua           # 窗口管理模块的配置
│  └──  winmanShortcuts.lua        # 窗口管理的所有快捷键
├──  icons                         # 图标文件夹
│  ├──  caffeine-off.pdf           
│  └──  caffeine-on.pdf
├──  images                        # 图片文件夹
│  ├──  after-work.png
│  ├──  clipboard.gif
│  ├──  emoji.gif
│  ├──  focusWorkMode.gif
│  ├──  hsheet.png
│  ├──  hsmenuitem.png
│  ├──  inputMethodSwitchBadage.png
│  ├──  istatMenus.png
│  ├──  json.png
│  ├──  keystroke-visualizer.gif
│  ├──  ksheet.png
│  ├──  menu.png
│  ├──  menuChooser.png
│  ├──  superSKey.png
│  ├──  windowman.gif
│  └──  wingrid.gif
├──  init.lua                      # 项目入口文件
├──  install.sh                    # 项目自动安装脚本
├──  LICENSE
├──  modules                       # 各种功能模块
│  ├──  application.lua            # 应用快启快切模块
│  ├──  base.lua                   # 基础工具类模块
│  ├──  caffeine.lua               # 咖啡
│  ├──  clipboardtool.lua          # 剪贴板模块
│  ├──  emoji.lua                  # 聊天发表情模块
│  ├──  hotkeyHelper.lua           # 显示项目所有(部分放不下)按键模块
│  ├──  input-method.lua           # 输入法模块
│  ├──  jsonFormat.lua             # json 格式化工具
│  ├──  keystroke-visualizer.lua   # 按键显示模块
│  ├──  ksheet.lua                 # 查看当前应用快捷键模块
│  ├──  remapingKey.lua            # 按键自定义映射模块
│  ├──  remind.lua                 # 下班提醒模块
│  ├──  status-message.lua         # 右下角显示状态模块
│  ├──  superSCore.lua             # SuperSkey模块实现
│  ├──  superSKey.lua              # SuperSkey模块
│  ├──  systemInfo.lua             # 菜单栏显示系统信息模块
│  ├──  update.lua                 # 自动更新本项目模块
│  ├──  window.lua                 # 窗口管理模块实现
│  └──  winman.lua                 # 窗口管理模块
├──  README.md
├──  Spoons                        # 官方模块库/开源第三方库
│  ├──  ClipShow.spoon
│  ├──  FocusHighlight.spoon
│  ├──  KSheet.spoon
│  ├──  MenuChooser.spoon
│  ├──  ModalMgr.spoon
│  ├──  TilingWindowManager.spoon
│  └──  WinMan.spoon
└──  stylua.toml

关于按键冲突 HS Console 报错

当在 HS 控制台看到的报错类似如下:

ERROR: LuaSkin: This hotkey is already registered. It may be a duplicate in your Hammerspoon config, or it may be registered by macOS. See System Preferences->Keyboard->Shortcuts

这种情况是 多半是和你的 台前调度 快捷键(或其他快捷键)冲突


参考与鸣谢

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.