SwiftGen 自动生成资源代码

简介: SwiftGen 自动生成资源代码

对比


在 github 上有两个比较好用的库  R.Swift  和  SwiftGen,都很好的解决了从 字符串Strongly typed identifiers 的自动工作。

  • SwiftGen 相对来说依赖少一点,可配置空间更大,适合老项目引入并资源局部管理。
  • R.Swift 配置简单且管理全面,适合新项目引入并资源全局管理。

最终的使用效果如下:

// SwiftGen
let image = Asset.icon_return.image
let font = FontFamily.SanFranciscoDisplay.semibold.font(size: 18)
// R.Swift
let image = R.image.icon_return()
let font = R.font.sanFrancisco(size: 18)


安装


官方新版本推荐通过 brew 进行安装。

实测下来,也是 brew 安装问题最少,下载二进制包有权限问题,pod 集成有找不到 SwiftGen 的情况,别问我是怎么知道的...

brew update
brew install swiftgen


使用


基础:生成代码

在项目根目录下,创建 Templates 文件夹,将下面的模板文件放入其中。

Xcassets.stencil 和 Fonts.stencil 上传到 Github 了,地址:github.com/ReverseScal…

Xcode 中添加一个 New Run Script Phase,将 Run Script 拖动到 Check Pods Manifest.lock 的下面,脚本内容如下,其中 ZGERPHomeModule 和路径需要根据项目调整:

swiftgen run xcassets $PROJECT_DIR/../ZGERPHomeModule/Assets/Media.xcassets --templatePath $PROJECT_DIR/../Templates


image.png


如需使用第三方字体,可以同时设置字体脚本。

swiftgen run fonts $PROJECT_DIR/../ZGERPHomeModule/Assets/ --templatePath $PROJECT_DIR/../Templates/Fonts.stencil --param bundleName=ZGERPHomeModule --output $PROJECT_DIR/../ZGERPHomeModule/Classes/SwiftGen/Fonts.swift

Command + B/R 脚本会根据模块中 Media.xcassets 中的资源,自动生成对应代码。


image.png


// SwiftGen xcassets template for Asprin
import UIKit
enum Asset {
  static let closedIcon = ImageAsset(name: "closed_icon")
  static let iconReturn = ImageAsset(name: "icon_return")
}
struct ImageAsset {
    fileprivate var name: String
    var image: UIImage {
        let bundle = ZGERPModuleAssets.currentBundle()
        let image = UIImage(named: name, in: bundle, compatibleWith: nil)
        guard let result = image else { 
            fatalError("Unable to load image named \(name).") 
        }
        return result
    }
}
class ZGERPModuleAssets: NSObject {
    /// 获取当前库包
    internal class func currentBundle() -> Bundle {
        let podBundle = Bundle(for: ZGERPHomeModule.self)
        if let bundleURL = podBundle.url(forResource: "ZGERPHomeModule", withExtension: "bundle") {
            if let bundle = Bundle(url: bundleURL) {
                return bundle
            } else {
                return podBundle
            }
        } else {
            return podBundle
        }
    }
}


进阶:生成 xcassets 文件

上面我们通过 xcassets 文件中的资源自动生成了引入代码,但是设计师小姐姐给到我们的素材都是 xxx@2x.pngxxx@3x.png 这个样子滴,如果能自动生成 xcassets 文件就好了。


image.png


1)让我在上面的 Script 文件夹下,再添加下面这个文件(上面提到的 Github 中有滴)。

2)在跟目录下创建配套的 ImageFolder,ImageFolderBackup 和 Resource 文件夹。

Demo
- Templates
 - AutoAsset // 二进制脚本
 - Fonts.stencil // 字体模板
 - Xcassets.stencil // 图片模板
- ImageFolder // 图片文件夹
- ImageFolderBackup // 图片备份文件夹
- Resource // 输出路径

3)还是我们熟悉的添加脚本。

$PROJECT_DIR/script/AutoAsset $PROJECT_DIR/synchronizeImageFolder $PROJECT_DIR/synchronizeImageFolder_backup $PROJECT_DIR



image.png


4)如果要配合自动生成代码,就继续在下面添加脚本。

$PODS_ROOT/SwiftGen/bin/swiftgen  xcassets $PROJECT_DIR/ResourceManageDemo/Assets.xcassets --templatePath $PROJEC


image.png


同时可以编写 Podfile 文件,把 Xcode Build Phases 加入。

source 'https://cdn.cocoapods.org/'
use_frameworks!
inhibit_all_warnings!
platform :ios, '9.0'
target 'Demo' do
  pod 'SwiftGen'
  script_phase :name => '[CP-User] Create Xcassets', :script => '$PROJECT_DIR/Script/AutoAsset $PROJECT_DIR/ImageFolder $PROJECT_DIR/ImageFolderBackup $PROJECT_DIR/Resource/Assets.xcassets', :execution_position => :before_compile
end

SwiftGen 生成的产物,可以运行 swiftgen config lint 进行校验。

Linting swiftgen.yml
> Common parent directory used for all input paths:  <none>
> Common parent directory used for all output paths: <none>
> 1 entry for command xcassets:
$ swiftgen xcassets --templateName swift4 --output UIImage+Assets.swift Media.xcassets


目录
相关文章
|
前端开发 Java
前端基础 - 常用调试方式
前端基础 - 常用调试方式
83 0
|
8月前
|
人工智能 测试技术 开发者
大模型自动生成并运行代码的体验与优化
随着近两年大模型的不断发展,它们在各个领域展示出了惊人的能力,可以说是在各个领域到了“开花结果”的阶段。比如最近技术圈比较火的阿里云的通义千问已经可以自己写代码、跑代码了,作为开发者,我觉得这种能力不仅提高了开发效率,还推动了编程实践向更高层次的转变和发展。但是,在使用大模型自动生成代码时,我们也会面临一些挑战,其中之一是代码可能会曲解开发者的需求。那么本文就来分享一下个个人的体验以及如何优化这种情况。
824 2
大模型自动生成并运行代码的体验与优化
|
8月前
|
C# Python
如何让 StyleCop 忽略 refit 自动生成的代码
创建自定义规则:我们需要创建一个自定义规则,该规则将用于排除特定类型的代码,我们可以创建一个自定义规则,用于检查类名是否以大写字母开头,然后忽略符合此规则的代码。
|
XML JSON 前端开发
前后端自动生成代码工具
前后端自动生成代码工具
303 0
|
监控 程序员 编译器
代码的调试技巧
代码的调试技巧
|
Java 开发工具 C#
如何以超快的方式调试?
如何以超快的方式调试?
|
前端开发 JavaScript 数据可视化
使用API自动生成工具优化前端工作流
本文介绍的一个工具(或者说方法),来将这个工作流优化一下,也是我平时工作正在用的方法,当做自己的笔记,也跟大家一起分享一下~ 这个方法的主要思路就是开发人员在某个api工具中按要求填好文档,然后导出swagger.json配置文件,再把这个配置文件导入到easy-mock中,再用工具自动生成前端api的js文件以供调用。
使用API自动生成工具优化前端工作流
|
机器学习/深度学习 SQL 移动开发
逻辑代码自动生成相关技术概述
如何有效地提高软件开发的效率和质量,一直是软件工程领域关心的问题。其中, 程序自动生成技术被认为是提高软件开发自动化程度和最终质量的重要方法,受到学术界和工业界的广泛关注。程序自动生成技术指利用某些技术自动地为软件生成源代码,达到根据用户的需求机器自动编程的目的。极大程度地减轻了程序员的开发负担, 使得程序员可以更加关注于业务价值赋能。
逻辑代码自动生成相关技术概述