Swift Recipes¶

must provides two Swift recipe types: swift-bin and swift-test.

Quick start¶

Project structure¶

myapp/
├── Package.swift
├── Sources/
│   └── myapp/
│       └── main.swift
├── Tests/
│   └── myappTests/
│       └── myappTests.swift
└── Mustfile.toml

Package.swift¶

import PackageDescription

let package = Package(
    name: "myapp",
    targets: [
        .executableTarget(name: "myapp"),
        .testTarget(name: "myappTests", dependencies: ["myapp"]),
    ]
)

Sources/myapp/main.swift¶

func greet(_ name: String) -> String {
    return "Hello, \(name)!"
}

print(greet("world"))

Tests/myappTests/myappTests.swift¶

import XCTest
@testable import myapp

final class myappTests: XCTestCase {
    func testGreet() {
        XCTAssertEqual(greet("world"), "Hello, world!")
    }
}

Mustfile.toml¶

[project]
name = "myapp"

[recipe.build]
type    = "swift-bin"
package = "."

[recipe.test]
type    = "swift-test"
package = "."
deps    = ["build"]

Build and test¶

$ must build
● build swift-bin myapp
  swift build -c release
  Build complete!

$ must test
● build swift-bin myapp (cached)
● test  swift-test myapp
  swift test
  Test Suite passed. Executed 1 test.

`swift-bin` — Build a binary¶

[recipe.build]
type    = "swift-bin"
package = "."

Runs: swift build -c release (in package directory)

Cache key includes: swift --version, package, env vars.

`swift-test` — Run tests¶

[recipe.test]
type    = "swift-test"
package = "."
deps    = ["build"]

Runs: swift test (in package directory)

Cache strategy: never (test results should always be fresh).

Fields¶

Field	Type	Applies to	Description
`package`	string	all	Package directory path (default `.`)
`deps`	string[]	all	Dependencies
`env`	map	all	Environment variables

All recipes also support these common fields: deps, env, cache ("hash" / "mtime" / "none"), phony (always re-run).

Examples¶

[project]
name = "my-swift-project"

[recipe.build]
type    = "swift-bin"
package = "."

[recipe.test]
type    = "swift-test"
package = "."
deps    = ["build"]