XcodeGen

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

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

• ✅ 按需生成项目，并从 git 中移除你的 .xcodeproj，这意味着 不再有合并冲突！
• ✅ Xcode 中的组和文件始终与磁盘上的目录同步
• ✅ 项目的轻松配置，它既人性化又对 git 友好
• ✅ 轻松复制和粘贴文件和目录，而无需在 Xcode 中进行任何编辑
• ✅ 通过构建设置组在多个 targets 之间共享构建设置
• ✅ 为不同的环境（如测试和生产）自动生成 Schemes
• ✅ 轻松创建新项目，即使是复杂的设置，也可以按需创建，而无需在 Xcode 中折腾
• ✅ 从任何地方生成，包括在 CI 上
• ✅ 在多个文件之间分发你的规范，以便于共享和覆盖
• ✅ 轻松创建多平台框架
• ✅ 无需任何操作即可集成 Carthage 框架
• ✅ 导出依赖关系图以在 Graphviz 中查看

给定一个示例项目规范

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 个连接的 targets，以及所有必需的配置和构建设置。请参阅 Project Spec 文档，了解你可以指定的所有选项，以及 Usage 文档，了解更多通用文档。

首先确保已安装 Xcode 11。

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.35.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 查看更详细的用法信息。

xcodegen dump --type graphviz

xcodegen dump --type graphviz --file Graph.viz

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

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

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

• 请参阅 Project Spec 文档，了解可以设置的所有各种属性和选项
• 请参阅 Usage 文档，了解更具体的用法和用例文档
• 请参阅 FAQ，查看一些常见问题的列表
• 请参阅 Examples，查看一些实际应用中的 XcodeGen 项目规范

如果 XcodeGen 不能满足你的需求，请尝试这些优秀的替代方案

• Tuist
• Xcake
• struct

此工具由以下项目驱动

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

此工具的灵感来自

• struct
• Xcake
• CocoaPods Xcodeproj

欢迎提交 Pull requests 和 issues。请针对 bugs、功能或文档打开任何 issues 和 PRs。

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