Skip to content

[content improvements] update cli and library getting started guides #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2023
Merged

[content improvements] update cli and library getting started guides #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6ea107
update cli and library getting started guides
tomerd Aug 17, 2023
bf31aa2
update another figlet package link
alexandersandberg Aug 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions getting-started/cli-swiftpm/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Let’s write a small application with our new Swift development environment.
To start, we’ll use SwiftPM to make a new project for us. In your terminal of choice run:

~~~bash
❯ mkdir MyCLI
❯ cd MyCLI
❯ swift package init --name MyCLI --type executable
$ mkdir MyCLI
$ cd MyCLI
$ swift package init --name MyCLI --type executable
~~~

This will generate a new directory called MyCLI with the following files:
Expand All @@ -42,7 +42,7 @@ In fact, SwiftPM generated a "Hello, world!" project for us, including some unit
We can run the tests by running `swift test` in our terminal.

~~~bash
❯ swift test
$ swift test
Building for debugging...
[6/6] Linking MyCLIPackageTests
Build complete! (16.53s)
Expand All @@ -62,7 +62,7 @@ Test Suite 'All tests' passed at 2023-01-12 13:38:22.398.
We can also run the program by running `swift run` in our terminal.

~~~bash
❯ swift run MyCLI
$ swift run MyCLI
[3/3] Linking MyCLI
Hello, World!
~~~
Expand All @@ -71,7 +71,7 @@ Hello, World!

Swift based applications are usually composed from libraries that provide useful functionality.

In this project, we’ll use a package called [swift-figlet](https://github.com/tomerd/swift-figlet) which will help us make ASCII art.
In this project, we’ll use a package called [example-package-figlet](https://github.com/apple/example-package-figlet) which will help us make ASCII art.

You can find more interesting libraries on [Swift Package Index](https://swiftpackageindex.com) -- the unofficial package index for Swift.

Expand All @@ -88,13 +88,13 @@ name: "MyCLI",
.executable(name: "MyCLI", targets: ["MyCLI"])
],
dependencies: [
.package(url: "https://github.com/tomerd/swift-figlet", branch: "main"),
.package(url: "https://github.com/apple/example-package-figlet", branch: "main"),
],
targets: [
.executableTarget(
name: "MyCLI",
dependencies: [
.product(name: "Figlet", package: "swift-figlet"),
.product(name: "Figlet", package: "example-package-figlet"),
]
),
.testTarget(
Expand All @@ -105,7 +105,7 @@ name: "MyCLI",
)
~~~

Running `swift build` will instruct SwiftPM to install the new dependencies and then proceed to build the code.
Running `swift build` will instruct SwiftPM to download the new dependencies and then proceed to build the code.

Running this command also created a new file for us, `Package.resolved`.
This file is a snapshot of the exact versions of the dependencies we are using locally.
Expand All @@ -116,7 +116,7 @@ To use this dependency, we can open `MyCLI.swift`, remove everything that’s in
import Figlet
~~~

This line means that we can now use the `Figlet` module that the `swift-figlet` package exports.
This line means that we can now use the `Figlet` module that the `example-package-figlet` package exports.

## A small application

Expand Down Expand Up @@ -171,7 +171,7 @@ import PackageDescription
let package = Package(
name: "swift-swift",
dependencies: [
.package(url: "https://github.com/tomerd/swift-figlet", branch: "main"),
.package(url: "https://github.com/apple/example-package-figlet", branch: "main"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
],
products: [
Expand All @@ -181,7 +181,7 @@ let package = Package(
.executableTarget(
name: "MyCLI",
dependencies: [
.product(name: "Figlet", package: "swift-figlet"),
.product(name: "Figlet", package: "example-package-figlet"),
.product(name: "ArgumentParser", package: "swift-argument-parser"),
]
),
Expand Down
10 changes: 5 additions & 5 deletions getting-started/library-swiftpm/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ title: Build a library

## Bootstrapping

Let’s write a small application with our new Swift development environment.
Let’s write a small library with our new Swift development environment.
To start, we’ll use SwiftPM to make a new project for us. In your terminal of choice run:

~~~bash
❯ mkdir MyLibrary
❯ cd MyLibrary
❯ swift package init --name MyLibrary --type library
$ mkdir MyLibrary
$ cd MyLibrary
$ swift package init --name MyLibrary --type library
~~~

This will generate a new directory called _MyLibrary_ with the following files:
Expand All @@ -41,7 +41,7 @@ In fact, SwiftPM generated a "Hello, world!" project for us, including some unit
We can run the tests by running `swift test` in our terminal.

~~~bash
❯ swift test
$ swift test
Building for debugging...
[4/4] Compiling MyLibraryTests MyLibraryTests.swift
Build complete! (1.30s)
Expand Down