chore: remove dynamicHelpService and dynamicHelpProvider

Remove `dynamicHelpService` and `dynamicHelpProvider` - they were used when the code between AppBuilder CLI and NativeScript CLI was shared. The idea of the service was to get the help content of ScreenBuilder commands. Now we do not need such logic, so just remove it and clean the code from the unused interfaces.

Author: rosen-vladimirov

lib/bootstrap.ts

@@ -85,7 +85,6 @@ $injector.requireCommand("package-manager|set", "./commands/package-manager-set"
 $injector.requireCommand("package-manager|get", "./commands/package-manager-get");
 
 $injector.require("packageInstallationManager", "./package-installation-manager");
-$injector.require("dynamicHelpProvider", "./dynamic-help-provider");
 
 $injector.require("deviceLogProvider", "./common/mobile/device-log-provider");
 $injector.require("projectFilesProvider", "./providers/project-files-provider");

lib/common/bootstrap.ts

@@ -87,7 +87,6 @@ $injector.require("autoCompletionService", "./services/auto-completion-service")
 $injector.require("processService", "./services/process-service");
 $injector.requirePublic("settingsService", "./services/settings-service");
 $injector.require("opener", "./opener");
-$injector.require("dynamicHelpService", "./services/dynamic-help-service");
 $injector.require("microTemplateService", "./services/micro-templating-service");
 $injector.require("mobileHelper", "./mobile/mobile-helper");
 $injector.require("emulatorHelper", "./mobile/emulator-helper");

lib/common/declarations.d.ts

@@ -819,24 +819,6 @@ interface IHook {
 	fullPath: string;
 }
 
-interface IDynamicHelpService {
-	/**
-	 * Checks if current project's framework is one of the specified as arguments.
-	 * @param args {string[]} Frameworks to be checked.
-	 * @returns {boolean} True in case the current project's framework is one of the passed as args, false otherwise.
-	 */
-	isProjectType(...args: string[]): boolean;
-
-	isPlatform(...args: string[]): boolean;
-
-	/**
-	 * Gives an object containing all required variables that can be used in help content and their values.
-	 * @param {any} Object with one boolean property - `isHtml` - it defines if the help content is generated for html or for console help.
-	 * @returs {IDictionary<any>} Key-value pairs of variables and their values.
-	 */
-	getLocalVariables(options: { isHtml: boolean }): IDictionary<any>;
-}
-
 /**
  * Describes standard username/password type credentials.
  */
@@ -935,22 +917,6 @@ interface IQrCodeImageData {
 	imageData: string;
 }
 
-interface IDynamicHelpProvider {
-	/**
-	 * Checks if current project's framework is one of the specified as arguments.
-	 * @param args {string[]} Frameworks to be checked.
-	 * @returns {boolean} True in case the current project's framework is one of the passed as args, false otherwise.
-	 */
-	isProjectType(args: string[]): boolean;
-
-	/**
-	 * Gives an object containing all required variables that can be used in help content and their values.
-	 * @param {any} Object with one boolean property - `isHtml` - it defines if the help content is generated for html or for console help.
-	 * @returs {IDictionary<any>} Key-value pairs of variables and their values.
-	 */
-	getLocalVariables(options: { isHtml: boolean }): IDictionary<any>;
-}
-
 interface IMicroTemplateService {
 	parseContent(data: string, options: { isHtml: boolean }): Promise<string>;
 }

lib/common/services/dynamic-help-service.ts

@@ -1,21 +1,45 @@
 import * as util from "util";
+import * as os from "os";
+import * as constants from "../constants";
+import { formatListOfNames } from '../helpers';
 
 export class MicroTemplateService implements IMicroTemplateService {
 	private dynamicCallRegex: RegExp;
 
-	constructor(private $dynamicHelpService: IDynamicHelpService,
-		private $injector: IInjector) {
+	constructor(private $injector: IInjector) {
 		// Injector's dynamicCallRegex doesn't have 'g' option, which we need here.
 		// Use ( ) in order to use $1 to get whole expression later
 		this.dynamicCallRegex = new RegExp(util.format("(%s)", this.$injector.dynamicCallRegex.source), "g");
 	}
 
 	public async parseContent(data: string, options: { isHtml: boolean }): Promise<string> {
-		const localVariables = this.$dynamicHelpService.getLocalVariables(options);
+		const localVariables = this.getLocalVariables(options);
 		const compiledTemplate = _.template(data.replace(this.dynamicCallRegex, "this.$injector.getDynamicCallData(\"$1\")"));
 		// When debugging parsing, uncomment the line below:
 		// console.log(compiledTemplate.source);
 		return await compiledTemplate.apply(this, [localVariables]);
 	}
+
+	private isPlatform(...args: string[]): boolean {
+		const platform = os.platform().toLowerCase();
+		return _.some(args, arg => arg.toLowerCase() === platform);
+	}
+
+	private getLocalVariables(options: { isHtml: boolean }): IDictionary<any> {
+		const isHtml = options.isHtml;
+		// in html help we want to show all help. Only CONSOLE specific help(wrapped in if(isConsole) ) must be omitted
+		const localVariables: IDictionary<any> = {
+			constants
+		};
+		localVariables["isLinux"] = isHtml || this.isPlatform("linux");
+		localVariables["isWindows"] = isHtml || this.isPlatform("win32");
+		localVariables["isMacOS"] = isHtml || this.isPlatform("darwin");
+		localVariables["isConsole"] = !isHtml;
+		localVariables["isHtml"] = isHtml;
+		localVariables["formatListOfNames"] = formatListOfNames;
+		localVariables["isJekyll"] = false;
+
+		return localVariables;
+	}
 }
 $injector.register("microTemplateService", MicroTemplateService);

lib/common/services/micro-templating-service.ts

@@ -20,23 +20,6 @@ const createTestInjector = (opts?: { isProjectTypeResult: boolean; isPlatformRes
 	injector.register("logger", CommonLoggerStub);
 
 	opts = opts || { isPlatformResult: true, isProjectTypeResult: true };
-
-	injector.register("dynamicHelpProvider", {
-		getLocalVariables: () => ({})
-	});
-
-	injector.register("dynamicHelpService", {
-		isProjectType: (...args: string[]): boolean => opts.isProjectTypeResult,
-		isPlatform: (...args: string[]): boolean => { return opts.isPlatformResult; },
-		getLocalVariables: (): IDictionary<any> => {
-			const localVariables: IDictionary<any> = {};
-			localVariables["myLocalVar"] = opts.isProjectTypeResult;
-			localVariables["isLinux"] = opts.isPlatformResult;
-			localVariables["isWindows"] = opts.isPlatformResult;
-			localVariables["isMacOS"] = opts.isPlatformResult;
-			return localVariables;
-		}
-	});
 	injector.register("microTemplateService", MicroTemplateService);
 	injector.register("helpService", HelpService);
 	injector.register("opener", {
@@ -53,6 +36,15 @@ const createTestInjector = (opts?: { isProjectTypeResult: boolean; isPlatformRes
 
 	injector.registerCommand("foo", {});
 
+	const microTemplateService: any = injector.resolve("microTemplateService");
+	microTemplateService.getLocalVariables = (): IDictionary<any> => {
+		const localVariables: IDictionary<any> = {};
+		localVariables["myLocalVar"] = opts.isProjectTypeResult;
+		localVariables["isLinux"] = opts.isPlatformResult;
+		localVariables["isWindows"] = opts.isPlatformResult;
+		localVariables["isMacOS"] = opts.isPlatformResult;
+		return localVariables;
+	};
 	return injector;
 };