Swift Package Pluginワークショップ

Transcript

1. Swi$Ͱۀ຿վળϫʔΫγϣοϓ 2022/10/14 @ MoneyForward giginet 1/45
2. ࣗݾ঺հ • @giginet • LINEגࣜձࣾ σΟϕϩούʔΤΫεϖ ϦΤϯε։ൃνʔϜ • Core Contributor of Carthage/fastlane/ XcodeGen etc... • h=ps:/ /github.com/giginet • h=ps:/ /twi=er.com/giginet • ؾܰʹmenBon͍ͯͩ͘͠͞ʂ 2/45
3. ࠓ೔ͷ໨త • ۀ຿վળΛSwi%ͰͰ͖ΔΑ͏ʹ͠Α͏ʂ • Xcode 14͔Β࢖͑ΔΑ͏ʹͳͬͨSwi% Package Pluginʹ͍ͭͯ ֶ΅͏ • ۀ຿վળͷͨΊͷπʔϧΛ࡞ͬͯΈͯɺ໌೔͔Βͷۀ຿Λޮ཰ Խ͠Α͏ʂ 3/45
4. Swi$Ͱۀ຿վળ • Swi% PackageΛ࢖ͬͨΤίγεςϜ͕੔͖ͬͯͨ • ैདྷ͸ผͷݴޠͰߦ͖ͬͯͨࡉ͔ͳλεΫΛSwi%ʹ౷ҰͰ͖Δ • Shell Script • εΫϦϓτݴޠ • Rake, fastlaneͳͲͷλεΫϥϯφʔ 4/45
5. Swi$Ͱॻ͘ར఺ • iOS։ൃऀ͕ଞͷݴޠΛशಘ͢Δඞཁ͕ͳ͍ • Ruby΍Shell ScriptͳͲͷशಘେม • εΫϦϓτݴޠ͸ਏ͍ • ςετ͕ॻ͖΍͍͢ • XCTestͰςετ͕هड़Մೳ 5/45
6. Swi$ PackageΛ࢖ͬͨϢʔςΟϦςΟͷ࡞Γํ • executableTarget • Package Plugin(NEW!!!) 6/45
7. Swi$ͰίϚϯυϥΠϯπʔϧ • Swi% PackageͷexecutableΛ࢖ͬͯ؆୯ʹίϚϯυϥΠϯ ϢʔςΟϦςΟ͕࣮૷Ͱ͖Δ • Swi% ArgumentParserͳͲͷϢʔςΟϦςΟ΋ॆ࣮ 7/45
8. Swi$ Packageͷ࡞੒ $ mkdir MyUsefulTools $ cd MyUsefulTools $ swift package init Creating library package: MyUsefulTools Creating Package.swift Creating README.md Creating .gitignore Creating Sources/ Creating Sources/MyUsefulTools/MyUsefulTools.swift Creating Tests/ Creating Tests/MyUsefulToolsTests/ Creating Tests/MyUsefulToolsTests/MyUsefulToolsTests.swift 8/45
9. xcodeproj? • جૅ஌ࣝɿSwi% Package͸௨ৗͷXcodeϓϩδΣΫτͱҧͬͯ xcodeproj͕ͳ͍ʂ • ࣮͸XcodeͰσΟϨΫτϦΛ௚઀։͚·͢ 9/45
10. Package.swi+ // swift-tools-version: 5.7 // The swift-tools-version declares the minimum version of Swift required to build this package. import PackageDescription let package = Package( name: "MyUsefulTools", products: [ .executable(name: "greeting", targets: ["greeting"]), ], dependencies: [], targets: [ .executableTarget(name: "greeting"), ] ) 10/45
11. σΟϨΫτϦߏ੒ . ├── Package.swift ├── README.md ├── Sources │ └── greeting │ └── main.swift └── Tests └── greetingTests └── CommandTests.swift 11/45
12. σΟϨΫτϦߏ੒ . ├── Package.swift ├── README.md ├── Sources │ └── greeting │ └── main.swift └── Tests └── greetingTests └── CommandTests.swift 11/45
13. import Foundation let arguments = ProcessInfo.processInfo.arguments guard let name = arguments.last, arguments.count >= 2 else { fatalError("name is required") } print("Hello \(name)!") 12/45
14. $ swift run greeting giginet Building for debugging... Build complete! (0.08s) Hello giginet! 13/45
15. Package Plugin(NEW!!!) • Swi% Package ManagerͰ։ൃπʔϧΛ഑෍͢ΔͨΊͷ࢓૊Έ • ैདྷͷ։ൃπʔϧ͸ίϚϯυϥΠϯ্͔Β࣮ߦ͕ඞཁͩͬͨ ͕ɺPluginʹ͢Δ͜ͱͰɺXcode্͔Β؆୯ʹ։ൃϑϩʔʹऔΓ ࠐΉ͜ͱ͕Ͱ͖Δ 14/45
16. Package Pluginͷ෼ྨ • Command Plugin (SE-0332) • Build Tool Plugin (SE-0303) • Prebuild Command • Build Command 15/45
17. Command Pluginͱ͸ • Ϣʔβʔ͕ೳಈతʹ࣮ߦ͢ΔϓϥάΠϯ • Xcode্ͷGUI͔Β࣮ߦՄೳͳίϚϯυΛ഑෍Ͱ͖Δ • ࢖༻ྫɿ • ίʔυϑΥʔϚολ • υΩϡϝϯτࣗಈੜ੒ 16/45
18. 17/45
19. Build Tool Pluginͱ͸ • Ϗϧυ࣌ʹࣗಈతʹ࣮ߦ͢ΔΑ͏ʹ͢ΔϓϥάΠϯ • ࣮ߦλΠϛϯάͰPrebuild CommandͱBuild Commandͷ2छ͕ ͋Δ • ैདྷͷRun Script PhaseΛ؆୯ʹ࠶഑෍Ͱ͖Δ + Swi;Ͱॻ͚Δ 18/45
20. • ྫɿ • Prebuild Command • ίʔυδΣωϨʔλ • Ϧιʔεͷੜ੒ • Build Command • linter 19/45
21. 20/45
22. ࡞ྫɿgiginet/Milepost • h#ps:/ /github.com/giginet/Milepost • GitͷϦϏδϣϯΛ؆୯ʹΞϓϦʹຒΊ ࠐΉBuild Tool Plugin • Ϗϧυ࣌ʹgitίϚϯυΛ࣮ߦͯ͠ revisionͳͲΛऔಘ • BundleʹϦϏδϣϯΛؚΜͩplistΛ ੜ੒ɺσίʔυͯ͠දࣔ 21/45
23. Milepost import PackageDescription let package = Package( name: "Milepost", targets: [ .target( name: "Milepost" ), .plugin( name: "PrepareMilepost", capability: .buildTool(), dependencies: ["bundle-generator"] ), .executableTarget( name: "bundle-generator", dependencies: [ .target(name: "Milepost"), ] ), ] ) 22/45
24. Milepost import PackageDescription let package = Package( name: "Milepost", targets: [ .target( name: "Milepost" ), .plugin( name: "PrepareMilepost", capability: .buildTool(), dependencies: ["bundle-generator"] ), .executableTarget( name: "bundle-generator", dependencies: [ .target(name: "Milepost"), ] ), ] ) 22/45
25. Milepost import PackageDescription let package = Package( name: "Milepost", targets: [ .target( name: "Milepost" ), .plugin( name: "PrepareMilepost", capability: .buildTool(), dependencies: ["bundle-generator"] ), .executableTarget( name: "bundle-generator", dependencies: [ .target(name: "Milepost"), ] ), ] ) 22/45
26. ࢀߟ • Meet Swi) Package Plugins • h4ps:/ /developer.apple.com/videos/play/wwdc2022/110359/ • Create Swi) Package Plugins • h4ps:/ /developer.apple.com/videos/play/wwdc2022/110401 23/45
27. Command Pluginͷ࣮૷ 24/45
28. Package.swi+ // swift-tools-version: 5.7 // The swift-tools-version declares the minimum version of Swift required to build this package. import PackageDescription let package = Package( name: "MyUsefulTools", products: [], dependencies: [], targets: [ .plugin( name: "CommandPlugin", capability: .command( intent: .custom(verb: "Run Something", description: "This is a sample command!"), permissions: [.writeToPackageDirectory(reason: "testing")] ) ) ] ) 25/45
29. σΟϨΫτϦߏ੒ . ├── Package.swift ├── Plugins │ └── MyCommand │ └── Command.swift ├── README.md ├── Sources │ └── greeting │ └── main.swift └── Tests └── greetingTests └── CommandTests.swift 26/45
30. ࡞ͬͨϓϥάΠϯΛϓϩδΣΫτʹೖΕΔ 1. ௨ৗ௨ΓXcode ProjectΛ࡞੒ iOS > Swi2UI AppͳͲ 2. General > Package Dependencies > Add Local... 3. PackageͷϑΥϧμΛ௥Ճ ͜ΕͰ௚઀ΞϓϦଆͷXcodeϓϩδΣΫτ͔ΒϓϥάΠϯ΋ฤू͠ ͯσόοάͰ͖Δ 27/45
31. Command PluginͷॲཧΛ࣮૷ import PackagePlugin import Foundation @main struct MyCommand: CommandPlugin { func performCommand(context: PluginContext, arguments: [String]) async throws { // (ry } } #if canImport(XcodeProjectPlugin) import XcodeProjectPlugin extension MyCommand: XcodeCommandPlugin { func performCommand(context: XcodePluginContext, arguments: [String]) throws { let path = context.xcodeProject.directory.appending("hello.txt") let data = "hello".data(using: .utf8) FileManager.default.createFile(atPath: path.string, contents: data) } } #endif 28/45
32. CommandPluginͱXcodeCommandPlugin • CommandPlugin͸Swi% Package༻ͷϓϥάΠϯ • XcodeͰ࢖͏ʹ͸XcodeCommandPluginͷ࣮૷͕ඞཁ 29/45
33. ࣮ߦʂ 30/45
34. Α͘࢖͏Founda'on • FileManager • ϑΝΠϧૢ࡞ • Process • γΣϧͷ࣮ߦ 31/45
35. ศརͳOSS • swi%-argument-parser • h1ps:/ /github.com/apple/swi%-argument-parser 32/45
36. import ArgumentParser @main struct Repeat: ParsableCommand { @Flag(help: "Include a counter with each repetition.") var includeCounter = false @Option(name: .shortAndLong, help: "The number of times to repeat 'phrase'.") var count: Int? @Argument(help: "The phrase to repeat.") var phrase: String mutating func run() throws { let repeatCount = count ?? 2 for i in 1...repeatCount { if includeCounter { print("\(i): \(phrase)") } else { print(phrase) } } } } 33/45
37. Command Plugin -ps • arguments͔ΒGUIͰ౉ͨ͠Ҿ਺ΛऔΕΔ • Xcode͔Βબ୒ͨ͠λʔήοτ͸["--target", <Target Name>]ͱͯ͠Ҿ਺ʹ౉͞ΕΔ 34/45
38. ϫʔΫγϣοϓ 35/45
39. ϫʔΫγϣοϓ • ۀ຿Ͱ࢖͍ͬͯΔπʔϧΛSwi%ʹҠ২ͯ͠ΈΑ͏ • Package PluginͰ༡ΜͰΈΑ͏ʂ • ʮωλாʯʹ͋ΔΞΠσΟΞ͔ΒԿ͔࡞ͬͯΈΑ͏ • ׬੒͠ͳͯ͘΋΍ͬͯΈ·͠ΐ͏ 36/45
40. ωλா 37/45
41. ςϯϓϨʔτੜ੒ػ • ΫϦʔϯΞʔΩςΫνϟͷςϯϓϨʔτੜ੒ͳͲΛXcode্Ͱ ߦ͑ΔCommand Plugin 38/45
42. όʔδϣϯΛࣗಈͰ͋͛ΔCommand Plugin • Info.plistΛݟͯɺόʔδϣϯΛ্͛Δ͚ͩͷϓϥάΠϯ 39/45
43. ϞοΫࣗಈੜ੒ • ProtocolͷϞοΫੜ੒ͷͨΊͷ࢓૊ΈΛ੔උ • mockolo, Sourcery, swi3-syntaxͳͲΛ࢖ͬͯΈΑ͏ 40/45
44. Linter • ༷ʑͳۀ຿՝୊ͷLinterΛ࡞੒ • swi*-syntaxͳͲΛར༻ • ྫɿdebug import checker 41/45
45. ίʔυࢧԉ • Α͋͘Δఆܕతͳૢ࡞Λ؆୯ʹͰ͖ΔϢʔςΟϦςΟ • ini$alizerͷੜ੒ࢧԉͱ͔ • structΛ public Խ͢Δͱ͔ 42/45
46. Ϧιʔεͷࣗಈੜ੒ • Image Assetͷࣗಈੜ੒ • ը૾ϑΝΠϧ͔ΒࣗಈతʹΞηοτΛੜ੒ • localize bundleͷࣗಈੜ੒ • ιʔείʔυதͷจࣈྻΛऩूͯ͠Localize BundleԽ͢Δ 43/45
47. ීஈͷۀ຿εΫϦϓτΛSwi$ʹҠ২ • Shell Script, RubyͳͲͰॻ͔Ε͍ͯΔϢʔςΟϦςΟΛSwi2Խ 44/45
48. طଘOSSͷϓϥάΠϯରԠ • طଘͷπʔϧͷCommand PluginରԠ • OSSʹߩݙͯ͠ΈΑ͏ • Swi1Gen • LicensePlist • mockolo • dSYMΞοϓϩʔυ 45/45