[SR-2866] [SwiftPM] Need a way to include resources with targets

[ddunbar]

Previous ID	SR-2866
Radar	rdar://problem/34480872
Original Reporter	@ddunbar
Type	Bug
Status	Closed
Resolution	Done

Additional Detail from JIRA

Votes	115
Component/s	Package Manager
Labels	Bug
Assignee	None
Priority	Medium

md5: ff37c4c7be00b80a1eb47bf7e441933b

is duplicated by:

• SR-2751 Errors using Swift Package Manager
• SR-8260 Implementation story for resources

relates to:

• SR-4725 Support Test Collateral in Package Manager

Issue Description:

The Swift package manager needs a story for how packages should specify resources to include with products.

On Darwin, this would traditionally be done with a Resources folder in a framework. On Linux, it is less clear what should happen, and we will want users to have access to a reliable cross-platform mechanism for resources.

[swift-ci]

Comment by Ondrej Rafaj (JIRA)

So I think that a cool way to allow this would be to import of thirdparty code into the Package.swift file so people can do their own implementation.

At the moment I have a lib like this https://github.com/LiveUI/SwiftResources which imports my resources at the runtime but having something that would execute it during build (or at least to be able to create a target which would be a dependency to my main target and executed before I run my main target) would solve this issue for me at least a bit.

[belkadan]

SR-8260 has a writeup of how this could look.

[swift-ci]

Comment by Werner Altewischer (JIRA)

Any progress on this?

[swift-ci]

Comment by Alban Deflandre (JIRA)

Any update?

[swift-ci]

Comment by Bastian Mueller (JIRA)

@ddunbar @belkadan Any update on this? Using Swift Package Manager is great and using XCTest is great as well, but without support for resources/assets/fixtures it's really painful to write some tests, i.e., currently expected output needs to be inlined.

[ddunbar]

turbolent (JIRA User) I don't have any update on the comment, but a common trick I use for tests is to find resources relative to Swift's #file.

[swift-ci]

Comment by Guillermo Ignacio Enriquez Gutierrez (JIRA)

I am also interested in an official support for resources too.

I haven't checked tests very well but when using resources in the Sources directory results are different according environment.

I have a simple program here

1. In macos swift run: program works as expected (resources are reachable).

2. In macos swift package generate-xcodeproj then run in Xcode: program does NOT work as expected (paths are NOT found, because resources are not imported into Xcode project).

3. In linux (via Docker) swift run: program does NOT work as expected (paths are NOT found).

I checked at some sources like Kitura swift server framework and they try really hard to find absolute paths... I wish there was a standard and easy way to find resources within the application.

[swift-ci]

Comment by Richard Venable (JIRA)

Any progress being made on Anders' proposal? https://github.com/abertelrud/swift-evolution/blob/package-manager-resources/proposals/NNNN-package-manager-resources.md

[swift-ci]

Comment by Pavan (JIRA)

I think it would be great support if it's get included in before final Xcode11 releases

[swift-ci]

Comment by Christophe Braud (JIRA)

Totally agree with pavm035 (JIRA User) 👍 😃

[swift-ci]

Comment by Ondrej Rafaj (JIRA)

If we only could add custom code to the package file to happen on execution. That way any missing feature could be handled by the developer.

[swift-ci]

Comment by Alban Deflandre (JIRA)

We all agree with Pavan, but is someone listening us?

[swift-ci]

Comment by Pavan (JIRA)

Any update, we really keep looking for this feature!!!

[swift-ci]

Comment by Guillermo Ignacio Enriquez Gutierrez (JIRA)

Some discussion is happening here:
https://forums.swift.org/t/swift-pm-bundles-and-resources/13981/34

Not very active recently but maybe there is an update there. (I just wrote my opinion about the proposal there)

I am really looking forward resources support in SPM 🙂

[swift-ci]

Comment by Basem Emara (JIRA)

Embedding resources are a show-stopper for a large chunk of Swift frameworks out there. Is there still time to get one released before beta ends?