Merge pull request #10 from NativeScript/milanov/add-method-to-control-sys-info-cache

Add method to control the sys info cache

Author: TsvetanMilanov

README.md

@@ -73,9 +73,12 @@ Library that helps identifying if the environment can be used for development of
 * Module `sysInfo`:
 	- Usage:
 	```TypeScript
-	import { sysInfo } from "nativescript-doctor";
+	import { sysInfo, setShouldCacheSysInfo } from "nativescript-doctor";
 
 	async function main() {
+		// The default value is true. If set to false the result of each check for each element
+		// of the sys info will not be cached.
+		setShouldCacheSysInfo(false);
 		const javaVersion = await sysInfo.getJavaVersion();
 		console.log("java: ", javaVersion);
 
@@ -252,11 +255,24 @@ Library that helps identifying if the environment can be used for development of
 		 */
 		isCocoaPodsUpdateRequired(): Promise<boolean>;
 
+		/**
+		 * Checks if the Android SDK Tools are installed and configured correctly.
+		 * @return {Promise<boolean>} true if the Android SDK Tools are installed and configured correctly.
+		 */
+		isAndroidSdkConfiguredCorrectly(): Promise<boolean>;
+
 		/**
 		 * Returns the whole system information.
 		 * @return {Promise<ISysInfoData>} The system information.
 		 */
 		getSysInfo(): Promise<ISysInfoData>;
+
+		/**
+		 * If set to true each method will cache it's result. The default value is true.
+		 * @param {boolean} shouldCache The cache switch.
+		 * @return {void}
+		 */
+		setShouldCacheSysInfo(shouldCache: boolean): void;
 	}
 
 	interface ISysInfoData {
@@ -393,12 +409,18 @@ Library that helps identifying if the environment can be used for development of
 		 * Information about xcproj.
 		 * @type {string}
 		 */
-		xcprojInfo: IXcprojInfo
+		xcprojInfo: IXcprojInfo;
 
 		/**
 		 * true if the system requires xcproj to build projects successfully and the CocoaPods version is not compatible with the Xcode.
 		 */
 		isCocoaPodsUpdateRequired: boolean;
+
+		/**
+		 * true if the Android SDK Tools are installed and configured correctly.
+		 * @type {boolean}
+		 */
+		isAndroidSdkConfiguredCorrectly: boolean;
 	}
 
 	/**
@@ -417,6 +439,91 @@ Library that helps identifying if the environment can be used for development of
 	}
 	```
 
+* Module `androidToolsInfo`:
+	- Usage:
+	```TypeScript
+	import { androidToolsInfo } from "nativescript-doctor"
+
+	function main() {
+		console.log("path to adb from android home: ", await androidToolsInfo.getPathToAdbFromAndroidHome());
+		console.log("path to emulator executable: ", androidToolsInfo.getPathToEmulatorExecutable());
+		console.log("android tools info: ", androidToolsInfo.getToolsInfo());
+		console.log("ANROID_HOME validation errors: ", await androidToolsInfo.validateAndroidHomeEnvVariable());
+		console.log("android tools info validation errors: ", await androidToolsInfo.validateInfo());
+		console.log("javac validation errors: ", await androidToolsInfo.validateJavacVersion(await sysInfo.getJavaCompilerVersion()));
+	}
+
+	main();
+	```
+	- Interfaces:
+	/**
+	 * Describes methods for getting and validating Android tools.
+	 */
+	interface IAndroidToolsInfo {
+		/**
+		 * Returns the Android tools info.
+		 * @return {NativeScriptDoctor.IAndroidToolsInfoData} returns the Android tools info.
+		 */
+		getToolsInfo(): NativeScriptDoctor.IAndroidToolsInfoData;
+
+		/**
+		 * Checks if the Android tools are valid.
+		 * @return {NativeScriptDoctor.IWarning[]} An array of errors from the validation checks. If there are no errors will return [].
+		 */
+		validateInfo(): NativeScriptDoctor.IWarning[];
+
+		/**
+		 * Checks if the current javac version is valid.
+		 * @param {string} installedJavaVersion The version of javac to check.
+		 * @return {NativeScriptDoctor.IWarning[]} An array of errors from the validation checks. If there are no errors will return [].
+		 */
+		validateJavacVersion(installedJavaVersion: string): NativeScriptDoctor.IWarning[];
+
+		/**
+		 * Returns the path to the adb which is located in ANDROID_HOME.
+		 * @return {Promise<string>} Path to the adb which is located in ANDROID_HOME.
+		 */
+		getPathToAdbFromAndroidHome(): Promise<string>;
+
+		/**
+		 * Checks if the ANDROID_HOME variable is set to the correct folder.
+		 * @return {NativeScriptDoctor.IWarning[]} An array of errors from the validation checks. If there are no errors will return [].
+		 */
+		validateAndroidHomeEnvVariable(): NativeScriptDoctor.IWarning[];
+
+		/**
+		 * Returns the path to the emulator executable.
+		 * @return {string} The path to the emulator executable.
+		 */
+		getPathToEmulatorExecutable(): string;
+	}
+
+	/**
+	 * Describes information about installed Android tools and SDKs.
+	 */
+	interface IAndroidToolsInfoData {
+		/**
+		 * The value of ANDROID_HOME environment variable.
+		 */
+		androidHomeEnvVar: string;
+
+		/**
+		 * The latest installed version of Android Build Tools that satisfies CLI's requirements.
+		 */
+		buildToolsVersion: string;
+
+		/**
+		 * The latest installed version of Android SDK that satisfies CLI's requirements.
+		 */
+		compileSdkVersion: number;
+
+		/**
+		 * The latest installed version of Android Support Repository that satisfies CLI's requirements.
+		 */
+		supportRepositoryVersion: string;
+	}
+	```
+
 * Module `constants`:
 	- Usage:
 	```TypeScript