XcodeGen

XcodeGen 是一个用 Swift 编写的命令行工具，它使用您的文件夹结构和一个项目规范来生成您的 Xcode 项目。

项目规范是一个 YAML 或 JSON 文件，用于定义您的 targets、配置、scheme、自定义构建设置和许多其他选项。 您的所有源目录都会被自动解析并以适当的方式引用，同时保留您的文件夹结构。 在许多地方都使用了合理的默认值，因此您只需自定义需要的设置。 非常复杂的项目也可以使用更高级的功能来定义。

• ✅ 按需生成项目，并将您的 .xcodeproj 从 git 中移除，这意味着 不再有合并冲突！
• ✅ Xcode 中的组和文件始终与磁盘上的目录同步
• ✅ 项目的 配置 简单易行，并且对人类可读，对 git 友好
• ✅ 可以轻松地复制和粘贴 文件和目录，而无需在 Xcode 中进行任何编辑
• ✅ 使用 构建设置组 在多个 target 之间共享构建设置
• ✅ 自动为 不同环境（如测试和生产）生成 Scheme
• ✅ 可以随时 创建新的项目，这些项目具有复杂的设置，而无需在 Xcode 中进行繁琐的操作
• ✅ 从任何地方生成，包括在 CI 上
• ✅ 在多个文件中分发您的规范，以便于 共享 和覆盖
• ✅ 轻松创建 多平台 框架
• ✅ 集成 Carthage 框架，无需任何额外工作

给定一个示例项目规范

name: MyProject
include:
  - base_spec.yml
options:
  bundleIdPrefix: com.myapp
packages:
  Yams:
    url: https://github.com/jpsim/Yams
    from: 2.0.0
targets:
  MyApp:
    type: application
    platform: iOS
    deploymentTarget: "10.0"
    sources: [MyApp]
    settings:
      configs:
        debug:
          CUSTOM_BUILD_SETTING: my_debug_value
        release:
          CUSTOM_BUILD_SETTING: my_release_value
    dependencies:
      - target: MyFramework
      - carthage: Alamofire
      - framework: Vendor/MyFramework.framework
      - sdk: Contacts.framework
      - sdk: libc++.tbd
      - package: Yams
  MyFramework:
    type: framework
    platform: iOS
    sources: [MyFramework]

将创建一个包含 2 个连接的 target 的项目，其中包含所有必需的配置和构建设置。 有关您可以指定的所有选项，请参阅 项目规范 文档，有关更常规的文档，请参阅 用法。

首先确保已安装最新稳定（非 beta）版本的 Xcode。

mint install yonaskolb/xcodegen

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
make install

brew install xcodegen

用作 CLI

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
swift run xcodegen

用作依赖

将以下内容添加到您的 Package.swift 文件的 dependencies 中

.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.42.0"),

然后在需要的地方导入：import XcodeGenKit

只需运行

xcodegen generate

这将在当前目录中查找名为 project.yml 的项目规范，并生成一个 Xcode 项目，其名称在规范中定义。

选项

• --spec: 指向 .yml 或 .json 项目规范的可选路径。 默认为 project.yml。（也可以通过逗号分隔符链接到多个规范文件。 请注意，所有其他标志都将相同。）
• --project: 指向将要生成项目的目录的可选路径。 默认情况下，这是规范所在的目录。
• --quiet: 抑制信息和成功消息。
• --use-cache: 用于防止不必要地生成项目。 如果设置了此项，则会在生成项目时写入缓存文件。 如果稍后运行 xcodegen，但规范及其包含的所有文件都相同，则不会生成项目。
• --cache-path: 用于缓存文件的自定义路径。 默认为 ~/.xcodegen/cache/{PROJECT_SPEC_PATH_HASH}

还有其他命令，例如 xcodegen dump，它允许以多种不同的格式输出已解析的规范，或将其写入文件。 使用 xcodegen help 查看更详细的用法信息。

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
swift package generate-xcodeproj

这使用 Swift Package Manager 创建一个 xcodeproj 文件，您可以在 Xcode 中打开、编辑和运行该文件，这使得编辑任何代码更容易。

如果要在 Xcode 中运行时传递任何必需的参数，您可以编辑 scheme 以包含启动参数。

• 有关可以设置的所有各种属性和选项，请参阅 项目规范 文档
• 有关更具体的用法和用例文档，请参阅 用法
• 有关一些常见问题的列表，请参阅 FAQ
• 有关一些真实的 XcodeGen 项目规范，请参阅 示例

如果 XcodeGen 不能满足您的需求，请尝试这些出色的替代方案

• Tuist
• Xcake
• struct

此工具由以下组件提供支持

• XcodeProj
• JSONUtilities
• Spectre
• PathKit
• Yams
• SwiftCLI

此工具的灵感来自

• struct
• Xcake
• CocoaPods Xcodeproj

欢迎提出 pull 请求和 issue。 请针对错误、功能或文档打开任何 issue 和 PR。

XcodeGen 在 MIT 许可下获得许可。 有关更多信息，请参阅 LICENSE。