feat(command): introduce tns plugin build command which builds android aars

docs(plugin build command): add docs for the new command

Author: petekanev

docs/man_pages/lib-management/plugin-build.md

@@ -0,0 +1,28 @@
+<% if (isJekyll) { %>---
+title: tns plugin build
+position: 8
+---<% } %>
+# tns plugin build
+==========
+
+Usage | Synopsis
+------|-------
+General | `$ tns plugin build`
+
+<% if(isConsole) { %>Attempts to build the plugin's Android-specific project files located in `platforms/android`. Strips and removes `include.gradle` flavor declarations, if any are present. <% } %>
+<% if(isHtml) { %>Attempts to build the plugin's Android-specific project files located in `platforms/android`. The resulting Android Library (aar), and the generated Android Gradle project used to build the library can be found at `platforms/android`. Also strips and removes `include.gradle` flavor declarations, if any are present. For more information about working with plugins, see [NativeScript Plugins](https://github.com/NativeScript/nativescript-cli/blob/master/PLUGINS.md).<% } %>
+
+
+<% if(isHtml) { %>
+### Prerequisites
+
+* Verify that the command is being executed in the source directory of a plugin - e.g. `nativescript-barcodescanner/src`
+
+### Related Commands
+
+Command | Description
+----------|----------
+[plugin](plugin.html) | Lets you manage the plugins for your project.
+[plugin install](plugin-install.html) | Installs the specified plugin and its dependencies.
+[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
+<% } %>

docs/man_pages/lib-management/plugin.md

@@ -19,6 +19,7 @@ Lets you manage the plugins for your project.
 * `update` - Uninstalls and installs the specified plugin(s) and its dependencies.
 * `find` - Finds NativeScript plugins in npm.
 * `search` - Finds NativeScript plugins in npm.
+* `build` - Builds the Android parts of a NativeScript plugin.
 
 <% if(isHtml) { %>
 ### Related Commands
@@ -28,4 +29,5 @@ Command | Description
 [plugin add](plugin-add.html) | Installs the specified plugin and its dependencies.
 [plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
 [plugin update](plugin-update.html) | Updates the specified plugin(s) and its dependencies.
+[plugin build](plugin-build.html) | Builds the Android project of a NativeScript plugin, and updates the `include.gradle`.
 <% } %>

lib/bootstrap.ts

@@ -91,6 +91,7 @@ $injector.requireCommand("plugin|add", "./commands/plugin/add-plugin");
 $injector.requireCommand("plugin|install", "./commands/plugin/add-plugin");
 $injector.requireCommand("plugin|remove", "./commands/plugin/remove-plugin");
 $injector.requireCommand("plugin|update", "./commands/plugin/update-plugin");
+$injector.requireCommand("plugin|build", "./commands/plugin/build-plugin");
 
 $injector.require("doctorService", "./services/doctor-service");
 $injector.require("xcprojService", "./services/xcproj-service");

lib/commands/plugin/build-plugin.ts

@@ -0,0 +1,66 @@
+import { EOL } from "os";
+import * as path from "path";
+import * as constants from "../../constants";
+export class BuildPluginCommand implements ICommand {
+	public allowedParameters: ICommandParameter[] = [];
+	public pluginProjectPath: string;
+
+	constructor(private $androidPluginBuildService: IAndroidPluginBuildService,
+		private $errors: IErrors,
+		private $logger: ILogger,
+		private $fs: IFileSystem,
+		private $options: IOptions) {
+
+		if (this.$options.path) {
+			this.pluginProjectPath = path.resolve(this.$options.path);
+		} else {
+			this.pluginProjectPath = path.resolve(".");
+		}
+	}
+
+	public async execute(args: string[]): Promise<void> {
+		const platformsAndroidPath = path.join(this.pluginProjectPath, constants.PLATFORMS_DIR_NAME, "android");
+		let pluginName = "";
+
+		const pluginPackageJsonPath = path.join(this.pluginProjectPath, constants.PACKAGE_JSON_FILE_NAME);
+
+		if (this.$fs.exists(pluginPackageJsonPath)) {
+			const packageJsonContents = this.$fs.readJson(pluginPackageJsonPath);
+
+			if (packageJsonContents && packageJsonContents["name"]) {
+				pluginName = packageJsonContents["name"];
+			}
+		}
+
+		const tempAndroidProject = path.join(platformsAndroidPath, "android-project");
+
+		const options: IBuildOptions = {
+			aarOutputDir: platformsAndroidPath,
+			platformsAndroidDirPath: platformsAndroidPath,
+			pluginName: pluginName,
+			tempPluginDirPath: tempAndroidProject
+		};
+
+		const androidPluginBuildResult = await this.$androidPluginBuildService.buildAar(options);
+
+		if (androidPluginBuildResult) {
+			this.$logger.info(`${pluginName} successfully built aar at ${platformsAndroidPath}.${EOL}Temporary Android project can be found at ${tempAndroidProject}.`);
+		}
+
+		const migratedIncludeGradle = this.$androidPluginBuildService.migrateIncludeGradle(options);
+
+		if (migratedIncludeGradle) {
+			this.$logger.info(`${pluginName} include gradle updated.`);
+		}
+	}
+
+	public async canExecute(args: string[]): Promise<boolean> {
+		if (!this.$fs.exists(path.join(this.pluginProjectPath, "platforms", "android"))) {
+			this.$errors.failWithoutHelp("No plugin found at the current directory, or the plugin does not need to have its platforms/android components built into an `.aar`.");
+		}
+
+		return true;
+	}
+}
+
+$injector.registerCommand("plugin|build", BuildPluginCommand);

lib/definitions/android-plugin-migrator.d.ts

@@ -11,5 +11,5 @@ interface IAndroidBuildOptions {
 
 interface IAndroidPluginBuildService {
 	buildAar(options: IBuildOptions): Promise<boolean>;
-	migrateIncludeGradle(options: IBuildOptions): void;
+	migrateIncludeGradle(options: IBuildOptions): boolean;
 }

lib/services/android-plugin-build-service.ts

@@ -291,7 +291,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 	 * @param {Object} options
 	 * @param {string} options.platformsAndroidDirPath - The path to the 'plugin/src/platforms/android' directory.
 	 */
-	public migrateIncludeGradle(options: IBuildOptions): void {
+	public migrateIncludeGradle(options: IBuildOptions): boolean {
 		this.validatePlatformsAndroidDirPathOption(options);
 
 		const includeGradleFilePath = path.join(options.platformsAndroidDirPath, INCLUDE_GRADLE_NAME);
@@ -310,10 +310,13 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 				const newIncludeGradleFileContent = includeGradleFileContent.replace(productFlavorsScope, "");
 				this.$fs.writeFile(includeGradleFilePath, newIncludeGradleFileContent);
 
+				return true;
 			} catch (e) {
 				throw new Error(`Failed to write the updated include.gradle in - ${includeGradleFilePath}`);
 			}
 		}
+
+		return false;
 	}
 
 	private validateOptions(options: IBuildOptions): void {

test/stubs.ts

@@ -291,8 +291,8 @@ export class AndroidPluginBuildServiceStub implements IAndroidPluginBuildService
 	buildAar(options: IBuildOptions): Promise<boolean> {
 		return Promise.resolve(true);
 	}
-	migrateIncludeGradle(options: IBuildOptions): void {
-
+	migrateIncludeGradle(options: IBuildOptions): boolean {
+		return true;
 	}
 }