Surmagic 使用指南

Surmagic 使用指南

surmagic🚀 Command Line Tool to create XCFramework for multiple platforms in one shot!项目地址:https://gitcode.com/gh_mirrors/su/surmagic

---

1. 项目目录结构及介绍

Surmagic 是一个命令行工具，专为简化XCFramework创建流程而生。以下是该开源项目在GitHub上的典型目录结构及其说明：

Your-Project-Directory/
│
├── SM/                        <- Surmagic工作目录，由`surmagic init`命令自动创建
│   └── Surfile                <- 配置文件，用于定义如何构建XCFramework
│
└── ...                       <- 其他项目相关文件或目录

• SM 目录：这个目录是Surmagic操作的核心。它包含了名为Surfile的关键配置文件。
• Surfile 文件：这是一个标准的Plist（XML）格式文件，用于自动化配置Surmagic的工作流程，包括指定输出路径、框架名称、目标操作系统等。

---

2. 项目的启动文件介绍

Surmagic并没有传统的“启动文件”，它的运行基于命令行指令。然而，初始化项目配置的动作可以通过执行以下命令来完成，这可以视作项目“启动”的第一步：

$ surmagic init

这条命令会在你的项目根目录下创建SM目录，并自动生成一个基础的Surfile。从这一刻起，你可以通过编辑这个Surfile并使用其他Surmagic命令来开始构建XCFramework的过程。

---

3. 项目的配置文件介绍

Surfile 配置文件详解

Surfile是Surmagic的心脏，控制着XCFramework构建的每一个细节。其基本结构如下所示：

<dict>
    <key>output_path</key><string>指定的输出目录名</string>
    <key>framework</key><string>目标框架的名称</string>
    <key>targets</key>
        <array>
            <!-- 目标平台的具体配置 -->
            <dict>
                <key>sdk</key><string>目标操作系统如iOS, macOS等</string>
                <key>workspace</key><string>工作的xcworkspace文件名</string>
                <key>scheme</key><string>构建方案的名字</string>
            </dict>
            <!-- 可添加更多针对模拟器或设备的目标配置 -->
        </array>
    <key>finalActions</key><array>...</array> <!-- 构建后的动作，如打开目录 -->
</dict>

• output_path: 输出的XCFramework将会放置的目录。
• framework: 要构建的框架名称。
• targets: 包含了针对不同平台（模拟器、设备）的构建配置数组，每个配置需要指定SDK类型、工作空间路径和构建方案。
• finalActions: 构建完成后可执行的操作列表，例如打开输出目录。

通过编辑Surfile，用户可以灵活地控制XCFramework的构建过程，支持多平台一次性生成，大大提高了开发效率。

---

综上所述，Surmagic通过其独特的目录结构、初始化过程和强大的配置文件Surfile，提供了一种高效的方式来管理和构建跨苹果平台的二进制框架。开发者只需遵循简单的步骤，即可轻松创建适用于多种环境的XCFramework。

surmagic🚀 Command Line Tool to create XCFramework for multiple platforms in one shot!项目地址:https://gitcode.com/gh_mirrors/su/surmagic