Swift代码自动格式化

1. 安装SwiftFormat

什么是SwiftFormat

SwiftFormat 是一款用来格式化Swift代码的命令行工具。

我们可以直接用 Homebrew 来安装它，已经安装的同学可以忽略这一步：

brew install swiftformat

然后安装 swiftformat 的 Xcode 插件:

brew install --cask swiftformat-for-xcode
open "/Applications/SwiftFormat For Xcode.app"

打开 SwiftFormat For Xcode.app 后，会自动安装到Xcode上，需要重启Xcode才能生效。重新打开Xcode，在 Xcode的 Editor 目录下能看到 SwiftFormat 菜单就说明插件安装成功了。

image.png

这里，我们可以手动选择 Format File 菜单来格式化当前文件。 但是还是不够方便，如果能做到像Flutter开发一样，保存文件的时候，自动格式化代码就好了。

2. 使用 Automator 添加自动化脚本

Automator是一款系统软件，中文名是自动操作。

image.png

打开Automator，选择快速操作(Quick Action)：

image.png

然后在搜索栏搜索 Script，双击 选择 运行 AppleScript ：

image.png

然后用下面的脚本代码替换上图中的脚本：

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
复制代码

该脚本将执行以下操作：

1. 检查Xcode中Editor菜单下是否存在“SwiftFormat”>“Format File”菜单项。
2. 如果存在，则自动触发 Format File菜单点击，来格式化代码。
3. 最后，自动点击 Save 菜单，保存文件修改。

点击Build按钮，里面的代码会自动高亮：

image.png

然后，修改 工作流程收到 这一项配置为 没有输入，位于这里改成 Xcode。

image.png

最后 ⌘ + S 保存，将该自动操作命名为 XcodeFormatAndSave，它会自动保存在 ~/Library/Services/ 目录下。重新打开Xcode，我们将在 Xcode -> Services 菜单下看到它，但是目前它还是不能工作的，还需要进一步配置。

[图片上传失败...(image-9041b2-1637922491632)]

3. 添加键盘快捷键

我们最终的目标是要在保存文件(⌘ + S)的时候，自动进行代码格式化。

打开 系统偏好设置 -> 键盘 -> 快捷键，选择 左侧 App快捷键 这一项，添加一个新的快捷键，应用程序选择 Xcdoe，菜单标题和刚才保存的自动操作名称一样：XcodeFormatAndSave，键盘快捷键设置成 ⌘ + S，然后点击 添加 按钮。

image.png

最后，我们还需要为它配置运行权限，不然会报错。

打开 系统偏好设置 -> 安全性与隐私 -> 隐私，在左侧列表中选择 辅助功能，授予 Xcode 控制权限。

[图片上传失败...(image-65a4e3-1637922491632)]

这样，在Xcode中保存（⌘ + S）Swift文件的时候，就会自动触发代码格式化了，非常的舒适~。