Plugin Guide: Notes for --link option #1416
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added notice, that the linking only works, when the plugin is added after a platform was added and that the linking will be lost if a platform is re-added
erisu
requested changes
Apr 7, 2025
| @@ -194,7 +194,7 @@ cordova plugin add ../path/to/my/plugin/relative/to/project --link | |||
| ``` | |||
|
|
|||
| This creates a symbolic link instead of copying the plugin files, which enables you | |||
| to work on your plugin and then simply rebuild the app to use your changes. | |||
| to work on your plugin and then simply rebuild the app to use your changes. You have to add the plugin after you added the platform, otherwise the link will not work. The link will also be lost, if you re-add a platform. If you do this you have to re-add the plugin. | |||
There was a problem hiding this comment.
Suggested change
| to work on your plugin and then simply rebuild the app to use your changes. You have to add the plugin after you added the platform, otherwise the link will not work. The link will also be lost, if you re-add a platform. If you do this you have to re-add the plugin. | |
| to work on your plugin and then simply rebuild the app to use your changes. The plugin should be added after the platform, or the link will not work. The link will also be lost if you re-add the platform or restore the project. In that case, you'll need to re-add the plugin to restore the link. |
How does the above sound?
There was a problem hiding this comment.
Why did you add a ; in the sentence, can‘t this be a ,? How can you restore a project, what does this mean?
There was a problem hiding this comment.
I used a ";" because they both could be stand-alone sentences.
Update: Decided to replaced ; otherwise with , or.
Example of Restoring a Project
git clone project....npm installcordova prepare
The prepare step will restore the project based on the platforms and plugins that were previously added and stored in package.json and config.xml.
Same applies if your working with an existing project and just running.
rm -rf platforms pluginscordova prepare
There was a problem hiding this comment.
The concept of restoring is documented here: Apache Cordova - Version Management
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added notice, that the linking only works, when the plugin is added after a platform was added and that the linking will be lost if a platform is re-added
Platforms affected
Motivation and Context
Description
Testing
Checklist
(platform)if this change only applies to one platform (e.g.(android))