Swift代码自动格式化--SwiftFormat安装与使用

一、为什么要使用SwiftFormat

我们在作为Git预提交代码之前对其格式进行自动化,确保代码规范,有助于提高code review的效率,对比了几款针对Swift代码的自动格式化,发现SwiftFormat超越了您对代码格式化程序的期望。除了调整空格之外,它还可以插入或删除implicit self,删除多余的括号,并纠正许多其他与标准Swift习惯用法的偏差。


二、如何安装SwiftFormat

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

brew install swiftformat
安装 SwiftFormatXcode插件:
  • 打开终端输入brew install --cask swiftformat-for-xcode,如【终端.jpg】图标1处,出现2表示安装成功;
  • 然后执行open "/Applications/SwiftFormat For Xcode.app" ,如3
    终端.jpg

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

image.png

注意:你可以会遇到打开Xcode没看到SwiftFormat
  • 这个时候注意一下SwiftFormat -> about中的提示:How do I install it?
    image.jpg
  • 打开系统偏好设置,点开扩展勾选上Xcode Source Editor,再重启Xcode就可以看到了。
    image.jpg

操作到这里,我们的代码就可以用SwiftFormat -> Formar File菜单来对其进行格式化了。但是每次手动并不是我们想要的最终方案,我们希望操作可以再简化点:保存代码的同时就自动对代码进行格式化~~~


三、使用 Automator 添加自动化脚本

Automator是一款系统软件,中文名是自动操作。文件路径:启动台 -> 其他,你也可以全局搜索🔍来找到。

image.png

1、打开Automator,选择快速操作(Quick Action):

image.png

2、在搜索栏搜索Script,双击 选择 运行 AppleScript
image.png

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

该脚本将执行以下操作:

  • 检查XcodeEditor菜单下是否存在SwiftFormat -> Format File菜单项;
  • 如果存在,则自动触发 Format File菜单点击,来格式化代码;
  • 最后,自动点击 Save 菜单,保存文件修改。

4、点击Build按钮,里面的代码会自动高亮:

image.png

5、接着修改 【工作流程收到】 这一项配置为【 没有输入】,【位于】改成 Xcode.app。
image.png

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

image.png

四、添加键盘快捷键

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

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

image.png

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

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

image.png

到这里,我们在Xcode中保存(⌘ + SSwift文件的时候,就会自动触发代码格式化了,非常nice ~~~


参考 Xcode Format and Save using SwiftFormat and Automator

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

推荐阅读更多精彩内容