Skip to content

docs: structure SPM plugin changes and add missing step #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
Merged

docs: structure SPM plugin changes and add missing step #439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions docs/main/ios/spm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,27 +124,29 @@ At this point you're done and can build and work as normal.

If your plugin only contains Swift aside from the required `[Name]Plugin.m` and `[Name]Plugin.h` you can use the [capacitor-plugin-converter](https://github.com/ionic-team/capacitor-plugin-converter).

This tool will add the following required things to your main swift plugin file, `[Name]Plugin.swift`:

- Add Conformance to the `CAPBridgedPlugin` protocol to your class
- Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`
- `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro
- `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro
- `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro
This tool will do the following changes:

- Add the following required things to your main swift plugin file, `[Name]Plugin.swift`:
- Add Conformance to the `CAPBridgedPlugin` protocol to your class.
- Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`:
- `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro.
- `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro.
- `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro.
- A `Package.swift` file will be created at the root of your plugin folder.
- The following files will be removed as they are no longer needed:
- `Plugin.xcodeproj`
- `Plugin.xcworkspace`
- `Plugin/Info.plist`
- `PluginTests/Info.plist`
- `Podfile`
- To fit SPM best practices, the Project files will be moved to `Sources` and `Tests` directories
- The plugins `package.json` will get the following fixes:
- To fit SPM best practices, the Project files will be moved to `Sources` and `Tests` directories.
- The plugins `package.json` will get the following changes:
- The files array will add these files or directories:
- `ios/Sources`
- `ios/Tests`
- `Package.swift`
- `verify:ios` will be changed to `xcodebuild -scheme YourPluginName -destination generic/platform=iOS` to allow it to continue to work as you expect.
- Your plugin podspec will be changed so that `s.source_files` now points to the `Sources` directory rather than the `Plugin` directory
- Your plugin podspec will be changed so that `s.source_files` now points to the `Sources` directory rather than the `Plugin` directory.


See the documentation in the repository at [capacitor-plugin-converter](https://github.com/ionic-team/capacitor-plugin-converter) for more.
Expand Down