capacitor-plugin-spm-support
Guides the agent through adding Swift Package Manager (SPM) support to an existing Capacitor plugin. Covers creating a Package.swift manifest, replacing Objective-C bridge files with the CAPBridgedPlugin Swift protocol, updating .gitignore for SPM artifacts, cleaning up the Xcode project file, and updating package.json. Do not use for Capacitor app projects, creating new plugins from scratch, or non-Capacitor plugin frameworks.
capawesome-team · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add capawesome-team/skills --skill capacitor-plugin-spm-support技能说明
name: capacitor-plugin-spm-support description: "Guides the agent through adding Swift Package Manager (SPM) support to an existing Capacitor plugin. Covers creating a Package.swift manifest, replacing Objective-C bridge files with the CAPBridgedPlugin Swift protocol, updating .gitignore for SPM artifacts, cleaning up the Xcode project file, and updating package.json. Do not use for Capacitor app projects, creating new plugins from scratch, or non-Capacitor plugin frameworks." license: MIT compatibility: "Requires Node.js, npm, and Xcode 15+ with Swift 5.9+ on macOS." metadata: author: capawesome-team source: https://github.com/capawesome-team/skills/tree/main/skills/capacitor-plugin-spm-support
Add SPM Support to a Capacitor Plugin
Add Swift Package Manager (SPM) support to an existing Capacitor plugin by replacing the Objective-C bridge with the CAPBridgedPlugin Swift protocol and adding a Package.swift manifest.
Prerequisites
| Requirement | Version |
|---|---|
| Capacitor | 6+ |
| Swift | 5.9+ |
| Xcode | 15+ |
The project must be a Capacitor plugin (not an app project). The plugin must have an existing iOS implementation with Swift source files in ios/Plugin/.
Procedures
Step 1: Gather Plugin Information
- Read
package.jsonin the plugin root. Extract:- The plugin package name (e.g.,
@capawesome/capacitor-app-review). - The existing
filesarray entries. - The existing
scriptsentries.
- The plugin package name (e.g.,
- Read the
.podspecfile in the plugin root. Extract:- The pod name (the
Pod::Spec.newargument, e.g.,CapawesomeCapacitorAppReview). This becomes the SPM package name. - The iOS deployment target from
s.ios.deployment_target(e.g.,'13.0'). Extract the major version number (e.g.,13). This becomes the SPM iOS version. - All third-party CocoaPods dependencies — any
s.dependencyorspec.dependencyentries that are notCapacitororCapacitorCordova. Record each dependency name and version constraint.
- The pod name (the
- Identify the plugin Swift file in
ios/Plugin/. It contains a class extendingCAPPluginwith@objc(<PluginClassName>). Extract:- The plugin class name (e.g.,
AppReviewPlugin). - The JavaScript name from the Objective-C
.mfile'sCAP_PLUGINmacro first string argument (e.g.,AppReview). - All plugin methods from
CAP_PLUGIN_METHODmacro calls in the.mfile, noting each method's name and return type (e.g.,CAPPluginReturnPromise).
- The plugin class name (e.g.,
- Identify the Objective-C bridge files in
ios/Plugin/:<PluginClassName>.h(header file)<PluginClassName>.m(implementation file withCAP_PLUGINmacro)
- Read the Capacitor peer dependency version from
package.json(peerDependencies["@capacitor/core"]). Determine the major version (e.g.,6). This is the Capacitor major version.
Step 2: Resolve CocoaPods Dependencies for SPM
Skip this step if no third-party CocoaPods dependencies were found in Step 1.
For each third-party CocoaPods dependency, an equivalent SPM-compatible package is needed. Present the list of dependencies to the user and ask whether they can provide the SPM package URLs themselves, or whether the agent should search the web for SPM equivalents.
If the user provides SPM package URLs: Record them and proceed to Step 3.
If the user requests a web search: For each CocoaPods dependency:
- Search the web for
"<dependency_name>" Swift Package Managerto determine whether the original CocoaPods dependency also supports SPM. Many popular libraries (e.g., Firebase, Alamofire) distribute via both CocoaPods and SPM from the same repository. - If the original library supports SPM, use its Git repository URL. Use the same version as specified in the podspec — convert the CocoaPods version constraint to the SPM equivalent (e.g.,
~> 5.0becomes.upToNextMajor(from: "5.0.0"),= 2.1.0becomes.exact("2.1.0")). - If the original library does not support SPM, search for
"<dependency_name>" SPM alternativeto find a replacement package that provides equivalent functionality via SPM. Use a version that is compatible with the version used in the podspec. - If no SPM-compatible alternative exists, inform the user and ask how to proceed.
Record the resolved SPM package URL, version requirement, and product name(s) for each dependency. These will be added to Package.swift in the next step.
Step 3: Create Package.swift
Create Package.swift in the plugin root directory with the following content:
// swift-tools-version: 5.9
import PackageDescription
let package = Package(
name: "<SPM_PACKAGE_NAME>",
platforms: [.iOS(.v<SPM_IOS_VERSION>)],
products: [
.library(
name: "<SPM_PACKAGE_NAME>",
targets: ["<PLUGIN_CLASS_NAME>"])
],
dependencies: [
.package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "<CAPACITOR_MAJOR_VERSION>.0.0")
// <ADDITIONAL_PACKAGE_DEPENDENCIES>
],
targets: [
.target(
name: "<PLUGIN_CLASS_NAME>",
dependencies: [
.product(name: "Capacitor", package: "capacitor-swift-pm"),
.product(name: "Cordova", package: "capacitor-swift-pm")
// <ADDITIONAL_TARGET_DEPENDENCIES>
],
path: "ios/Plugin"),
.testTarget(
name: "<PLUGIN_CLASS_NAME>Tests",
dependencies: ["<PLUGIN_CLASS_NAME>"],
path: "ios/PluginTests")
]
)
Replace all placeholders:
<SPM_IOS_VERSION>— the SPM iOS version from Step 1 (e.g.,13).<SPM_PACKAGE_NAME>— the pod name from Step 1 (e.g.,CapawesomeCapacitorAppReview).<PLUGIN_CLASS_NAME>— the plugin class name from Step 1 (e.g.,AppReviewPlugin).<CAPACITOR_MAJOR_VERSION>— the Capacitor major version from Step 1 (e.g