feature: Make changes to package.json for upgrade (RDMR-720, RDMR-721) (#13)

Author: markemer

Package.resolved

@@ -9,6 +9,7 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.5.1"),
         .package(url: "https://github.com/apple/swift-syntax.git", from: "601.0.1"),
+        .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "5.0.0"),
     ],
     targets: [
         .executableTarget(
@@ -36,14 +37,18 @@ let package = Package(
                     .target(name: "JavascriptPackageTools")
                 ]
         ),
-        .target(name: "JavascriptPackageTools"),
+        .target(name: "JavascriptPackageTools",
+                dependencies: [
+                    .product(name: "SwiftyJSON", package: "SwiftyJSON")
+                ]
+        ),
 
         // Test Targets
         .testTarget(name: "JavascriptPackageToolsTests",
                     dependencies: [
                         .target(name: "JavascriptPackageTools"),
                     ],
-                    resources: [.copy("package-test.json")]
+                    resources: [.copy("../Resources/package-new.json")]
         ),
         .testTarget(name: "CapacitorPluginSyntaxToolsTests",
                 dependencies: [

Package.swift

@@ -2,12 +2,12 @@ import Foundation
 import CapacitorPluginSyntaxTools
 import JavascriptPackageTools
 
-enum CapacitorPluginError: Error {
+public enum CapacitorPluginError: Error {
     case objcFileCount(Int)
     case objcHeaderCount(Int)
     case oldPluginMissing
 
-    var message: String {
+    public var message: String {
         switch self {
         case .objcFileCount(let numberOfFiles):
             return "Found \(numberOfFiles) Objective-C *.m files, expected \(numberOfFiles)"
@@ -73,8 +73,8 @@ public class CapacitorPluginPackage {
         return url
     }
 
-    public func findSwiftPluginFile() throws -> URL {
-        guard let oldPlugin else { throw CapacitorPluginError.oldPluginMissing }
+    public func findSwiftPluginFile() throws(CapacitorPluginError)  -> URL {
+        guard let oldPlugin else { throw .oldPluginMissing }
 
         let fileName = "\(oldPlugin.capacitorPlugin.identifier).swift"
 
@@ -86,4 +86,24 @@ public class CapacitorPluginPackage {
 
         return URL(filePath: fileName, directoryHint: .notDirectory, relativeTo: basePathURL)
     }
+    
+    public func updatePackageJSON(for podName: String) throws {
+        try? packageJSONParser.changeScript(named: "verify:ios",
+                                           to: "xcodebuild -scheme \(podName) -destination generic/platform=iOS")
+        
+        var newFiles = packageJSONParser.files
+        
+        newFiles.removeAll(where: { $0 == "ios/Plugin" || $0 == "ios/Plugin/" })
+        
+        if newFiles.contains(where: { $0 != "ios/"}) {
+            newFiles.append("ios/Sources")
+            newFiles.append("ios/Tests")
+        }
+        
+        newFiles.append("Package.swift")
+        
+        packageJSONParser.files = newFiles
+        
+        try packageJSONParser.writePackageJSON()
+    }
 }

Sources/CapacitorPluginTools/CapacitorPluginPackage.swift

@@ -58,6 +58,9 @@ struct Cap2SPM: ParsableCommand {
         try deleteFiles(at: unneededFiles, shouldBackup: shouldBackup)
 
         try modifyGitignores(for: capacitorPluginPackage)
+        
         try moveSourceDirectories(for: capacitorPluginPackage)
+        
+        try capacitorPluginPackage.updatePackageJSON(for: podspec.podName)
     }
 }

Sources/CommandLineTool/cap2spm.swift

@@ -1,19 +1,34 @@
 import Foundation
+import SwiftyJSON
 
-enum PackageJSONError: Error {
+public enum PackageJSONError: Error {
     case noPodspec
+    case scriptEntryNotFound
+    case fileEntryNotFound
+    case jsonStringGenerationFailed
 }
 
 public struct PackageJSONParser: CustomDebugStringConvertible {
     private let package: PackageJSON
-
+    private var json: JSON
+    private let jsonURL: URL
+    
     public var npmName: String {
         package.name
     }
 
     public var version: String {
         package.version
     }
+    
+    public var files: [String] {
+        get {
+            package.files
+        }
+        set {
+            json["files"] = JSON(newValue)
+        }
+    }
 
     public var podspec: String = ""
 
@@ -33,16 +48,36 @@ public struct PackageJSONParser: CustomDebugStringConvertible {
         return plugins
     }
 
-    public var scripts: [String: String] {
-        package.scripts
+    public var jsonString: String? {
+        json.rawString(.utf8, options: [.withoutEscapingSlashes, .prettyPrinted])
     }
 
     public init(with url: URL) throws {
+        jsonURL = url
+        
         let data = try Data(contentsOf: url)
+        json = try JSON(data: data)
+        
         package = try JSONDecoder().decode(PackageJSON.self, from: data)
         podspec = try findPodspec()
     }
 
+    public mutating func changeScript(named: String, to runString: String) throws(PackageJSONError) {
+        if json["scripts"][named] != JSON.null {
+            json["scripts"][named] = JSON(runString)
+        } else {
+            throw .scriptEntryNotFound
+        }
+    }
+    
+    public func writePackageJSON() throws {
+        guard let data = jsonString?.data(using: .utf8) else {
+            throw PackageJSONError.jsonStringGenerationFailed
+        }
+        
+        try data.write(to: jsonURL)
+    }
+    
     public var debugDescription: String {
         """
         NPM Name: \(npmName)
@@ -53,12 +88,12 @@ public struct PackageJSONParser: CustomDebugStringConvertible {
         """
     }
 
-    private func findPodspec() throws -> String {
+    private func findPodspec() throws(PackageJSONError) -> String {
         for file in package.files {
             if file.hasSuffix("podspec") {
                 return file
             }
         }
-        throw PackageJSONError.noPodspec
+        throw .noPodspec
     }
 }

Sources/JavascriptPackageTools/PackageJSONParser.swift

@@ -3,16 +3,33 @@ import Foundation
 import JavascriptPackageTools
 
 struct PackageJSONParserTests {
-    var packageJSONParser: PackageJSONParser
+    let packageJSONParser: PackageJSONParser
 
     init() throws {
-        let testJSON = try #require(Bundle.module.url(forResource: "package-test", withExtension: "json"))
+        let testJSON = try #require(Bundle.module.url(forResource: "package-new", withExtension: "json"))
         packageJSONParser = try PackageJSONParser(with: testJSON)
     }
 
     @Test("Correctly finds the podspec")
     func findsPodSpec() async throws {
         #expect(packageJSONParser.podspec == "Typical.podspec")
     }
-
+    
+    @Test("Can change scripts")
+    func canChangeScript() async throws {
+        var parser = packageJSONParser
+        let oldString = try #require(parser.jsonString)
+        try parser.changeScript(named: "verify:ios", to: "new-test")
+        let calculatedSting = try #require(parser.jsonString)
+        #expect(calculatedSting != oldString)
+    }
+    
+    @Test("Can change files")
+    func canSetFiles() async throws {
+        var parser = packageJSONParser
+        let oldString = try #require(parser.jsonString)
+        parser.files = ["new", "list", "files"]
+        let calculatedSting = try #require(parser.jsonString)
+        #expect(calculatedSting != oldString)
+    }
 }

Tests/JavascriptPackageToolsTests/PackageJSONParserTests.swift

@@ -0,0 +1,96 @@
+{
+  "name": "@capacitor/google-maps",
+  "version": "7.0.2",
+  "description": "Google maps on Capacitor",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "typings": "dist/typings/index.d.ts",
+  "typesVersions": {
+    "<4.1": {
+      "dist/typings/index.d.ts": [
+        "dist/typings/ts_old/index.d.ts"
+      ]
+    }
+  },
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Plugin/",
+    "CapacitorGoogleMaps.podspec"
+  ],
+  "author": "Ionic <[email protected]>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ionic-team/capacitor-google-maps.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ionic-team/capacitor-google-maps/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "google-maps"
+  ],
+  "scripts": {
+    "verify": "pnpm run verify:ios && pnpm run verify:android && pnpm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -sdk iphonesimulator && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "pnpm run build",
+    "lint": "pnpm eslint . --ext ts && pnpm prettier \"./**/*.{css,html,ts,js,java}\" --check && pnpm node-swiftlint lint",
+    "fmt": "pnpm eslint . --ext ts --fix && pnpm prettier \"./**/*.{css,html,ts,js,java}\" --write && pnpm node-swiftlint --fix --format",
+    "docgen": "docgen --api GoogleMapInterface --output-readme README.md --output-json dist/docs.json",
+    "build": "pnpm run clean && pnpm run docgen && tsc && rollup -c rollup.config.js && pnpm run downleveldts",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "pnpm run build",
+    "publish:cocoapod": "pod trunk push ./CapacitorGoogleMaps.podspec --allow-warnings",
+    "downleveldts": "pnpm downlevel-dts dist/typings dist/typings/ts_old --to=3.5",
+    "pack-local": "pnpm run build && pnpm pack && find . -name 'capacitor-google-maps-*tgz' -exec bash -c 'mv $0 capacitor-google-maps.tgz' {} \\; ",
+    "unittest:ios": "xcodebuild test -project ./unit-tests/ios/GoogleMapsPlugin/GoogleMapsPlugin.xcodeproj -scheme TestApp -destination 'platform=iOS Simulator,name=iPhone 12,OS=15.2' | xcpretty && exit ${PIPESTATUS[0]}",
+    "unittest:android": "cd ./unit-tests/android && ./gradlew testDebugUnitTest"
+  },
+  "devDependencies": {
+    "@capacitor/android": "next",
+    "@capacitor/core": "next",
+    "@capacitor/docgen": "0.3.0",
+    "@capacitor/ios": "next",
+    "@ionic/prettier-config": "^1.0.1",
+    "@types/resize-observer-browser": "^0.1.7",
+    "@types/supercluster": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
+    "downlevel-dts": "^0.7.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.25.4",
+    "prettier": "^2.8.8",
+    "prettier-plugin-java": "~2.1.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.78.1",
+    "swiftlint": "^1.0.2",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=7.0.0"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@googlemaps/js-api-loader": "~1.16.8",
+    "@googlemaps/markerclusterer": "~2.5.3",
+    "@types/google.maps": "~3.58.1"
+  }
+}