Docs: Add manual plugin linking instructions for SPM #12979
Conversation
Summary of ChangesHello @sfshaza2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for Swift Package Manager plugin authors by introducing a comprehensive guide on manually adding a local plugin to an Xcode project. This new section provides a crucial workaround for scenarios where automatic plugin linking might encounter issues, ensuring developers have clear instructions to debug and integrate their plugins effectively. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for manually linking a Swift Package Manager plugin in Xcode. The new section is clear and provides a useful fallback for developers. I've found a couple of issues: a stray HTML tag that could break page rendering, and an inconsistently formatted list. My review includes suggestions to fix these points. Overall, a good addition to the documentation.
| {% render "docs/swift-package-manager/migrate-objective-c-plugin.md", site: site %} | ||
|
|
||
| </Tab> | ||
| </Tab> |
There was a problem hiding this comment.
This extra </Tab> tag appears to be a mistake. The surrounding <Tabs> component has two opening <Tab> tags, but this change introduces a third closing </Tab> tag. This will likely break the rendering of the tabbed content on the page. Please remove this line.
| 1. Open `example/ios/Runner.xcworkspace` in Xcode. | ||
|
|
||
| 1. Navigate to **Package Dependencies** for the project. | ||
|
|
||
| 1. Click the <Icon id="add" label="plus/add"></Icon> button. | ||
|
|
||
| 1. In the dialog that opens, click the **Add Local...** button. | ||
|
|
||
| 1. Navigate to your plugin's root iOS directory (the folder containing `Package.swift`) | ||
| and click **Add Package**. | ||
|
|
||
| 1. Select your plugin's library product and ensure it is added to the **Runner** target. | ||
|
|
||
| 1. Click **Add Package**. |
There was a problem hiding this comment.
For consistency with other documentation files in this repository (which use sequential numbering for lists), and to improve the readability of the raw markdown, please update this numbered list to use sequential numbers (1., 2., 3., etc.) instead of using 1. for every item.
| 1. Open `example/ios/Runner.xcworkspace` in Xcode. | |
| 1. Navigate to **Package Dependencies** for the project. | |
| 1. Click the <Icon id="add" label="plus/add"></Icon> button. | |
| 1. In the dialog that opens, click the **Add Local...** button. | |
| 1. Navigate to your plugin's root iOS directory (the folder containing `Package.swift`) | |
| and click **Add Package**. | |
| 1. Select your plugin's library product and ensure it is added to the **Runner** target. | |
| 1. Click **Add Package**. | |
| 1. Open `example/ios/Runner.xcworkspace` in Xcode. | |
| 2. Navigate to **Package Dependencies** for the project. | |
| 3. Click the <Icon id="add" label="plus/add"></Icon> button. | |
| 4. In the dialog that opens, click the **Add Local...** button. | |
| 5. Navigate to your plugin's root iOS directory (the folder containing `Package.swift`) | |
| and click **Add Package**. | |
| 6. Select your plugin's library product and ensure it is added to the **Runner** target. | |
| 7. Click **Add Package**. |
|
Visit the preview URL for this PR (updated for commit edd6ff3): https://flutter-docs-prod--pr12979-fix-issue-12936-manual-plug-wbhhg3ut.web.app |
|
@jmagman Can someone on the iOS team take a look at this? |
3 participants
Fixes #12936. Adds a section to 'Swift Package Manager for plugin authors' explaining how to manually add a plugin as a local package dependency in Xcode, serving as a fallback when automatic linking fails.