Project Icon

XcodeGen

自动生成 Xcode 项目的轻量级命令行工具

XcodeGen 是一个基于 Swift 的命令行工具,通过解析文件夹结构和项目配置文件来生成 Xcode 项目。它支持多平台开发、自定义构建设置和自动生成 scheme 等功能,有助于解决版本控制中的合并冲突问题。开发者可使用 YAML 或 JSON 格式的配置文件来定义项目结构,简化复杂项目的管理流程。XcodeGen 适用于各类 iOS、macOS 等 Apple 平台的项目开发,能提升团队协作效率。

XcodeGen

Swift Package Manager Platforms Swift Versions

XcodeGen

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

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

  • ✅ 按需生成项目并从 git 中移除 .xcodeproj,这意味着不再有合并冲突
  • ✅ Xcode 中的组和文件始终与磁盘上的目录保持同步
  • ✅ 易于配置的项目,具有人类可读性并且 git 友好
  • ✅ 轻松复制和粘贴文件和目录,无需在 Xcode 中编辑任何内容
  • ✅ 通过构建设置组在多个目标间共享构建设置
  • ✅ 自动为不同环境(如测试和生产)生成方案
  • ✅ 轻松创建新项目,无需在 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]

将创建一个包含两个相互连接的目标的项目,并包含所有必要的配置和构建设置。有关可以指定的所有选项,请参阅项目规范文档,更多常规文档请参阅使用说明

安装

首先确保安装了最新的稳定版(非测试版)Xcode。

Mint

mint install yonaskolb/xcodegen

Make

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

Homebrew

brew install xcodegen

Swift Package Manager

作为 CLI 使用

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

作为依赖使用

在你的 Package.swift 文件的依赖项中添加以下内容:

.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 中运行时传递任何必需的参数,可以编辑方案以包含启动参数。

文档

  • 查看项目规范文档,了解所有可以设置的各种属性和选项
  • 查看使用说明,了解更具体的使用方法和用例文档
  • 查看常见问题,了解一些常见问题的列表
  • 查看示例,了解一些实际使用的 XcodeGen 项目规范

替代方案

如果 XcodeGen 不能满足你的需求,可以尝试这些优秀的替代方案:

致谢

本工具由以下项目提供支持:

本工具的灵感来自:

贡献

欢迎提交拉取请求和问题。请为 bug、功能或文档开启任何问题和拉取请求。

许可证

XcodeGen 在 MIT 许可下授权。更多信息请查看 LICENSE

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号