provided more information to plugin authors #2605
Merged
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
plugin authors needed more information on what files have changed during livesync we no provide this information through hookArgs.filesToSync, which is a string array full with all detected changed files
rosen-vladimirov
approved these changes
Mar 16, 2017
lib/services/platform-service.ts
Outdated
| @@ -257,7 +257,7 @@ export class PlatformService extends EventEmitter implements IPlatformService { | |||
| } | |||
|
|
|||
| @helpers.hook('prepare') | |||
| private async preparePlatformCore(platform: string, appFilesUpdaterOptions: IAppFilesUpdaterOptions, projectData: IProjectData, platformSpecificData: IPlatformSpecificData, changesInfo?: IProjectChangesInfo): Promise<void> { | |||
| private async preparePlatformCore(platform: string, appFilesUpdaterOptions: IAppFilesUpdaterOptions, projectData: IProjectData, platformSpecificData: IPlatformSpecificData, changesInfo?: IProjectChangesInfo, filesToSync?: Array<String>): Promise<void> { | |||
There was a problem hiding this comment.
can you please add a comment above that filesToSync is expected to be used in the hooks, as next time when I see this code, I'll notice that no one is using the non-mandatory parameter and I'll delete it.
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.
Problem:
Plugin authors do unnecessary changes, because they lack the information about files about to be synced. This workflow causes too much trouble, which can be easily avoided if cli provides more information to the plugin authors, who will then be able to handle the erroneous behavior.
Solution:
Introduced
hookArgs.filesToSyncparameter which contains all changed files as a string array. If no files are marked as changedfilesToSyncisundefined.Plugin authors needed more information on what files have changed during livesync and we now provide this information through
hookArgs.filesToSync, which is a string array full with all detected changed files.hookArgsis a parameter of thebefore-(after)-prepare-hook.jsfiles, that gets resolved by an injector.