SwiftGen 使用教程

SwiftGen 使用教程

SwiftGenThe Swift code generator for your assets, storyboards, Localizable.strings, … — Get rid of all String-based APIs!项目地址:https://gitcode.com/gh_mirrors/sw/SwiftGen

项目介绍

SwiftGen 是一个用于自动生成资源代码的工具，它可以帮助开发者从字符串到强类型标识符的转换。SwiftGen 支持多种资源类型，包括图片、字体、故事板、本地化字符串等。通过使用 SwiftGen，开发者可以避免在运行时因资源引用错误导致的崩溃，并且可以根据需要自定义生成代码的模板。

项目快速启动

安装 SwiftGen

推荐使用 Homebrew 进行安装：

brew update
brew install swiftgen

配置和使用 SwiftGen

1. 在项目根目录下创建一个 swiftgen.yml 配置文件：

swiftgen config init

2. 编辑 swiftgen.yml 文件，配置需要解析的资源类型和路径。例如：

input_dir: Resources
output_dir: Generated
strings:
  inputs: en.lproj/Localizable.strings
  outputs:
    templateName: structured-swift5
    output: Strings.swift

3. 运行 SwiftGen：

swiftgen

应用案例和最佳实践

案例一：图片资源管理

使用 SwiftGen 管理图片资源，可以生成强类型的图片引用，避免字符串硬编码：

// 生成代码示例
let image = Asset.icon_return.image

案例二：字体管理

使用 SwiftGen 管理字体资源，可以生成强类型的字体引用：

// 生成代码示例
let font = FontFamily.SanFranciscoDisplay.semibold.font(size: 18)

最佳实践

• 版本控制：将生成的代码文件纳入版本控制，确保团队成员使用一致的资源引用。
• 自定义模板：根据项目需求，自定义生成代码的模板，以符合项目规范。

典型生态项目

R.swift

R.swift 是另一个用于自动生成资源代码的工具，与 SwiftGen 类似，但它提供了更全面的资源管理功能。适合新项目引入并进行全局资源管理。

CocoaPods

SwiftGen 可以通过 CocoaPods 进行集成，虽然它不是一个运行时依赖库，但通过 CocoaPods 安装可以简化管理和更新流程。

pod 'SwiftGen'

通过以上步骤，您可以快速上手并使用 SwiftGen 管理项目中的资源，提高开发效率和代码质量。

SwiftGenThe Swift code generator for your assets, storyboards, Localizable.strings, … — Get rid of all String-based APIs!项目地址:https://gitcode.com/gh_mirrors/sw/SwiftGen