mobilenativefoundation / rules_xcodeproj Goto Github PK

View Code? Open in Web Editor NEW

512.0 22.0 80.0 59.82 MB

Bazel rules for generating Xcode projects.

License: MIT License

Starlark 35.19% Swift 60.86% Shell 1.49% Python 2.45%

bazel xcode xcodeproj bazel-rules ios macos swift tvos watchos visionos

rules_xcodeproj's People

Contributors

Stargazers

Watchers

Forkers

pennig zerocc2014 kevinnguyenhoang91 tinder-maxwellelliott a2 jpsim maxwelle balestrapatrick xinzhengzhang cognitivedisson luispadron chiragramani ra1028 muizidn shubhindia sebastianv1 ayatuas tinder-kaijing icodein i-pavlov keith pswaminathan mattrobmattrob antonito jszumski tyrantdante cpsauer timsutton thiagohmcruz crcunningham gferon sergeykhliustin aleksproger tyhgb acbdev yongjincho92 yrom levenon andre-alves acecilia prideyao kila2 david-lam sanju-naik hasthu narlei charleszane louwers wileykestner tinder-owenthomas manocha-fxn danaospo comius bubski cgrindel 44510 markvasiv linhndsolar m-petes adincebic attilathefun jonyfang lloydchang polac24 karim-alweheshy ali-fareed marcosgriselli chriscraws strogo lunafang1016 ohitsdaniel him2020 dflems rockbruno lucasmarcal-faire clementpadovani aaronsky mjburghard angelaguardia

rules_xcodeproj's Issues

Support `{ios,tvos,watchos}_ui_test`

ios_ui_test
tvos_ui_test (need to check, might be supported)
watchos_ui_test (need to check, might be supported)

Support `{ios,tvos,watchos}_dynamic_framework`

Support `apple_static_framework_import`

https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-apple.md#apple_static_framework_import

Support `macos_bundle`

https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-macos.md#macos_bundle

Support `objc_import`

https://bazel.build/reference/be/objective-c#objc_import

Support `{ios_*,macos,tvos,watchos}_extension`

Fully support `apple_resource_bundle`

#208
Support infoplists: #225

Feature Request: Enable Bazel Starlark Linting and Formatting

Tasks

Add Bazel target that can be used to check for lint and formatting issues using Buildifier
Add Bazel target that can fix lint and formatting issues using Buildifier.
Update the existing codebase to address existing lint and formatting issues.
Update the CI pipeline to execute the check target.

Suggested Implementation

First PR
- Add keith/buildifier-prebuilt as a dev-only dependency.
- Implement two runnable Bazel targets: one to check the lint issues and one to fix issues.
Second PR
- Fix all of the existing lint issues
- Add another entry to bazel_commands in the buildbuddy.yml file to execute the check Bazel target.

Feature Request: Support `apple_xcframework`

Support `{ios,tvos,watchos}_framework`

Address Bazel Starlark lint warnings about module visibility

There are a number of # buildifier: disable=bzl-visibility directives sprinkled throughout the codebase. The primary issue is that by convention code under private or internal directories should not be accessible in other parts of the codebase. We should discuss how we want visibility to work in the repository and then update the code so that these directives can be removed.

Support `cc_library`

https://bazel.build/reference/be/c-cpp#cc_library

Support `swift_module_alias`

https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md#swift_module_alias

Move fixtures.bzl to `xcodeproj/internal` and expose its rules/macros in `xcodeproj/testing.bzl`.

Related to #115.

Moving the fixtures files allows the rules to be accessible to child workspaces.

Support all Core C/C++ rules

Core C / C++ Rules:

Split up `target.bzl`

https://github.com/buildbuddy-io/rules_xcodeproj/blob/main/xcodeproj/internal/target.bzl has grown to be quite large. While everything in there doesn't really belong in any of the other .bzl files, it can still be split up a bit more.

Populate Copy Bundle Resources Phase

Support `swift_c_module`

https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md#swift_c_module

Support `apple_dynamic_xcframework_import`

https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-apple.md#apple_dynamic_xcframework_import

Support `cc_import`

https://bazel.build/reference/be/c-cpp#cc_import

Support `objc_library`

https://bazel.build/reference/be/objective-c#objc_library

Support `cc_proto_library`

Support `swift_grpc_library`

Support `apple_resource_group`

Bug: Product paths can clash

Describe the bug

Currently the path of produced products in the Products group is set to target.product.path.lastComponent. This means that targets with the same output name at different parts in the build graph will collide:

Multiple commands produce '/Users/brentley/Library/Developer/Xcode/DerivedData/cc_binary-ddhijfwpfdtklsexaboctfhzpnhc/Build/Products/Debug/liblib.a':

Target 'cc_example__lib' (project 'cc_binary'): Libtool /Users/brentley/Library/Developer/Xcode/DerivedData/cc_binary-ddhijfwpfdtklsexaboctfhzpnhc/Build/Products/Debug/liblib.a normal

Target 'examples_cc_binary_lib_lib' (project 'cc_binary'): Libtool /Users/brentley/Library/Developer/Xcode/DerivedData/cc_binary-ddhijfwpfdtklsexaboctfhzpnhc/Build/Products/Debug/liblib.a normal

Expected behavior

Just like how target names are disambiguated, product paths should be as well. In the above example, I think they should fall back to libcc_example__lib.a and libexamples_cc_binary_lib_lib.a. I haven't checked, but I assume there will be an issue when there are multiple configurations of the same product as well, and in that case the config hash should be added as well.

Additional context

This is where the path is currently set:
https://github.com/buildbuddy-io/rules_xcodeproj/blob/d778db82f56e3e29f3a0bfc2b39334b43654cf55/tools/generator/src/Generator%2BCreateProducts.swift#L14

It can be set to anything here, and the rest of the system references that value, so this is the only place (besides tests) that needs to have an effective change.

We should probably leverage DisambiguatedTarget, as it's already responsible for providing a unique target name, and the logic to unique the product name can probably live in Generator.disambiguateTargets():
https://github.com/buildbuddy-io/rules_xcodeproj/blob/d778db82f56e3e29f3a0bfc2b39334b43654cf55/tools/generator/src/Generator%2BDisambiguateTargets.swift#L4-L12

Create schemes

Currently we let Xcode create the schemes for us. This is finicky, and we will want to customize how the schemes are created, especially when Building with Bazel.

Fully support Bazel generated files

Show generated sources in Xcode: #65
Enable building of the generated sources listed in Xcode, from the command line: #66
Xcode builds generated sources automatically (as a dependency of other targets): #113
Show other generated files in Xcode (resources, entitlements, Info.plists, etc.)
Show inputs of generated files, transitively, in Xcode: #114
Don't create Xcode targets for tools dependencies: #212

Feature Request: Add Bazel integration tests

What

Implement Bazel integration tests that confirm that the functionality in this project works with select versions of Bazel.

How

Add rules_bazel_integration_test as a dev-only dependency.
Implement an integration test based upon the examples/ios_app in a similar manner to the existing fixture tests.
Define an integration test suite to execute the integration tests.

I will put together one or more PRs with the above functionality. I will reference this issue.

Support `cc_binary`

https://bazel.build/reference/be/c-cpp#cc_binary

Feature Request: Support `apple_static_xcframework`

Populate the Headers Phase

Feature Request: Make the spec diff tests more resilient

While working on #115, the spec diff tests began failing (see below . After inspection most of the issues are related to the sort order for the required_links and the Xcode targets.

|| ==================== Test output for //test:xcodeproj_generator:
|| Spec doesn't match expected:
|| 25d24
|| <         "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/tools/generator/libgenerator.library.a",
|| 27c26,27
|| <         "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_xctest_dynamic_overlay/libXCTestDynamicOverlay.a"
|| ---
|| >         "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_xctest_dynamic_overlay/libXCTestDynamicOverlay.a",
|| >         "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/tools/generator/libgenerator.library.a"
|| 30c30
|| <         "@com_github_kylef_pathkit//:PathKit darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| ---
|| >         "@com_github_tadija_aexml//:AEXML darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| 72,73c72,73
|| <                 "PRODUCT_MODULE_NAME": "PathKit",
|| <                 "PRODUCT_NAME": "PathKit",
|| ---
|| >                 "PRODUCT_MODULE_NAME": "AEXML",
|| >                 "PRODUCT_NAME": "AEXML",
|| 83c83
|| <             "label": "@com_github_kylef_pathkit//:PathKit",
|| ---
|| >             "label": "@com_github_tadija_aexml//:AEXML",
|| 85c85
|| <             "name": "PathKit",
|| ---
|| >             "name": "AEXML",
|| 88,91c88,91
|| <                     "name": "PathKit.swiftmodule",
|| <                     "swiftdoc": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftdoc",
|| <                     "swiftmodule": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftmodule",
|| <                     "swiftsourceinfo": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftsourceinfo"
|| ---
|| >                     "name": "AEXML.swiftmodule",
|| >                     "swiftdoc": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftdoc",
|| >                     "swiftmodule": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftmodule",
|| >                     "swiftsourceinfo": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftsourceinfo"
|| 100,101c100,101
|| <                 "name": "PathKit",
|| <                 "path": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/libPathKit.a",
|| ---
|| >                 "name": "AEXML",
|| >                 "path": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/libAEXML.a",
|| 105c105,109
|| <                 "external/com_github_kylef_pathkit/Sources/PathKit.swift"
|| ---
|| >                 "external/com_github_tadija_aexml/Sources/AEXML/Document.swift",
|| >                 "external/com_github_tadija_aexml/Sources/AEXML/Element.swift",
|| >                 "external/com_github_tadija_aexml/Sources/AEXML/Error.swift",
|| >                 "external/com_github_tadija_aexml/Sources/AEXML/Options.swift",
|| >                 "external/com_github_tadija_aexml/Sources/AEXML/Parser.swift"
|| 109c113
|| <         "@com_github_tadija_aexml//:AEXML darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| ---
|| >         "@com_github_kylef_pathkit//:PathKit darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| 151,152c155,156
|| <                 "PRODUCT_MODULE_NAME": "AEXML",
|| <                 "PRODUCT_NAME": "AEXML",
|| ---
|| >                 "PRODUCT_MODULE_NAME": "PathKit",
|| >                 "PRODUCT_NAME": "PathKit",
|| 162c166
|| <             "label": "@com_github_tadija_aexml//:AEXML",
|| ---
|| >             "label": "@com_github_kylef_pathkit//:PathKit",
|| 164c168
|| <             "name": "AEXML",
|| ---
|| >             "name": "PathKit",
|| 167,170c171,174
|| <                     "name": "AEXML.swiftmodule",
|| <                     "swiftdoc": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftdoc",
|| <                     "swiftmodule": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftmodule",
|| <                     "swiftsourceinfo": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/AEXML.swiftsourceinfo"
|| ---
|| >                     "name": "PathKit.swiftmodule",
|| >                     "swiftdoc": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftdoc",
|| >                     "swiftmodule": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftmodule",
|| >                     "swiftsourceinfo": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/PathKit.swiftsourceinfo"
|| 179,180c183,184
|| <                 "name": "AEXML",
|| <                 "path": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_tadija_aexml/libAEXML.a",
|| ---
|| >                 "name": "PathKit",
|| >                 "path": "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/libPathKit.a",
|| 184,188c188
|| <                 "external/com_github_tadija_aexml/Sources/AEXML/Document.swift",
|| <                 "external/com_github_tadija_aexml/Sources/AEXML/Element.swift",
|| <                 "external/com_github_tadija_aexml/Sources/AEXML/Error.swift",
|| <                 "external/com_github_tadija_aexml/Sources/AEXML/Options.swift",
|| <                 "external/com_github_tadija_aexml/Sources/AEXML/Parser.swift"
|| ---
|| >                 "external/com_github_kylef_pathkit/Sources/PathKit.swift"
|| 421,422c421,422
|| <                 "@com_github_kylef_pathkit//:PathKit darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| <                 "@com_github_tuist_xcodeproj//:XcodeProj darwin_x86_64-fastbuild-ST-1b9bd654f600"
|| ---
|| >                 "@com_github_tuist_xcodeproj//:XcodeProj darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| >                 "@com_github_kylef_pathkit//:PathKit darwin_x86_64-fastbuild-ST-1b9bd654f600"
|| 784,785c784,785
|| <                 "//tools/generator:generator.library darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| <                 "@com_github_pointfreeco_swift_custom_dump//:CustomDump darwin_x86_64-fastbuild-ST-1b9bd654f600"
|| ---
|| >                 "@com_github_pointfreeco_swift_custom_dump//:CustomDump darwin_x86_64-fastbuild-ST-1b9bd654f600",
|| >                 "//tools/generator:generator.library darwin_x86_64-fastbuild-ST-1b9bd654f600"
|| 882a883,884
|| >                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_swift_custom_dump/libCustomDump.a",
|| >                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_xctest_dynamic_overlay/libXCTestDynamicOverlay.a",
|| 886,888c888
|| <                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/libPathKit.a",
|| <                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_swift_custom_dump/libCustomDump.a",
|| <                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_pointfreeco_xctest_dynamic_overlay/libXCTestDynamicOverlay.a"
|| ---
|| >                 "bazel-out/darwin_x86_64-fastbuild-ST-1b9bd654f600/bin/external/com_github_kylef_pathkit/libPathKit.a"
|| 
|| Run `bazel run //test/fixtures:update` if you wish to accept these changes.
|| ================================================================================

Epic: Support all `rules_apple` rules

rules_apple Rules:

Support:

Top level targets:

Distribution:

Support `{ios,macos,tvos,watchos}_unit_test`

ios_unit_test
macos_unit_test: #267
tvos_unit_test: #282
watchos_unit_test: #286

Support `cc_test`

https://bazel.build/reference/be/c-cpp#cc_test

Support additional_linker_inputs
Support linkstatic
Support malloc?
Support nocopts (support removed in Bazel, so not doing anything for it un rules_xcodeproj)