Eon's swift blog

Assets in spm

Apr 15, 2021
1 minute read

Add assets to SPM Only for Swift tools version of 5.3 or later

Examples

In the Package.swift

targets: [
    .target(
        name: "MyLibrary", //  consider using a subfolder for resources to distinguish them from source files,  For example, put all resource files into a directory named Resources, resulting in all of your resource files residing at Sources/MyLibrary/Resources.
        resources: [
            .process("text.txt")]
    ),
]

In the code:

let settingsURL = Bundle.module.url(forResource: "settings", withExtension: "plist")

Gotchas:

  • You can set folder paths and file paths as resources

Update for spm 5.6+:

  • Resources/Assets.bundle

Package file:

// swift-tools-version: 5.6
import PackageDescription
let package = Package(
    name: "AssetLib",
    products: [
        .library(
            name: "AssetLib",
            targets: ["AssetLib"]),
    ],
    dependencies: [],
    targets: [
        .target(
            name: "AssetLib",
            dependencies: [],
            resources: [.copy("Resources/Assets.bundle")] // .copy is key to retaining directory structure
         )
    ]
)

SPM file:

import Foundation

public struct AssetLib {
   public static let bundle: Foundation.Bundle = Foundation.Bundle.module // important for accessing the resource from external packages etc
}

Using the assetlib in another package or project:

import FileSugar

guard let resourcePath = AssetLib.bundle.resourcePath else { Swift.print("no resource path"); fatalError() }
let assetsPath = resourcePath + "/Assets.bundle/"
let filePath1 = assetsPath + "test.txt"
let fileContent = FileParser.content(filePath: filePath1)
Swift.print("fileContent:  \(String(describing: fileContent))")
let filePath2 = assetBundlePath + "/docs/" + "testing.txt" // Access subfolders

Resources