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文件的时候,就会自动触发代码格式化了,非常的舒适~。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容