SwiftGen项目配置文件详解：从入门到精通-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00869/article/details/148418617

SwiftGen项目配置文件详解：从入门到精通

什么是SwiftGen配置文件

SwiftGen是一款强大的代码生成工具，它能够自动将项目中的资源文件（如图片、字符串、字体等）转换为类型安全的Swift代码。而配置文件则是SwiftGen工作的核心，它告诉SwiftGen应该处理哪些文件、使用什么模板以及生成的代码应该放在哪里。

创建配置文件

快速初始化

对于初学者来说，最简单的创建配置文件的方法是使用命令行工具：

swiftgen config init

这个命令会在当前目录下创建一个名为swiftgen.yml的示例配置文件，其中包含了各种常见场景的配置示例（以注释形式存在）。你只需要取消注释你需要的部分，并根据项目实际情况进行修改即可。

手动创建

当然，你也可以使用任何文本编辑器手动创建这个YAML格式的配置文件。YAML是一种对人类友好的数据序列化标准，它比JSON更简洁易读（但JSON格式也被支持，因为JSON是YAML的子集）。

配置文件结构详解

全局配置

配置文件采用层级结构，最外层可以包含以下全局配置项：

input_dir: Sources/Resources  # 所有输入路径的前缀
output_dir: Sources/Generated/  # 所有输出路径的前缀

input_dir：为所有输入路径指定一个公共前缀，避免重复书写相同的路径
output_dir：为所有输出文件指定一个公共目录，保持生成文件的组织性

解析器配置

SwiftGen支持多种资源类型的解析，每种类型对应一个配置块：

strings:  # 字符串资源
  inputs: Base.lproj
  filter: .+\.strings$  # 正则表达式过滤
  outputs:
    - templateName: structured-swift5
      output: L10n-Constants.swift

xcassets:  # 资源目录
  - inputs: Logos.xcassets
    outputs:
      - templateName: swift5
        output: Logos-Constants.swift
        params:
          enumName: Logos

每种解析器配置可以包含以下子项：

inputs：指定输入文件或目录（可以是单个路径或路径数组）
filter：使用正则表达式过滤输入文件（可选）
outputs：定义输出配置（可以多个）

输出配置详解

每个输出配置必须包含以下内容：

outputs:
  - templateName: swift5  # 使用内置模板
    output: GeneratedFile.swift  # 输出文件路径
    params:  # 模板参数（可选）
      enumName: CustomEnum

或者：

outputs:
  - templatePath: custom/template.stencil  # 使用自定义模板
    output: GeneratedFile.swift

关键点：

必须指定templateName（内置模板）或templatePath（自定义模板）之一
output是必需的，指定生成文件路径
params是可选的，用于向模板传递额外参数

高级技巧

使用环境变量

配置文件支持环境变量插值，这在Xcode集成中特别有用：

strings:
  inputs: ${PROJECT_DIR}/${TARGET_NAME}/Resources/
  outputs:
    templateName: structured-swift5
    output: ${PROJECT_DIR}/${TARGET_NAME}/Constants/Strings-${TARGET_NAME}.swift

正则表达式过滤

当需要精确控制处理的文件时，可以使用正则表达式过滤：

filter: .+\.strings$  # 只处理.strings结尾的文件

正则表达式要点：

.+匹配一个或多个任意字符
\.匹配字面量点（需要转义）
$确保匹配到文件结尾

多输出配置

同一组输入文件可以生成多个输出：

strings:
  inputs: Localizable.strings
  outputs:
    - templateName: structured-swift5
      output: Strings-Structured.swift
    - templateName: flat-swift5
      output: Strings-Flat.swift