Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
How to use a .xcconfig file and a .plist with a Swift Package Manager based project.

How to use a .xcconfig file and a .plist file with SPM

Worth a read for some more context.

Create a Package.xcconfig file

Create the file in the root of the project (where your Package.swift file lives as well), and use the following contents:

/// Package.xcconfig

/// macOS Deployment Target
///
/// Code will load on this and later versions of macOS.
/// Framework APIs that are unavailable in earlier versions will be weak-linked;
/// your code should check for `null` function pointers
/// or specific system versions before calling newer APIs.

/// Code signing
DEVELOPMENT_TEAM = ...;
CODE_SIGN_STYLE = Automatic;

/// Platform
SUPPORTED_PLATFORMS = macosx;
MACOSX_DEPLOYMENT_TARGET = 10.12;
VALID_ARCHS[sdk=macosx*] = x86_64;

/// Swift
SWIFT_VERSION = 4.2;

/// Use Info.plist
OTHER_LDFLAGS[sdk=macosx*] = $(inherited) -sectcreate __TEXT __info_plist ./Supporting/Info.plist;

/// Screensaver
//WRAPPER_EXTENSION = saver
//INSTALL_PATH = "$(HOME)/Library/Screen Savers";
//ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;

Create an Info.plist file

Create a folder called Supporting, and create a new Info.plist file inside it with the following contents:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>CFBundleIdentifier</key>
	<string>com.i.and.myself.comma.me</string>
	<key>CFBundlePackageType</key>
	<string>BNDL</string>
	<key>NSHumanReadableCopyright</key>
	<string>Copyright © 2019 My, Myself and I. All rights reserved.</string>
</dict>
</plist>

Observe that you can define your PrincipalClass this way.

	<key>NSPrincipalClass</key>
	<string>MyProject.MyPrincipalView</string>

Generate the Xcode project

swift package generate-xcodeproj --xcconfig-overrides Package.xcconfig

Note that you can also include the Info.plist directly from the command line as well:

swift package -Xlinker '-sectcreate __TEXT __info_plist ./Supporting/Info.plist' generate-xcodeproj --xcconfig-overrides Package.xcconfig

Or if you use a Fish shell...

...you can use the following Fish Shell function (~/.config/fish/functions/swiftxcode.fish) to make building your SPM project a bit easier by just using swiftxcode:

function swiftxcode --description "Generate a Xcode project for a Swift Package Manager based project."
    if ! test -e ./Package.swift
        echo "This is not a Swift Package Manager project"
        return
    end

    set -lx linkerOptions
    set -lx options
    set -lx shouldLinkInfoPlist false

    if test -e ./Package.xcconfig
        set options $options --xcconfig-overrides Package.xcconfig
    end

    if test -e ./Supporting/Info.plist
        if test -e ./Package.xcconfig; and test (grep OTHER_LDFLAGS Package.xcconfig|grep "__info_plist"|grep -vi "^/"|wc -l) -gt 0
        else
            set shouldLinkInfoPlist true
        end
    end

    if test $shouldLinkInfoPlist = "true"
        set linkerOptions $linkerOptions -Xlinker '-sectcreate __TEXT __info_plist ./Supporting/Info.plist'
    end

    swift package $linkerOptions generate-xcodeproj $options
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.