Swift 代码格式化工具--SwiftFormat的使用

SwiftFormat
A command-line tool and Xcode Extension for formatting Swift code
用于格式化 Swift代码的一个命令行工具和 Xcode扩展。

前言

之前的工作中,一直都是自己在维护和开发公司的 iOS项目,对于代码格式没有强制要求,但本着严格自律的工作作风,自己在写代码的时候,都是遵守模仿了Swift官方手册的代码风格。而且自己也已经习惯了阅读这种格式的代码。毕竟看着美观啊!

在更换了工作之后,现在的 iOS开发工作已经不是我一个人的战斗。于是问题来了。同事的项目代码并没有准守官方手册的代码风格,而且很多地方看起来就很不规范的样子。在这个方面,公司也没有做出个统一规范。这让我在看同事代码的时候就特别不舒服,有时甚至去主动修改同事的代码格式。如果真的手动去更改整个项目的代码格式风格,显然不现实。于是就萌发了找一个简单易通的 Swift代码格式工具的想法...

最后找个了 SwiftFormat

这次主要解释 Xcode Extension 的安装和使用,可直观较快的解决问题。

安装与设置

SwiftFormat 用于 Xcode扩展的工具,是一个名叫 SwiftFormat for Xcode.app。
推荐使用 Homebrew 命令安装。

brew install swiftformat-for-xcode

也可以去 github releases 页面手动下载 app 的压缩包。
下载地址

3a9e4491441249539fc540ba6bf239c1~tplv-k3u1fbpfcp-watermark.image.png

我们直接在页面选择最新发布版本的 SwiftFormat.for.Xcode.app.zip下载,下载地址

792514b1eb034b368af17987c0b2e4d5~tplv-k3u1fbpfcp-watermark.image.png

下载完成解压,获得 app。并将 app 拖入到左边的应用程序,点击运行。

安全提示可以忽略,直接打开。


458d3195bec04f0bbf9bcb076b4b9c75~tplv-k3u1fbpfcp-watermark.image.png

右上角可选择 Swift语言的版本,默认为自动,可选为自己项目使用的语言版本。

Swift 代码格式的规则为列表中打勾的选项,可不作调整,自行研究每个选的的作用,目前还没有汉化。


33280210b4ab47108be623d32e8e6bc7~tplv-k3u1fbpfcp-watermark.image.png

然后在 系统偏好设置中,找到扩展,勾选 SwiftFormat.for.Xcode 下的选择框,继续查看 Xcode Source Editor 里的选项是否打勾,打勾后就完成了安装设置工作。🎉

使用

SwiftFormat 使用很简单,会在 Editor 菜单下增加一个 SwiftFormat 的选项。


95ba647788b44d049509705bc9d135fd~tplv-k3u1fbpfcp-watermark.image.png

Format Selection 处理选中的代码
Format File 处理当前文件

到这里,安装使用就已经介绍完毕,需要的小伙伴可以上手试一试啦。🎉

目前介绍的是 SwiftFormat界面化的 Xcode扩展,功能直接,能快速处理 Swfit代码格式,另外app 中也提供一些格式化规则的选项,用于自定义化代码格式化。

使用之后,感觉几乎没有什么学习成本,便于大家的代码格式统一化。

最后,如果对命令感兴趣的话,可以了解其命令行工具的使用,可在SwiftFormat的主页 查看介绍。

cocoapods中的使用方式

把脚本放在build phase,会引起的问题就是build之后才整理代码导致breakpoint失效,为了解决这个问题,把执行脚本时机放在pre-action,按下build的时候就会先格式化代码。
(1)pod引入Swift Foramt,Podfile设置如下,然后cd到工程路径,pod install

platform :ios, "11.0"

def app_pods
pod 'SwiftFormat/CLI', '0.40.4'
#  pod 'SwiftFormat/CLI'
end

target 'TestFormat' do
   app_pods
end

(2)Edit sheme->Build->Pre-action->New Run Script Action,添加脚本文件。【target —> Edit Scheme —> Build —> Pre-actioins —> + New Run Script Action】

11893660-f73b51fd0f0a43b2.png
[图片上传中...(11893660-10890503dff6e879.png-e60b27-1636358399987-0)]

11893660-10890503dff6e879.png

脚本文件内容如下:
记得将脚本中的TestFormat(demo中的项目名)换成自己的项目名

if [ "${CONFIGURATION}" = "Debug" ]; then

"${PODS_ROOT}/SwiftFormat/CommandLineTool/swiftformat" --disable unusedArguments,numberFormatting,redundantReturn,andOperator,anyObjectProtocol,trailingClosures,redundantFileprivate --ranges nospace --swiftversion "5.0" "${SRCROOT}/TestFormat/"

echo "format debug build swift code"

else

echo "Not Debug Env, skip format"

fi

(3)写入不规范的代码,按下build(Command + B)进行测试。可以看到代码自动规范化了,再进行building。

// 格式化之前的代码
func test(){

        let isTest = false

        if isTest {

            NSLog("testing")

        }

        else{



        }

    }

}
// 格式化之后的代码
 func test() {
        let isTest = false

        if isTest {

            NSLog("testing")

        } else {}

    }

完整项目地址:https://github.com/jueyi1127/TestFormat

参考链接:https://www.jianshu.com/p/0158144f1fe1
参考链接:https://juejin.cn/post/6911705237266890759

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

推荐阅读更多精彩内容