Merge pull request #3386 from NativeScript/fatme/clean-native-app

feat(sidekick): Support clean option when executing local builds in Sidekick

Author: Fatme

docs/man_pages/project/testing/build-android.md

@@ -13,6 +13,7 @@ Builds the project for Android and produces an APK that you can manually deploy
 
 ### Options
 * `--compileSdk` - Sets the Android SDK that will be used to build the project.
+* `--clean` - If set, forces rebuilding the native application.
 * `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options.
 * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options.
 * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options.

docs/man_pages/project/testing/deploy.md

@@ -21,6 +21,7 @@ Prepares, builds and deploys the project to a connected physical or virtual devi
 
 ### Options<% if(isMacOS) { %> for Android<% } %>
 * `--device` - Deploys the project on the specified connected physical or virtual device.
+* `--clean` - If set, forces rebuilding the native application.
 * `--release` - If set, produces a release build. Otherwise, produces a debug build. When set, you must also specify the `--key-store-*` options.
 * `--key-store-path` - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options.
 * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options.

lib/commands/build.ts

@@ -26,7 +26,6 @@ export class BuildCommandBase extends BundleBase {
 		};
 
 		await this.$platformService.preparePlatform(platformInfo);
-		this.$options.clean = true;
 		const buildConfig: IBuildConfig = {
 			buildForDevice: this.$options.forDevice,
 			projectDir: this.$options.path,

lib/common

@@ -167,8 +167,16 @@ interface ILocalBuildService {
 	 * @return {Promise<string>} Path to the build output.
 	 */
 	build(platform: string, platformBuildOptions: IPlatformBuildData, platformTemplate?: string): Promise<string>;
+	/**
+	 * Removes build artifacts specific to the platform
+	 * @param {ICleanNativeAppData} data Data describing the clean app process
+	 * @returns {void}
+	 */
+	cleanNativeApp(data: ICleanNativeAppData): Promise<void>;
 }
 
+interface ICleanNativeAppData extends IProjectDir, IPlatform { }
+
 interface IPlatformProjectService extends NodeJS.EventEmitter {
 	getPlatformData(projectData: IProjectData): IPlatformData;
 	validate(projectData: IProjectData): Promise<void>;

lib/definitions/project.d.ts

@@ -6,7 +6,9 @@ export class LocalBuildService extends EventEmitter implements ILocalBuildServic
 	constructor(private $projectData: IProjectData,
 		private $mobileHelper: Mobile.IMobileHelper,
 		private $errors: IErrors,
-		private $platformService: IPlatformService) {
+		private $platformsData: IPlatformsData,
+		private $platformService: IPlatformService,
+		private $projectDataService: IProjectDataService) {
 		super();
 	}
 
@@ -41,6 +43,12 @@ export class LocalBuildService extends EventEmitter implements ILocalBuildServic
 		await attachAwaitDetach(BUILD_OUTPUT_EVENT_NAME, this.$platformService, handler, this.$platformService.buildPlatform(platform, platformBuildOptions, this.$projectData));
 		return this.$platformService.lastOutputPath(platform, platformBuildOptions, this.$projectData);
 	}
+
+	public async cleanNativeApp(data: ICleanNativeAppData): Promise<void> {
+		const projectData = this.$projectDataService.getProjectData(data.projectDir);
+		const platformData = this.$platformsData.getPlatformData(data.platform, projectData);
+		await platformData.platformProjectService.cleanProject(platformData.projectRoot, projectData);
+	}
 }
 
 $injector.register("localBuildService", LocalBuildService);

lib/services/local-build-service.ts

@@ -390,6 +390,10 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		});
 
 		const platformData = this.$platformsData.getPlatformData(platform, projectData);
+		if (buildConfig.clean) {
+			await platformData.platformProjectService.cleanProject(platformData.projectRoot, projectData);
+		}
+
 		const handler = (data: any) => {
 			this.emit(constants.BUILD_OUTPUT_EVENT_NAME, data);
 			this.$logger.printInfoMessageOnSameLine(data.data.toString());