rules_xcodeproj
2.9.2
published 2 days ago
528 stars
86 forks
24 watchers
MobileNativeFoundation/rules_xcodeproj
MIT License
public
2 assets
1,213,118 downloads
13 MB
Bazel central registry
Compatability level 1
GJAmZRiNMmN/CpGEjO20eMndARx4ByCrRJt4PyQ4BSc=
Maintained byBrentley Jones,Patrick Balestra,Luis Padron
Bazel rules for generating Xcode projects.
2.9.2
November 18, 2024

What’s Changed

Since 2.9.1

  • Fixed parsing of custom scheme test options: #3110

Below are the changes that were in 2.9.1.

New

  • Added support for App Language and App Region scheme test action options: #3105 and #3108

Fixed

  • Fixed handling of mixed_language_library when both targets are unfocused: #3104

Full Changelog

https://github.com/buildbuddy-io/rules_xcodeproj/compare/2.8.1...2.9.2

Contributors

  • TBD

Bzlmod Snippet

bazel_dep(name = "rules_xcodeproj", version = "2.9.2")

release.tar.gz’s integrity: sha256-GJAmZRiNMmN/CpGEjO20eMndARx4ByCrRJt4PyQ4BSc=

Workspace Snippet

Please use the release asset (release.tar.gz) from your Bazel WORKSPACE instead of GitHub's source asset to reduce download size and improve reproducibility.

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_xcodeproj",
    integrity = "sha256-GJAmZRiNMmN/CpGEjO20eMndARx4ByCrRJt4PyQ4BSc=",
    url = "https://github.com/MobileNativeFoundation/rules_xcodeproj/releases/download/2.9.2/release.tar.gz",
)

load(
    "@rules_xcodeproj//xcodeproj:repositories.bzl",
    "xcodeproj_rules_dependencies",
)

xcodeproj_rules_dependencies()

load("@bazel_features//:deps.bzl", "bazel_features_deps")

bazel_features_deps()

load(
    "@build_bazel_rules_apple//apple:repositories.bzl",
    "apple_rules_dependencies",
)

apple_rules_dependencies()

load(
    "@build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)

swift_rules_dependencies()

load(
    "@build_bazel_rules_swift//swift:extras.bzl",
    "swift_rules_extra_dependencies",
)

swift_rules_extra_dependencies()

load(
    "@build_bazel_apple_support//lib:repositories.bzl",
    "apple_support_dependencies",
)

apple_support_dependencies()
Deps:
Assets:

rules_xcodeproj

This repository contains rules for Bazel that can be used to generate Xcode projects from targets in your workspace.

If you run into any problems with these rules, please check our FAQ, check if another issue already exists and comment on it, or file a new issue!

Features

  • Full support for Xcode features:
    • Indexing (i.e. autocomplete, syntax highlighting, jump to definition)
    • Debugging
    • Runtime sanitizers
    • Inline warnings and errors
    • Fix-its (currently only in BwX mode)
    • Test selection and running
    • Embedded Targets (App Clips, App Extensions, and Watch Apps)
    • Dynamic frameworks
    • Xcode Previews
  • Focused Projects
    • Include a subset of your targets in Xcode
    • Unfocused targets are built with Bazel
    • Works in BwX mode as well!
  • Comprehensive Bazel rules support
    • Core Bazel C/C++/Objective-C
    • rules_swift
    • rules_apple
    • rules_ios
    • Most likely your custom rules as well!
  • Minimal configuration needed (see the usage section below)
  • It “just works”

We’ve also documented the high-level design goals of the ruleset.

Projects using rules_xcodeproj

  • amo
  • BazelPods
  • Cash App
  • Envoy Mobile
  • Ergatta
  • Faire Wholesale
  • Gojek
  • Lyft
  • Mercari
  • Reddit
  • Robinhood
  • Slack
  • Snap
  • Spotify
  • Square
  • SwiftLint
  • Ten Ten
  • Tinder
  • Tokopedia

If you are also using rules_xcodeproj for your project, feel free to open a PR to include it in the list above.

Compatibility

rules_xcodeproj Bazel rules_apple rules_swift Xcode macOS Supporting Branch
1.17.0+ 6.3-7.x 1.0.1–2.x 1.x 13.3–15.x 13–14.x main
1.16.0 6.3-7.x 1.0.1–2.x 1.x 13.3–15.2 13–14.x -
1.14.0-1.15.0 6.1-7.x 1.0.1–2.x 1.x 13.3–15.2 13–14.x -
1.7.0-1.13.0 5.3–6.x 1.0.1–2.x 1.x 13.3–15.2 12–13.x -
1.4.0-1.6.0 5.3–6.x 1.0.1–2.x 1.x 13.3–14.3 12–13.x -
1.0-1.3.3 5.3–6.x 1.0.1–2.x 1.x 13.3–14.2 12–13.x -

More versions of these tools and rulesets might be supported, but these are the ones we’ve officially tested with.

Installation

From the release you wish to use, copy the Bzlmod or WORKSPACE snippet into your repository. If you want to manually build a release archive, you can use this command: bazel build //distribution:release.

Usage

Please see the documentation in the docs directory and examples in the examples directory.

Simple iOS example

Given a root level BUILD file:

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_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_library(
    name = "Lib",
    srcs = glob(["src/*.swift"]),
)

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"]),
)

You can then create the Xcode project with:

bazel run //:xcodeproj

The generated project will be in the workspace next to the BUILD file at App.xcodeproj.

Acknowledgements