Swift Package Manager 开发环境搭建与贡献指南

Swift Package Manager 开发环境搭建与贡献指南

swift-package-manager The Package Manager for the Swift Programming Language 项目地址: https://gitcode.com/gh_mirrors/sw/swift-package-manager

项目概述

Swift Package Manager（简称 SwiftPM）是苹果官方提供的 Swift 语言包管理工具，用于管理 Swift 代码的分发和依赖关系。作为 Swift 生态系统的核心组件，它支持创建、构建、测试和运行 Swift 包。

开发环境配置

Xcode 开发环境（推荐）

1. 安装最新版 Xcode：确保安装最新稳定版或测试版 Xcode
2. 验证安装：打开终端执行 xcode-select -p 确认路径正确
3. 打开项目：直接打开 SwiftPM 的 Package.swift 文件
4. 构建与测试：
   • 首先构建 SwiftPM-Package scheme
   • 然后可以运行其他 scheme 进行测试

命令行开发环境

工具链安装

1. macOS 用户：

   export TOOLCHAINS=swift
   xcrun --find swift  # 验证路径
   swift --version     # 验证版本
   

2. Linux 用户：

   export PATH=/path/to/swift-toolchain/usr/bin:"${PATH}"
   which swift         # 验证路径
   swift --version     # 验证版本
   

使用 swiftly 工具

swiftly 是 Swift 工具链管理工具，可以自动安装和管理所需版本：

swiftly install    # 安装工具链
swift build        # 构建项目
swift test         # 运行测试

本地开发流程

构建项目

执行基础构建命令：

swift build

构建成功后会在 .build/ 目录生成二进制文件，结构如下：

.build/
├── artifacts
├── checkouts
├── debug
├── repositories
└── x86_64-apple-macosx  # 平台相关目录

测试新构建的 SwiftPM

mkdir /tmp/hello && cd /tmp/hello
/path/to/swiftpm/.build/x86_64-apple-macosx/debug/swift-package init
/path/to/swiftpm/.build/x86_64-apple-macosx/debug/swift-build

测试策略

1. 运行全部测试：

   swift test
   

2. 运行单个测试：

   swift test --filter PackageGraphTests.DependencyResolverTests/testBasics
   

3. 选择性测试：

   swift test --filter BuildTests --skip BuildPlanTests --filter WorkspaceTests --skip InitTests
   

4. 性能测试：

   export TSC_ENABLE_PERF_TESTS=1
   swift test -c release --filter PerformanceTests
   

高级开发场景

使用自定义 Swift 编译器

通过环境变量指定编译器路径：

SWIFT_EXEC=/path/to/my/built/swiftc swift build

• SWIFT_EXEC_MANIFEST：控制解析 Package.swift 的编译器
• SWIFT_EXEC：控制编译 Swift 源代码的编译器

覆盖运行时库路径

设置 SWIFTPM_CUSTOM_LIBS_DIR 环境变量：

export SWIFTPM_CUSTOM_LIBS_DIR=/custom/libs/path

Linux 开发环境

使用 Docker 进行跨平台开发：

1. 准备镜像：

   docker-compose -f Utilities/docker/docker-compose.yaml \
                 -f Utilities/docker/docker-compose.<os>.<swift>.yaml \
                 build
   

2. 交互式 Shell：

   docker-compose -f ... run --rm shell
   

3. 构建与测试：

   docker-compose -f ... run --rm build
   docker-compose -f ... run --rm test
   

文档生成

使用 DocC 生成文档：

1. 生成符号图：

   swift package dump-symbol-graph
   

2. 预览文档：

   xcrun docc preview Sources/PackageDescription/PackageDescription.docc \
        --additional-symbol-graph-dir .build/*/symbolgraph/
   

访问 http://localhost:8000/documentation/packagedescription 查看文档。

常见问题排查

1. SPI 属性错误：

   @_spi(Testing) public var isFramework: Bool
   

   确保使用 SwiftPM 5.3 或更高版本

2. PkgConfig 错误： 检查 PkgConfigError 枚举是否包含所需成员

通过遵循这些指南，开发者可以有效地为 Swift Package Manager 项目做出贡献，无论是修复 bug、改进功能还是完善文档。

swift-package-manager The Package Manager for the Swift Programming Language 项目地址: https://gitcode.com/gh_mirrors/sw/swift-package-manager