Exclude files/folders from gazelle

[borjasantos-diez]

Hello, I'm having some issues with a few packages, where the BUILD file that gets generated is wrong.

As far as I can see, it's all about ignoring some folders/files, so I've been trying to provide that to swift_update_packages using the kwargs, but I haven't been able to make it work. I've also tried patching the repo, but one of the scenarios is not fixable that way, Any suggestions on how to use kwargs or any other way for gazelle to ignore stuff?

Thanks.

[cgrindel]

I would love to understand what is wrong so that we can fix it. Can you provide more information?

To answer your question, if you want gazelle to ignore certain paths, you can use the # gazelle:exclude pattern. Here is an example of how it is used.

[borjasantos-diez]

Will try to help as much as I can if you need me to. Many thanks.

[cgrindel]

I have a PR up that should address the bad resource paths.

[cgrindel]

The fix is released in 0.18.0. If you are using bzlmod, it will be available once this PR merges for the BCR.

[cgrindel]

There was a problem with pushing 0.18.0 to the BCR. So, if you are using bzlmod, use 0.18.1. Here is the BCR PR.

[borjasantos-diez]

There also seem to be issues with 0.18.1, but don't worry. I'll keep track of the next release. No need to update in this discussion 👍 Many thanks for your efforts :)

[borjasantos-diez]

Hi @cgrindel,

I have just tested 0.18.2, and even though the issue with the ./ is fixed, I'm still getting some errors, due to some files with the same name being added to the resources bundle

Error in fail: Multiple files would be placed at "iAppNexusSDK_resource_bundle.bundle/objects-11.0+.nib" in the bundle, which is not allowed. check input file:
external/rules_swift_package_manager~0.18.2~swift_deps~swiftpkg_tagmanager_sdk_xandr_public_bin/AppNexusSDK.xcframework/ios-arm64_x86_64-simulator/AppNexusSDK.framework/ANInterstitialAdViewController.nib/objects-11.0+.nib

Would it make sense to use the structured_resources attribute rather than resources in this case so that things are kept in its place?

I've attached the generated BUILD.bazel
BUILD.bazel.zip

[cgrindel]

The apple_resource_bundle named iAppNexusSDK_resource_bundle seems to only include files from the AppNexusSDK xcframework. I believe that this is happening because the iAppNexusSDK target is not excluding the xcframework paths. Can you try excluding those paths from the iAppNexusSDK target?

    targets: [
        .target(name: sdkName, path: ""),   // <=== I think this should exclude AppNexusSDK.xcframework and OMSDK_Appnexus.xcframework.
        .binaryTarget(name: "AppNexusSDK", path: "AppNexusSDK.xcframework"),
        .binaryTarget(name: "OMSDK_Appnexus", path: "OMSDK_Appnexus.xcframework"),
    ],

[borjasantos-diez]

I've added a patch, but I'm still getting the same error... I've attached the full folder that gets generated, with the modified Package.swift, in case that provides any more info.
rules_swift_package_manager0.18.2swift_deps~swiftpkg_tagmanager_sdk_xandr_public_bin.zip

[cgrindel]

OK. I think that I may understand what is happening. The path exclusions were not being passed to the resource discovery functions. I put together a PR that attempts to fix this. Can you try using the branch with git_override?

Add something like the following to your MODULE.bazel:

git_override(
    module_name = "rules_swift_package_manager",
    remote = "https://github.com/cgrindel/rules_swift_package_manager",
    commit = "57277302deb455cceb27bf84e4a56a41871d0fbd",  # commit for branch https://github.com/cgrindel/rules_swift_package_manager/tree/gh678_res_bundle_disc
)

[cgrindel]

I made some updates to the branch. Here is the new commit: ec4b89256e283bb67aa3f29b73a582bfe4eede98.

[borjasantos-diez]

Brilliant! It has finally worked :) I still have to patch the Package.swift but that's something I can send some feedback about, or even create a PR for them to add those excludes.
Many thanks for your time 🙏

[DJBen]

I too need to exclude path. Use case: I have a integration test subdirectory that has its own MODULE.bazel. I don't want my toplevel gazelle update to affect that.

[cgrindel]

Have you tried using the # gazelle:exclude pattern directive?