Bazel Xcodeproj 规则项目教程

Bazel Xcodeproj 规则项目教程

rules_xcodeproj Bazel rules for generating Xcode projects. 项目地址: https://gitcode.com/gh_mirrors/ru/rules_xcodeproj

1. 项目的目录结构及介绍

rules_xcodeproj 是一个开源项目，它包含了一套 Bazel 规则，用于从 Bazel 工作空间中的目标生成 Xcode 项目。项目的目录结构如下：

• .bcr: Bazel 执行配置文件。
• .github: 包含 GitHub 工作流程的目录。
• distribution: 包含发布相关文件的目录。
• docs: 项目文档目录。
• examples: 包含示例配置和代码的目录。
• test: 测试代码目录。
• third_party: 第三方依赖库目录。
• tools: 工具脚本目录。
• xcodeproj: 包含 Xcode 项目生成规则的目录。
• BUILD: Bazel 的构建文件。
• CODEOWNERS: 指定代码所有者的文件。
• CODE_OF_CONDUCT.md: 项目行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• MAINTENANCE.md: 维护指南文件。
• MODULE.bazel: Bazel 模块文件。
• README.md: 项目说明文件。
• WORKSPACE: Bazel 工作空间配置文件。
• WORKSPACE.bzlmod: Bazel 模块工作空间配置文件。
• 其他文件如 .gitattributes、.gitignore、.swiftformat、.swiftlint.yml 等配置文件。

2. 项目的启动文件介绍

rules_xcodeproj 项目的启动主要是通过 Bazel 命令来执行的。在项目根目录下，可以通过以下命令来生成 Xcode 项目：

bazel run //:xcodeproj

执行后，会在工作空间旁边生成一个名为 App.xcodeproj 的 Xcode 项目文件，可以打开该文件并开始开发。

3. 项目的配置文件介绍

项目的配置主要通过 Bazel 的 BUILD 文件和相关规则来完成。以下是一些主要的配置文件和它们的介绍：

• BUILD: 这是 Bazel 的主构建文件，它加载了必要的 Bazel 规则，并定义了项目中的构建目标。
• WORKSPACE: 这个文件用来配置 Bazel 的工作空间，包括外部依赖的声明。
• WORKSPACE.bzlmod: 这是 Bazel 模块工作空间配置文件，用于管理 Bazel 模块依赖。
• .bazelrc: 这是 Bazel 的配置文件，可以设置构建选项和工具链。
• xcodeproj.bazelrc: 这是针对 Xcodeproj 规则的特定配置文件。

在 BUILD 文件中，通常会使用以下规则来定义 Xcode 项目：

load("@build_bazel_rules_apple//apple:ios.bzl", "ios_application", "ios_unit_test")
load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")
load("@rules_xcodeproj//xcodeproj:defs.bzl", "top_level_target", "xcodeproj")

xcodeproj(
    name = "xcodeproj",
    project_name = "App",
    tags = ["manual"],
    top_level_targets = [
        top_level_target(":App", target_environments = ["device", "simulator"]),
        ":Tests",
    ],
)

# 定义 iOS 应用程序目标
ios_application(
    name = "App",
    bundle_id = "com.example.app",
    families = ["iphone", "ipad"],
    infoplists = [":Info.plist"],
    minimum_os_version = "15.0",
    visibility = ["//visibility:public"],
    deps = [":Lib"],
)

# 定义 Swift 库
swift_library(
    name = "Lib",
    srcs = glob(["src/*.swift"]),
)

# 定义 iOS 单元测试目标
ios_unit_test(
    name = "Tests",
    bundle_id = "com.example.tests",
    minimum_os_version = "15.0",
    test_host = ":App",
    visibility = ["//visibility:public"],
    deps = [":TestLib"],
)

# 定义测试库
swift_library(
    name = "TestLib",
    srcs = glob(["test/*.swift"]),
)

这些配置文件定义了项目的构建逻辑和依赖，通过修改它们，可以定制项目的构建行为。

rules_xcodeproj Bazel rules for generating Xcode projects. 项目地址: https://gitcode.com/gh_mirrors/ru/rules_xcodeproj