wip

Author: tomerd

getting-started/cli-tool/index.md

@@ -94,9 +94,9 @@ This line means that we can now use the `Figlet` module that the `swift-figlet`
 
 ## A small application
 
-Now let’s write a small application with our new dependency. In our  `main.swift`, add the following code:
+Now let’s write a small application with our new dependency. In our `hello_swift.swift`, add the following code:
 
-```swift
+~~~swift
 import Figlet // from the previous step
 
 @main
@@ -106,7 +106,7 @@ struct FigletTool {
     figlet.say("Hello, Swift!")
   }
 }
-```
+~~~
 
 Once we save that, we can run our application with `swift run`
 Assuming everything went well, you should see your application print this to the screen:
@@ -157,7 +157,7 @@ let package = Package(
 
 We can now import the argument parsing module provided by `swift-argument-parser` and use it in our application
 
-```swift
+~~~swift
 import ArgumentParser
 import Figlet
 
@@ -171,7 +171,7 @@ struct FigletTool: ParsableCommand {
     figlet.say(self.input)
   }
 }
-```
+~~~
 
 For more information about how [swift-argument-parser](https://github.com/apple/swift-argument-parser) parses command line options, see [swift-argument-parser documentation](https://github.com/apple/swift-argument-parser) documentation.
 

getting-started/library/index.md

@@ -40,6 +40,7 @@ We can run the tests by running  `swift test`  in our terminal.
 
 ~~~bash
 ❯ swift test
+Building for debugging...
 [3/3] Linking swift-libraryPackageTests
 Test Suite 'All tests' started at 2023-01-03 10:57:52.659
 Test Suite 'swift-libraryPackageTests.xctest' started at 2023-01-03 10:57:52.660
@@ -56,4 +57,62 @@ Test Suite 'All tests' passed at 2023-01-03 10:57:52.664.
 
 ## A small library
 
-Now let’s write a small library
+Now let’s write a small library.
+Replace the example content of `swift-library.swift` with the following code:
+
+~~~swift
+import Foundation
+
+struct Email {
+    public init(_ emailString: String) throws {
+        let regex = #"^\S+@\S+\.\S+$"#
+
+        guard let _ = emailString.range(of: regex, options: .regularExpression) else {
+            throw InvalidEmailError(email: emailString)
+        }
+    }
+}
+
+private struct InvalidEmailError: Error {
+    let email: String
+}
+
+~~~
+
+Now lets add a unit test for this strongly types Email API.  
+Replace the example content of `swift_libraryTests.swift` with the following code:
+
+~~~swift
+@testable import swift_library
+import XCTest
+
+final class swift_libraryTests: XCTestCase {
+    func testEmail() throws {
+        let email = try Email("[email protected]")
+        XCTAssertEqual(email.description, "[email protected]")
+
+        XCTAssertThrowsError(try Email("invalid"))
+    }
+}
+~~~
+
+Once we save that, we can run our application with `swift run`
+Assuming everything went well, we can run the tests successfully again:
+
+~~~no-highlight
+❯ swift test
+Building for debugging...
+[3/3] Linking swift-libraryPackageTests
+Build complete! (0.84s)
+Test Suite 'All tests' started at 2023-01-03 16:22:45.070
+Test Suite 'swift-libraryPackageTests.xctest' started at 2023-01-03 16:22:45.071
+Test Suite 'swift_libraryTests' started at 2023-01-03 16:22:45.071
+Test Case '-[swift_libraryTests.swift_libraryTests testEmail]' started.
+Test Case '-[swift_libraryTests.swift_libraryTests testEmail]' passed (0.005 seconds).
+Test Suite 'swift_libraryTests' passed at 2023-01-03 16:22:45.076.
+	 Executed 1 test, with 0 failures (0 unexpected) in 0.005 (0.005) seconds
+Test Suite 'swift-libraryPackageTests.xctest' passed at 2023-01-03 16:22:45.076.
+	 Executed 1 test, with 0 failures (0 unexpected) in 0.005 (0.005) seconds
+Test Suite 'All tests' passed at 2023-01-03 16:22:45.076.
+	 Executed 1 test, with 0 failures (0 unexpected) in 0.005 (0.007) seconds
+~~~