Project structure and Swift Package Manager basics - Step-by-Step Execution

Concept Flow - Project structure and Swift Package Manager basics

Create Package

↓

Package.swift Created

↓

Add Sources & Tests

↓

Build & Test Package

↓

Use Package in Project

↓

Update Dependencies

↓

Package Ready for Use

This flow shows how you create a Swift package, add code and tests, build it, and then use it in your projects.

Execution Sample

Swift

swift package init --type library
ls Sources
swift build
swift test

This code initializes a new Swift package as a library, lists source files, builds the package, and runs tests.

Execution Table

Step	Command/Action	Effect	Output/Result
1	swift package init --type library	Creates Package.swift and folder structure	Package.swift, Sources/, Tests/ folders created
2	ls Sources	Lists source files folder content	lib.swift (empty or template)
3	swift build	Compiles the package code	Build succeeds with no errors
4	swift test	Runs tests in Tests/ folder	Test suite runs, passes or fails
5	Add dependency in Package.swift	Updates dependencies list	Package.swift updated with new dependency
6	swift package update	Fetches and updates dependencies	Dependencies downloaded and updated
7	Use package in Xcode or other project	Imports package modules	Package code available for use
8	Exit	All steps done	Package ready for development and sharing

💡 All package setup and management steps completed successfully

Variable Tracker

Variable	Start	After Step 1	After Step 5	After Step 6	Final
Package.swift	None	Created with default content	Updated with dependencies	Dependencies updated	Ready for build and use
Sources folder	None	Created empty or with template	No change	No change	Contains source code files
Tests folder	None	Created empty or with template	No change	No change	Contains test files
Dependencies	None	None	Declared in Package.swift	Downloaded and updated	Available for build

Key Moments - 3 Insights

Why do we need the Package.swift file?

Package.swift is the manifest file that tells Swift Package Manager how to build your package, what targets it has, and what dependencies it needs. See execution_table step 1 and variable_tracker Package.swift changes.

What happens if you run swift build before adding any source files?

The build will succeed but produce no executable or library because there is no code yet. This is shown in execution_table step 3 where build succeeds but Sources folder is empty or has template.

How do dependencies get added and updated?

You add dependencies by editing Package.swift, then run swift package update to fetch them. This is shown in execution_table steps 5 and 6 and variable_tracker Dependencies row.

Visual Quiz - 3 Questions

Look at the execution_table, what is created after running 'swift package init --type library'?

A Package.swift and folder structure

B Compiled binary

C Test results

D Dependency files

💡 Hint

Check execution_table step 1 for the effect of the init command

At which step are dependencies downloaded and updated?

A Step 3

B Step 6

C Step 2

D Step 4

💡 Hint

Look at execution_table step 6 for dependency update

According to variable_tracker, what is the state of the Sources folder after step 1?

A Contains dependencies

B Does not exist

C Created empty or with template

D Contains compiled binaries

💡 Hint

See variable_tracker row for Sources folder after step 1

Concept Snapshot

Swift Package Manager basics:
- Use 'swift package init --type library' to create a package
- Package.swift defines package info and dependencies
- Sources/ holds code, Tests/ holds tests
- Use 'swift build' to compile, 'swift test' to run tests
- Add dependencies in Package.swift, update with 'swift package update'
- Use package in projects by importing its modules

Full Transcript

This lesson shows how to create and manage a Swift package using Swift Package Manager. First, you run 'swift package init --type library' to create the package structure including Package.swift, Sources, and Tests folders. Package.swift is the key file that defines your package's name, targets, and dependencies. You add your source code inside the Sources folder and tests inside the Tests folder. Running 'swift build' compiles your package, and 'swift test' runs your tests. To add external libraries, you edit Package.swift to add dependencies, then run 'swift package update' to download them. Finally, you can use your package in other projects by importing it. The execution table traces these steps and the variable tracker shows how files and dependencies change. Key moments clarify why Package.swift is important, what happens if you build with no code, and how dependencies are managed.

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