Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MobileNativeFoundation/rules_xcodeproj
Bazel rules for generating Xcode projects.
https://github.com/MobileNativeFoundation/rules_xcodeproj
bazel bazel-rules ios macos swift tvos watchos xcode xcodeproj
Last synced: 8 days ago
JSON representation
Bazel rules for generating Xcode projects.
- Host: GitHub
- URL: https://github.com/MobileNativeFoundation/rules_xcodeproj
- Owner: MobileNativeFoundation
- License: mit
- Created: 2022-02-01T19:04:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T21:41:43.000Z (7 months ago)
- Last Synced: 2024-04-13T03:01:34.755Z (7 months ago)
- Topics: bazel, bazel-rules, ios, macos, swift, tvos, watchos, xcode, xcodeproj
- Language: Swift
- Homepage:
- Size: 57.8 MB
- Stars: 482
- Watchers: 22
- Forks: 71
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-bazel - rules_xcodeproj - Generates Xcode projects for your workspace that builds with Bazel (Tooling / Editors)
README
# rules_xcodeproj
This repository contains rules for [Bazel](https://bazel.build) 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](docs/faq.md), check if [another issue already exists][issues] and comment
on it, or [file a new issue][file-an-issue]!
[issues]: https://github.com/MobileNativeFoundation/rules_xcodeproj/issues
[file-an-issue]: https://github.com/MobileNativeFoundation/rules_xcodeproj/issues/new/choose
## 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](#usage) section below)
- It “just works”
We’ve also documented the [high-level design goals](docs/design-goals.md) of
the ruleset.
## Projects using rules_xcodeproj
- amo
- BazelPods
- Cash App
- Envoy Mobile
- Ergatta
- Faire Wholesale
- Gojek
- Lyft
- [Mercari](https://engineering.mercari.com/en/blog/entry/20221215-16cdd59909/)
- Reddit
- Robinhood
- [Slack](https://www.youtube.com/watch?v=wy3Q38VJ5uQ)
- 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][1] | [rules_swift][2] | 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.
[1]: https://github.com/bazelbuild/rules_apple
[2]: https://github.com/bazelbuild/rules_swift
## Installation
From the
[release you wish to use](https://github.com/MobileNativeFoundation/rules_xcodeproj/releases),
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](docs/README.md) directory and
examples in the [examples](examples/README.md) directory.
### Simple iOS example
Given a root level `BUILD` file:
```python
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:
```shell
bazel run //:xcodeproj
```
The generated project will be in the workspace next to the `BUILD` file at
`App.xcodeproj`.
## Acknowledgements
- Inspired by [Tulsi][tulsi] and the custom project generators at Target and Lyft.
- Made possible by [XcodeProj][XcodeProj].
- Initial design and development by [@brentleyjones](https://github.com/brentleyjones).
- [Logo][logo] by [@pennig](https://github.com/pennig).
- Donated to the Mobile Native Foundation by [BuildBuddy](https://buildbuddy.io).
[logo]: https://user-images.githubusercontent.com/158658/161647598-223361dc-030d-431a-b4fe-d92592ed5530.png
[tulsi]: https://github.com/bazelbuild/tulsi
[XcodeProj]: https://github.com/tuist/XcodeProj