NIX ZHU
2021-10-19

通过快捷键在 Xcode 中使用 SwiftFormat

安装

步骤如下:

  1. 安装 SwiftFormat for Xcode.app。可直接去其 GitHub 仓库下载安装。如果你使用 Homebrew,也可参考其介绍以安装。装好后记得打开一下此应用,确保有权限使用
  1. 安装此 app 提供的 Xcode Source Editor Extension:
    1. 点击状态栏左上角的 ,打开系统偏好设置,选择扩展
    2. 找到并选中 Xcode Source Editor,然后右边勾选 SwiftFormat
    3. 重新启动一下 Xcode,然后检查 Xcode 的 Editor 菜单底部,应该会出现 SwiftFormat 菜单
  1. 设置针对当前文件的快捷键:
    1. 从 Xcode 的菜单打开 Preferences...,选中 Key Bindings
    2. 在右上的 Filter 里输入 swiftformat,然后选中第二个 SwiftFormat > Format File
    3. 双击高亮行对应 Key 的位置,然后同时按下键盘上的 Shift + Ctrl + I(如果你喜欢其它快捷键可自行选择)
    4. Xcode 16 自带的 swift-format 的快捷键也是 Shift + Ctrl + I,会和上面配置的快捷键发生冲突,你可以把自带的快捷键去除

经过上述步骤,我们就给 Xcode 安装好了 SwiftFormat 的 Source Editor Extension,而且可以用快捷键触发。现在你可以在 Xcode 里随意选中一个 Swift 文件,然后按下快捷键 Shift + Ctrl + I,SwiftFormat 就会根据它当前的规则对这个被选中的 Swift 文件进行代码风格的格式化。如果你的代码经过 Git 管理,应该能看到格式化前后的差异,比如一些空行、逗号、缩进之类

在实践上,比如你在做某个功能,修改了某些 Swift 文件,那就在改动这些文件后,按下快捷键 Shift + Ctrl + I 来格式化代码(必要时再手动做一些微调)。以此,可以循序渐进地改善整体代码的风格

配置

刚才提到规则,你可以打开 SwiftFormat for Xcode.app ,选中第二个 Rules Tab,然后参考 Rules 进行调整

如果你觉得自行配置比较繁琐,那也可以下载 nixzhu.swiftformat,然后在 SwiftFormat for Xcode.app 中,通过菜单 File -> Open... 打开它,即可导入我使用的规则