Project structure and Swift Package Manager basics

Introduction

Organizing your Swift code helps keep things neat and easy to find. Swift Package Manager (SPM) helps you manage your code and its parts automatically.

When you want to share your Swift code with others easily.

When your project grows and you need to keep files organized.

When you want to add external code libraries to your project.

When you want to build and test your Swift code from the command line.

When you want to manage multiple Swift modules in one place.

Syntax

Swift

swift package init --type executable

// Folder structure created:
// MyPackage/
// ├── Package.swift
// ├── Sources/
// │   └── MyPackage/
// │       └── main.swift
// └── Tests/
//     └── MyPackageTests/
//         └── MyPackageTests.swift

Package.swift is the main file that describes your package.

Sources/ folder holds your Swift code files.

Examples

This creates a Swift package for a library instead of an executable program.

Swift

swift package init --type library

This command builds your Swift package and compiles the code.

Swift

swift build

This runs all tests in the Tests/ folder to check your code.

Swift

swift test

Sample Program

This simple Swift package prints a greeting. The Package.swift file tells Swift Package Manager about the package name and where the code lives. The main.swift file contains the code that runs.

Swift

// Package.swift
// This file defines the package and its settings

// swift-tools-version:5.7
import PackageDescription

let package = Package(
    name: "HelloSPM",
    targets: [
        .executableTarget(
            name: "HelloSPM",
            path: "Sources/HelloSPM"
        )
    ]
)

// Sources/HelloSPM/main.swift
print("Hello, Swift Package Manager!")

Important Notes

You can add dependencies in Package.swift to use other packages.

SPM automatically creates a build folder to keep compiled files separate.

Use clear folder names inside Sources/ if you have multiple targets.

Summary

Swift Package Manager helps organize and build Swift projects easily.

The Package.swift file is the heart of your package setup.

Use commands like swift build and swift test to work with your package.

Practice

1. What is the main purpose of the Package.swift file in a Swift package?

easy

A. It stores the compiled binary files of the package.

B. It contains the source code of the Swift package.

C. It defines the package's name, dependencies, targets, and products.

D. It is used to run the Swift package tests.

Solution

1. Step 1: Understand the role of Package.swift

   This file is the manifest that describes the package's configuration, including its name, dependencies, targets, and products.

2. Step 2: Differentiate from other files

   Source code files contain code, binaries are compiled outputs, and tests are run by commands, not defined in this file.

3. Final Answer:

   It defines the package's name, dependencies, targets, and products. -> Option C

4. Quick Check:

   Package manifest = Package.swift = It defines the package's name, dependencies, targets, and products. [OK]

Hint: Remember: Package.swift is the package's blueprint file. [OK]

Common Mistakes:

• Confusing Package.swift with source code files
• Thinking Package.swift stores compiled binaries
• Assuming Package.swift runs tests directly

2. Which command do you use to build a Swift package from the terminal?

easy

A. swift build

B. swift package

C. swift run

D. swift compile

Solution

1. Step 1: Recall Swift Package Manager commands

   The command swift build compiles the Swift package source code into an executable or library.

2. Step 2: Differentiate from other commands

   swift run runs the built executable, swift package manages package operations, and swift compile is not a valid command.

3. Final Answer:

   swift build -> Option A

4. Quick Check:

   Build command = swift build = swift build [OK]

Hint: Build your package with 'swift build' command. [OK]

Common Mistakes:

• Using 'swift run' to build instead of run
• Typing 'swift compile' which is invalid
• Confusing 'swift package' with build command

3. Given this directory structure of a Swift package:

MyPackage/
├── Package.swift
├── Sources/
│   └── MyLib/
│       └── MyLib.swift
└── Tests/
    └── MyLibTests/
        └── MyLibTests.swift

What will happen when you run swift test inside MyPackage?

medium

A. It compiles and runs the tests defined in MyLibTests.swift.

B. It builds the package but does not run any tests.

C. It deletes the Tests folder.

D. It runs the source code in MyLib.swift directly.

Solution

1. Step 1: Understand the purpose of swift test

   This command compiles the test target and runs all tests found in the Tests directory.

2. Step 2: Identify test files and behavior

   The file MyLibTests.swift contains test code that will be executed by swift test. It does not build only or delete folders.

3. Final Answer:

   It compiles and runs the tests defined in MyLibTests.swift. -> Option A

4. Quick Check:

   swift test runs tests = It compiles and runs the tests defined in MyLibTests.swift. [OK]

Hint: Run tests with 'swift test' to execute test files. [OK]

Common Mistakes:

• Thinking 'swift test' only builds without running tests
• Assuming it deletes files or folders
• Confusing running tests with running source code

4. You wrote a Package.swift file but when running swift build, you get an error about missing targets. What is a likely cause?

medium

A. You forgot to create the Tests folder.

B. The targets array in Package.swift is empty or missing the source target.

C. You ran swift build outside the package directory.

D. The Swift compiler is not installed.

Solution

1. Step 1: Analyze the error about missing targets

   Missing targets usually mean the Package.swift file does not list the source targets properly in its targets array.

2. Step 2: Check other options

   While running outside the directory or missing compiler causes other errors, the specific missing target error points to the manifest file's targets section.

3. Final Answer:

   The targets array in Package.swift is empty or missing the source target. -> Option B

4. Quick Check:

   Missing targets error = fix targets array in Package.swift [OK]

Hint: Check targets array in Package.swift if build says missing targets. [OK]

Common Mistakes:

• Ignoring the targets section in Package.swift
• Assuming missing Tests folder causes target errors
• Not verifying current directory before building

5. You want to create a Swift package that produces a library named Utils and depends on an external package Alamofire. Which Package.swift snippet correctly sets this up?

hard

A. let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git")], targets: [.target(name: "Utils")], products: [.library(name: "Utils", targets: ["Utils"])])

B. let package = Package(name: "Utils", targets: [.target(name: "Utils")], products: [.executable(name: "Utils", targets: ["Utils"])])

C. let package = Package(name: "Utils", dependencies: [], targets: [.target(name: "Utils")], products: [.library(name: "Utils", targets: ["Utils"])])

D. let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0")], targets: [.target(name: "Utils", dependencies: ["Alamofire"])], products: [.library(name: "Utils", targets: ["Utils"])])

Solution

1. Step 1: Identify correct dependency syntax

   let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0")], targets: [.target(name: "Utils", dependencies: ["Alamofire"])], products: [.library(name: "Utils", targets: ["Utils"])]) correctly specifies the dependency with URL and version using from: "5.0.0", which is required for versioning.

2. Step 2: Check targets and products

   let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0")], targets: [.target(name: "Utils", dependencies: ["Alamofire"])], products: [.library(name: "Utils", targets: ["Utils"])]) includes the dependency in the target's dependencies array and defines a library product named "Utils" targeting the "Utils" target.

3. Step 3: Compare other options

   let package = Package(name: "Utils", targets: [.target(name: "Utils")], products: [.executable(name: "Utils", targets: ["Utils"])]) lacks dependencies and wrongly defines an executable product. let package = Package(name: "Utils", dependencies: [], targets: [.target(name: "Utils")], products: [.library(name: "Utils", targets: ["Utils"])]) has no dependencies. let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git")], targets: [.target(name: "Utils")], products: [.library(name: "Utils", targets: ["Utils"])]) misses the version specifier for the dependency, which is required.

4. Final Answer:

   let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0")], targets: [.target(name: "Utils", dependencies: ["Alamofire"])], products: [.library(name: "Utils", targets: ["Utils"])]) -> Option D

5. Quick Check:

   Dependency with version + target dependency + library product = let package = Package(name: "Utils", dependencies: [.package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0")], targets: [.target(name: "Utils", dependencies: ["Alamofire"])], products: [.library(name: "Utils", targets: ["Utils"])]) [OK]

Hint: Specify dependency URL with version and add it to target dependencies. [OK]

Common Mistakes:

• Omitting version in dependency declaration
• Not adding dependency to target's dependencies
• Using executable product instead of library
• Leaving dependencies empty when needed