SwiftGen 在 Swift5 + SwiftUI 下的配置方案

GitHub 链接:SwiftGenConfigForSwiftUI

使用环境

  • Swift 5
  • SwiftUI
  • 不使用 storyboard 和 xib
  • 不勾选 Use Base Internationalization
  • 本地化(默认英语)

已验证适配部分

  • String 资源
  • xcassets 图片资源
  • xcassets 颜色资源

安装

brew install swiftgen

配置

配置文件

配置文件下载位置:config files

将三个配置文件放置在项目根目录下:

  • swiftgen.yml:SwiftGen 配置文件
  • swiftui-assets-template.stencil:与 SwiftUI 适配的 xcassets 模板
  • swiftui-strings-template.stencil:与 SwiftUI 适配的 String 模板

项目结构参考:

${PROJECT}
├── swiftgen.yml
├── swiftui-assets-template.stencil
├── swiftui-strings-template.stencil
└── ${PROJECT}
    ├── Generated
    ├── Resources
    │   ├── Color.xcassets
    │   ├── Image.xcassets
    │   └── Localizable.strings
    ├── App.swift
    ├── ContentView.swift
    ├── Info.plist
    ├── InfoPlist.strings
    ├── ${PROJECT}.entitlements
    └── Preview Content

添加编译脚本

  1. 点击导航栏的项目文件
  2. 选择 TARGETS - Build Phases
  3. 点击窗口左上角 + 按钮,选择 New Run Script Phase
  4. 添加一句脚本
swiftgen

生成索引辅助类

  1. ⌘B 执行项目编译
  2. 左侧文件导航栏中右键:Add Files to …
  3. 选择在 Generated 目录下生成的文件,添加到项目中即可(不要勾选复制)

在 SwiftUI 中使用

Image(Asset.Image.image_name.name) // 图片类资源
Text(L10n.text_name.key) // 文本类资源
    .foregroundColor(
        Asset.Color.color_name.color // 颜色资源
    )

L10n.text_name.text // 返回 String 类型
Asset.Color.color_name.nsColor // 返回 NSColor 类型
Asset.Color.color_name.uiColor // 返回 UIColor 类型

其他

配置文件语法参考:
SwiftGen/ConfigFile.md at stable · SwiftGen/SwiftGen · GitHub

关于对 SwiftUI(LocalizedStringKey) 提供支持的讨论:
SwiftUI use of LocalizedStringKey · Issue #685 · SwiftGen/SwiftGen · GitHub

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

推荐阅读更多精彩内容