一、为什么要使用SwiftFormat
我们在作为Git
预提交代码之前对其格式进行自动化,确保代码规范,有助于提高code review
的效率,对比了几款针对Swift
代码的自动格式化,发现SwiftFormat超越了您对代码格式化程序的期望。除了调整空格之外,它还可以插入或删除implicit self
,删除多余的括号,并纠正许多其他与标准Swift
习惯用法的偏差。
二、如何安装SwiftFormat
我们可以直接用 Homebrew 来安装它,已经安装的同学可以忽略这一步:
brew install swiftformat
安装 SwiftFormat
的 Xcode
插件:
- 打开终端输入
brew install --cask swiftformat-for-xcode
,如【终端.jpg】图标1
处,出现2
表示安装成功; - 然后执行
open "/Applications/SwiftFormat For Xcode.app"
,如3
。
打开 SwiftFormat For Xcode.app
后,会自动安装到Xcode
上,需要重启Xcode
才能生效。重新打开Xcode
,在 Xcode
的 Editor
目录下能看到 SwiftFormat
菜单就说明插件安装成功了。
注意:你可以会遇到打开Xcode
没看到SwiftFormat
- 这个时候注意一下
SwiftFormat -> about
中的提示:How do I install it?
- 打开系统偏好设置,点开扩展勾选上
Xcode Source Editor
,再重启Xcode
就可以看到了。
操作到这里,我们的代码就可以用SwiftFormat -> Formar File
菜单来对其进行格式化了。但是每次手动并不是我们想要的最终方案,我们希望操作可以再简化点:保存代码的同时就自动对代码进行格式化~~~
三、使用 Automator
添加自动化脚本
Automator
是一款系统软件,中文名是自动操作。文件路径:启动台 -> 其他,你也可以全局搜索🔍来找到。
1、打开Automator
,选择快速操作(Quick Action
):
2、在搜索栏搜索
Script
,双击 选择 运行 AppleScript
:3、用下面的脚本代码替换上图中的脚本:
on run {input, parameters}
tell application "System Events"
tell process "Xcode"
set frontmost to true
if menu item "Format File" of menu of menu item "SwiftFormat" of menu "Editor" of menu bar 1 exists then
click menu item "Format File" of menu of menu item "SwiftFormat" of menu "Editor" of menu bar 1
end if
click menu item "Save" of menu "File" of menu bar 1
end tell
end tell
return input
end run
该脚本将执行以下操作:
- 检查
Xcode
中Editor
菜单下是否存在SwiftFormat -> Format File
菜单项; - 如果存在,则自动触发
Format File
菜单点击,来格式化代码; - 最后,自动点击
Save
菜单,保存文件修改。
4、点击Build
按钮,里面的代码会自动高亮:
5、接着修改 【工作流程收到】 这一项配置为【 没有输入】,【位于】改成 Xcode.app。
6、最后⌘ + S
保存,将该自动操作命名为 XcodeFormatAndSave
,它会自动保存在 ~/Library/Services/
目录下。重新打开Xcode
,我们将在 Xcode -> Services
菜单下看到它,但是目前它还是不能工作的,还需要进一步配置。
四、添加键盘快捷键
我们最终的目标是要在保存文件(⌘ + S
)的时候,自动进行代码格式化。
打开 系统偏好设置 -> 键盘 -> 快捷键
,选择 左侧 App快捷键
这一项,添加一个新的快捷键,应用程序选择 Xcdoe
,菜单标题和刚才保存的自动操作名称一样:XcodeFormatAndSave
,键盘快捷键设置成 ⌘ + S
,然后点击 添加
按钮。
最后,我们还需要为它配置运行权限,不然会报错。
打开 系统偏好设置 -> 安全性与隐私 -> 隐私
,在左侧列表中选择 辅助功能
,授予 Xcode
控制权限。
到这里,我们在Xcode
中保存(⌘ + S
)Swift
文件的时候,就会自动触发代码格式化了,非常nice ~~~