Preserve file hierarchy in the Resources directory

[marekfort]

View in #support on Slack

@Noam_Freeman: hi Tuist team !
i’m trying to migrate a project to tuist.
my unit-test target has a Resource directory, and within it, a hierarchy of folders, so when building from xCode, i can get resources from the bundle with path/to/resource.png .
is there a simple way to place all the content of my Resources directory in resources: without flattening it?
• i tried configuring the project with resources: ["MyTarget/Resources/**"] - but all the resources got flattened in the resource directory. so now the file is just resource.png without the path/to/
• i tried resources: [.folderReference(path: "MyTarget/Resources")] - and got an extra level of Resources/directory in the resources (Resources/path/to/resource.png)+ some signing issues. same when trying to use copyFiles to resources
• i tried creating a bundle specifically for containing the resources, but i needed to change the code to reference the new bundle.

@Dosu: Tuist currently doesn’t support placing the contents of a resource directory into the bundle root while preserving the internal folder hierarchy and omitting the top-level directory. Using a glob pattern like resources: ["MyTarget/Resources/**"] will flatten the structure, while .folderReference(path: ...) preserves the hierarchy but adds an extra directory level (the folder itself) in the bundle, which matches Xcode’s own behavior for blue folders. There isn’t a built-in way to get exactly what you’re after without custom scripting or changing your code to reference a different bundle structure. This limitation is known and has been discussed in the community—contributions to improve this are welcome if you’re interested in tackling it yourself. You can find more details and join the discussion on the Tuist community forum.

If you want to explore workarounds (like a custom script to copy resources post-build), let me know and I can help outline some options!

Tuist Community: How to generate and keep structured (folders) local packages?

[marekfort]

Hey Noam!

I’ve tried adding an extra level of nesting for some resources in this fixture and the hierarchy was preserved (see the ExtraLevel):

Maybe you could explore that fixture and see how your project differs? If you can’t figure it out, maybe you could create your own fixture that we could take a look at?

[noamfreeman]

thanks for the quick response!
indeed, the hierarchy is preserved in the IDE.
i moved the text file into a subdirecory, like it the image, and it shows in the correct place in the IDE

but somehow, when running the app tests, the file ends up in a flattened path.
at least, when i print the bundle content with
po try? FileManager.default.subpathsOfDirectory(atPath: Bundle.main.bundlePath)
in the test, i get this:

    - 52 : "StaticFramework2Resources.bundle/_CodeSignature/CodeRequirements"
    - 53 : "StaticFramework2Resources.bundle/StaticFramework2Resources-tuist.png"
    - 54 : "StaticFramework2Resources.bundle/Info.plist"
    - 55 : "StaticFramework2Resources.bundle/StaticFramework2Resources-text.txt"

[marekfort]

@noamfreeman

but somehow, when running the app tests, the file ends up in a flattened path.
at least, when i print the bundle content with
po try? FileManager.default.subpathsOfDirectory(atPath: Bundle.main.bundlePath)
in the test, i get this:

Is that still happening if the framework product is changed to a .framework (ie a dynamic framework)?

[noamfreeman]

@noamfreeman

po try? FileManager.default.subpathsOfDirectory(atPath: Bundle.main.bundlePath)

yes, i changed StaticFramework2 to be a .framework and got the same result from the debugger.

    - 107 : "Frameworks/StaticFramework2.framework/StaticFramework2Resources.bundle/_CodeSignature/CodeRequirements"
    - 108 : "Frameworks/StaticFramework2.framework/StaticFramework2Resources.bundle/StaticFramework2Resources-tuist.png"
    - 109 : "Frameworks/StaticFramework2.framework/StaticFramework2Resources.bundle/Info.plist"
    - 110 : "Frameworks/StaticFramework2.framework/StaticFramework2Resources.bundle/StaticFramework2Resources-text.txt"

[marekfort]

@noamfreeman

yes, i changed StaticFramework2 to be a .framework and got the same result from the debugger.

Are you sure the flattening is specific to Tuist then? I wonder if this is default xcodebuild behavior.

[noamfreeman]

well, looking into it - no. it’s not the xCode default.
it’s needs manual setting in xcode,
which of coarse, could be done in tuist manually with resources[ .folderReference()

thanks!