[SwiftLeeds '23] Delightful Swift CLI applications

Transcript

1. Delightful Swift CLI Applications
2. Senior software engineer based in Manchester Hi! I’m Pol
3. Content creation Apps I am working on Public speaking
4. Content creation Apps I am working on Public speaking
5. Content creation Apps I am working on Public speaking
8. Ask your questions! slido.com #SL23
9. Advanced Swift CLIs Apple frameworks Bundle identifiers Styling libraries Parse arguments Read user input Show SwiftUI views
10. MusiCLI
11. Why though? Low memory footprint Mature ecosystem Cross-platform Statically typed Safely concurrent Familiar
12. Familiar
13. Creating an executable
14. swift package init -- type executable
15. // swift-tools-version: 5.9 import PackageDescription let package = Package( name: "MusiCLI", dependencies: [], targets: [ .executableTarget( name: "MusiCLI", dependencies: [ ] ) ] )
16. // The Swift Programming Language // https: // docs.swift.org/swift-book print("Hello, world!")
17. swift run
18. The first command
19. Best. Library. Ever! https://github.com/apple/swift-argument-parser
20. // swift-tools-version: 5.9 import PackageDescription let package = Package( name: "Musicli", platforms: [.macOS(.v12)], dependencies: [ ], targets: [ .executableTarget( name: "Musicli", dependencies: [] ), ] )
21. // swift-tools-version: 5.9 import PackageDescription let package = Package( name: "Musicli", platforms: [.macOS(.v12)], dependencies: [ .package(url: "https: // github.com/apple/swift-argument-parser.git", exact: "1.2.3") ], targets: [ .executableTarget( name: "Musicli", dependencies: [.product(name: "ArgumentParser", package: "swift-argument-parser")] ), ] )
22. import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { } }
23. import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { } }
24. The file can’t be called main!
26. import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { } }
27. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { } }
28. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } } private func isAppAuthorised() async - > Bool { guard MusicAuthorization.currentStatus != .authorized else { return true } let response = await MusicAuthorization.request() return response == .authorized } }
29. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } } private func isAppAuthorised() async - > Bool { guard MusicAuthorization.currentStatus != .authorized else { return true } let response = await MusicAuthorization.request() return response == .authorized } }
30. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() } private func isAppAuthorised() async - > Bool { guard MusicAuthorization.currentStatus != .authorized else { return true } let response = await MusicAuthorization.request() return response == .authorized } }
31. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: " + song.title) print("Artist: " + song.artistName) print("Album: " + song.albumTitle!) print("Genres: " + song.genreNames.joined(separator: ", ")) print("") } } private func isAppAuthorised() async - > Bool { guard MusicAuthorization.currentStatus != .authorized else { return true } let response = await MusicAuthorization.request() return response == .authorized } }
34. I went down a rabbit hole
40. // swift-tools-version: 5.9 import PackageDescription let package = Package( name: "Musicli", platforms: [.macOS(.v12)], products: [ .executable(name: "Musicli", targets: ["Musicli"]) ], dependencies: [ .package(url: "https: // github.com/apple/swift-argument-parser.git", exact: "1.2.3") ], targets: [ .executableTarget( name: "Musicli", dependencies: [.product(name: "ArgumentParser", package: "swift-argument-parser")], linkerSettings: [ .unsafeFlags([ "-Xlinker", "-sectcreate", "-Xlinker", " __ TEXT", "-Xlinker", " __ info_plist", "-Xlinker", "Sources/Resources/Info.plist" ]) ] ), ] ) https://forums.swift.org/t/swift-package-manager-use-of-info-plist-use-for-apps/6532/13
41. // swift-tools-version: 5.9 import PackageDescription let package = Package( name: "Musicli", platforms: [.macOS(.v12)], products: [ .executable(name: "Musicli", targets: ["Musicli"]) ], dependencies: [ .package(url: "https: // github.com/apple/swift-argument-parser.git", exact: "1.2.3") ], targets: [ .executableTarget( name: "Musicli", dependencies: [.product(name: "ArgumentParser", package: "swift-argument-parser")], linkerSettings: [ .unsafeFlags([ "-Xlinker", "-sectcreate", "-Xlinker", " __ TEXT", "-Xlinker", " __ info_plist", "-Xlinker", "Sources/Resources/Info.plist" ]) ] ), ] ) https://forums.swift.org/t/swift-package-manager-use-of-info-plist-use-for-apps/6532/13
42. Apple DOES use this pattern
47. Find out more about it… https://developer.apple.com/library/archive/documentation/Security/Conceptual/CodeSigningGuide/Procedures/Procedures.html
48. Make it look nicer
51. ANSI escape sequences String sequences Perform operations Unix terminals Windows 10+
52. "Hello, world!" Output print("Hello, world!")
53. "Hello, world!" Output print("\u{1B}[31mHello, world!")
54. print("\u{1B}[1;31mHello, world!") "Hello, world!" Output
56. Do it yourself https://github.com/pakLebah/ANSITerminal Don ’ t!
57. print("Hello, world!") "Hello, world!" Output
58. import ANSITerminal print("Hello, world!") "Hello, world!" Output
59. import ANSITerminal print("Hello, world!".red) "Hello, world!" Output
60. import ANSITerminal print("Hello, world!".red.bold) "Hello, world!" Output
61. ⚠ Something to consider
62. It’s not you, it’s Xcode!
63. Do it yourself https://github.com/dominicegginton/spinner Don ’ t! volume II
64. import MusicKit import ArgumentParser @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: " + song.title) print("Artist: " + song.artistName) print("Album: " + song.albumTitle!) print("Genres: " + song.genreNames.joined(separator: ", ")) print("") } } }
65. import MusicKit import ArgumentParser import Spinner @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: " + song.title) print("Artist: " + song.artistName) print("Album: " + song.albumTitle!) print("Genres: " + song.genreNames.joined(separator: ", ")) print("") } } }
66. import MusicKit import ArgumentParser import Spinner @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let spinner = Spinner(.dots, "Loading music results", color: .green) spinner.start() let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() spinner.stop() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: " + song.title) print("Artist: " + song.artistName) print("Album: " + song.albumTitle!) print("Genres: " + song.genreNames.joined(separator: ", ")) print("") } } }
67. import MusicKit import ArgumentParser import Spinner import ANSITerminal @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let spinner = Spinner(.dots, "Loading music results", color: .green) spinner.start() let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() spinner.stop() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: " + song.title) print("Artist: " + song.artistName) print("Album: " + song.albumTitle!) print("Genres: " + song.genreNames.joined(separator: ", ")) print("") } } }
68. import MusicKit import ArgumentParser import Spinner import ANSITerminal @main struct Musicli: AsyncParsableCommand { func run() async throws { guard await isAppAuthorised() else { return } print("Enter the name of the song you'd like to search for . .. ") guard let query = readLine() else { return } let spinner = Spinner(.dots, "Loading music results", color: .green) spinner.start() let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() spinner.stop() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: ".bold + song.title) print("Artist: ".bold + song.artistName) print("Album: ".bold + song.albumTitle!) print("Genres: ".bold + song.genreNames.joined(separator: ", ")) print("") } } }
70. https://github.com/matteocrippa/awesome-swift#command-line
71. SwiftTUI https://github.com/rensbreur/SwiftTUI
72. Going the extra mile
73. import ArgumentParser import Spinner import MusicKit import ANSITerminal struct Search: AsyncParsableCommand { @Argument(help: "The search parameter used to find a song") var searchQuery: String? func run() async throws { guard await isAppAuthorised(), let query = askUserIfNeeded() else { return } let spinner = Spinner(.dots, "Loading music results", color: .green) spinner.start() let request = MusicCatalogSearchRequest(term: query, types: [Song.self]) let searchResponse = try await request.response() spinner.stop() print("Search results for: '\(query)'") for song in searchResponse.songs { print("Title: ".bold + song.title) print("Artist: ".bold + song.artistName) print("Album: ".bold + song.albumTitle!) print("Genres: ".bold + song.genreNames.joined(separator: ", ")) print("") } } }
74. import ArgumentParser @main struct Musicli: AsyncParsableCommand { static var configuration = CommandConfiguration( subcommands: [Search.self], defaultSubcommand: Search.self ) }
75. import MusicKit import ArgumentParser struct Display: AsyncParsableCommand { func run() async throws { } }
76. import MusicKit import ArgumentParser struct Display: AsyncParsableCommand { @Argument(help: "The song you'd like to display information for") var song: String func run() async throws { } }
77. import MusicKit import ArgumentParser struct Display: AsyncParsableCommand { @Argument(help: "The song you'd like to display information for") var song: String func run() async throws { let request = MusicCatalogSearchRequest(term: song, types: [Song.self]) guard let song = try await request.response().songs.first else { print("Could not find a song to play ... ") return } } }
78. import MusicKit import ArgumentParser struct Display: AsyncParsableCommand { @Argument(help: "The song you'd like to display information for") var song: String func run() async throws { let request = MusicCatalogSearchRequest(term: song, types: [Song.self]) guard let song = try await request.response().songs.first else { print("Could not find a song to play ... ") return } await App(song: song).run() } }
79. import AppKit import MusicKit @MainActor class App { let song: Song let delegate: AppDelegate init(song: Song) { self.song = song self.delegate = AppDelegate(song: song) } func run() { let app = NSApplication.shared app.delegate = delegate app.setActivationPolicy(.regular) app.activate(ignoringOtherApps: true) app.run() } }
80. import AppKit import SwiftUI import MusicKit final class AppDelegate: NSObject, NSApplicationDelegate { var window: NSWindow! let song: Song init(song: Song) { self.song = song } func applicationDidFinishLaunching(_ notification: Notification) { let window = NSWindow( contentRect: .zero, styleMask: [.closable, .resizable, .titled], backing: .buffered, defer: false ) window.contentViewController = NSHostingController( rootView: SongView(song: song) ) window.makeKey() window.center() window.orderFrontRegardless() window.title = "🎶 \(song.title) - \(song.artistName)" self.window = window } }
81. import SwiftUI import MusicKit struct SongView: View { let song: Song var body: some View { ZStack { Color(song.artwork ?. backgroundColor ?? .white) .ignoresSafeArea() VStack(spacing: 8) { AsyncImage(url: song.artwork ?. url(width: 400, height: 400)) { image in image .resizable() .frame(width: 400, height: 400) .clipShape(RoundedRectangle(cornerRadius: 20)) } placeholder: { Text("Loading . .. ") } Text(song.title) .font(.largeTitle) .fontWeight(.heavy) .fontDesign(.rounded) Text("\(song.artistName) − \(song.albumTitle ?? "")") .font(.body) .foregroundStyle(Color(cgColor: song.artwork ?. tertiaryTextColor ?? .black)) } .foregroundStyle(Color(song.artwork ? . primaryTextColor ?? .black)) } .frame(width: 600, height: 600) } }
82. import ArgumentParser @main struct Musicli: AsyncParsableCommand { static var configuration = CommandConfiguration( subcommands: [Search.self], defaultSubcommand: Search.self ) }
83. import ArgumentParser @main struct Musicli: AsyncParsableCommand { static var configuration = CommandConfiguration( subcommands: [Search.self, Display.self], defaultSubcommand: Search.self ) }
85. Ready to ship? polpiella.dev Homebrew, GitHub + CI/CD
86. Build tools!
88. Find me online! bento.me/pol @polpielladev