chore: unit tests

Author: NathanWalker

lib/common/logger/logger.ts

@@ -14,11 +14,12 @@ import {
 import { IDictionary } from "../declarations";
 import { injector } from "../yok";
 import { color } from "../../color";
-const TerminalRenderer = require("marked-terminal");
+import { markedTerminal } from "marked-terminal";
 
 export class Logger implements ILogger {
 	private log4jsLogger: log4js.Logger = null;
-	private passwordRegex = /(password=).*?(['&,]|$)|(password["']?\s*:\s*["']).*?(["'])/i;
+	private passwordRegex =
+		/(password=).*?(['&,]|$)|(password["']?\s*:\s*["']).*?(["'])/i;
 	private passwordReplacement = "$1$3*******$2$4";
 	private defaultLogLevel: LoggerLevel;
 
@@ -61,7 +62,7 @@ export class Logger implements ILogger {
 		if (level === LoggerLevel.TRACE || level === LoggerLevel.ALL) {
 			this.warn(
 				`The "${level}" log level might print some sensitive data like secrets or access tokens in request URLs. Be careful when you share this output.`,
-				{ wrapMessageWithBorders: true }
+				{ wrapMessageWithBorders: true },
 			);
 		}
 	}
@@ -149,9 +150,9 @@ export class Logger implements ILogger {
 			},
 		};
 
-		marked.setOptions({ renderer: new TerminalRenderer(opts) });
+		marked.use(markedTerminal(opts) as any);
 
-		const formattedMessage = marked(util.format.apply(null, args));
+		const formattedMessage = marked.parse(util.format.apply(null, args));
 		this.info(formattedMessage, { [LoggerConfigData.skipNewLine]: true });
 	}
 
@@ -180,17 +181,18 @@ export class Logger implements ILogger {
 
 		(<IDictionary<any>>this.log4jsLogger)[logMethod.toLowerCase()].apply(
 			this.log4jsLogger,
-			data
+			data,
 		);
 
 		for (const prop in logOpts) {
 			this.log4jsLogger.removeContext(prop);
 		}
 	}
 
-	private getLogOptionsForMessage(
-		data: any[]
-	): { data: any[]; [key: string]: any } {
+	private getLogOptionsForMessage(data: any[]): {
+		data: any[];
+		[key: string]: any;
+	} {
 		const loggerOptionKeys = _.keys(LoggerConfigData);
 		const dataToCheck = data.filter((el) => {
 			// objects created with Object.create(null) do not have `hasOwnProperty` function
@@ -238,7 +240,7 @@ export class Logger implements ILogger {
 			if (typeof argument === "string" && !!argument.match(/password/i)) {
 				argument = argument.replace(
 					this.passwordRegex,
-					this.passwordReplacement
+					this.passwordReplacement,
 				);
 			}
 

lib/common/test/unit-tests/errors.ts

@@ -83,38 +83,38 @@ describe("errors", () => {
 		const assertProcessExited = () => {
 			assert.isTrue(
 				isProcessExitCalled,
-				"When the action fails, process.exit must be called."
+				"When the action fails, process.exit must be called.",
 			);
 			assert.equal(
 				processExitCode,
 				127,
-				"When the action fails, process.exit must be called with 127 by default."
+				"When the action fails, process.exit must be called with 127 by default.",
 			);
 		};
 
 		const assertPrintCommandHelpSuggestionIsNotCalled = () => {
 			assert.isFalse(
 				isPrintCommandHelpSuggestionExecuted,
-				"printCommandHelpSuggestion should not be called when the suggestCommandHelp is not set to the exception."
+				"printCommandHelpSuggestion should not be called when the suggestCommandHelp is not set to the exception.",
 			);
 		};
 
 		it("executes the passed action and does not print anything when it is successful", async () => {
 			const { action, printCommandHelpSuggestion } = setupTest();
 			let result = await errors.beginCommand(
 				action,
-				printCommandHelpSuggestion
+				printCommandHelpSuggestion,
 			);
 			assert.isTrue(
 				result,
-				"beginCommand must return the result of the passed action."
+				"beginCommand must return the result of the passed action.",
 			);
 
 			actionResult = false;
 			result = await errors.beginCommand(action, printCommandHelpSuggestion);
 			assert.isFalse(
 				result,
-				"beginCommand must return the result of the passed action."
+				"beginCommand must return the result of the passed action.",
 			);
 			assert.equal(logger.errorOutput, "");
 			assert.equal(logger.output, "");
@@ -136,15 +136,15 @@ describe("errors", () => {
 			const assertCallStack = () => {
 				assert.isTrue(
 					logger.errorOutput.indexOf(errMsg) !== -1,
-					"The error output must contain the error message"
+					"The error output must contain the error message",
 				);
 				assert.isTrue(
-					logger.errorOutput.indexOf("at Generator.next") !== -1,
-					"The error output must contain callstack"
+					logger.errorOutput.indexOf("at next") !== -1,
+					"The error output must contain callstack",
 				);
 				assert.isTrue(
 					logger.errorOutput.indexOf(path.join("lib", "common")) !== -1,
-					"The error output must contain path to lib/common, as this is the location of the file"
+					"The error output must contain path to lib/common, as this is the location of the file",
 				);
 			};
 
@@ -213,7 +213,7 @@ describe("errors", () => {
 			assertProcessExited();
 			assert.isTrue(
 				isPrintCommandHelpSuggestionExecuted,
-				"printCommandHelpSuggestion should be called when the action fails with an error object for which suggestCommandHelp is true."
+				"printCommandHelpSuggestion should be called when the action fails with an error object for which suggestCommandHelp is true.",
 			);
 		});
 
@@ -225,12 +225,12 @@ describe("errors", () => {
 			assert.equal(logger.errorOutput, `${errMsg}\n`);
 			assert.isTrue(
 				isProcessExitCalled,
-				"When the action fails, process.exit must be called."
+				"When the action fails, process.exit must be called.",
 			);
 			assert.equal(
 				processExitCode,
 				errObj.errorCode,
-				`When the action fails, process.exit must be called with ${errObj.errorCode}.`
+				`When the action fails, process.exit must be called with ${errObj.errorCode}.`,
 			);
 		});
 
@@ -242,12 +242,12 @@ describe("errors", () => {
 			assert.equal(logger.errorOutput, `${errMsg}\n`);
 			assert.isTrue(
 				isProcessExitCalled,
-				"When the action fails, process.exit must be called."
+				"When the action fails, process.exit must be called.",
 			);
 			assert.equal(
 				processExitCode,
 				127,
-				"When the action fails, process.exit must be called with 127 by default."
+				"When the action fails, process.exit must be called with 127 by default.",
 			);
 		});
 	});

lib/common/test/unit-tests/file-system.ts

@@ -3,6 +3,7 @@ import * as path from "path";
 import * as temp from "temp";
 import * as hostInfoLib from "../../host-info";
 import { assert, use } from "chai";
+import "chai-as-promised";
 import chaiAsPromised from "chai-as-promised";
 import * as fileSystemFile from "../../file-system";
 import * as childProcessLib from "../../child-process";

lib/common/test/unit-tests/mobile/devices-service.ts

@@ -15,6 +15,7 @@ import { EventEmitter } from "events";
 import { assert, use } from "chai";
 import * as util from "util";
 import * as _ from "lodash";
+import "chai-as-promised";
 import chaiAsPromised from "chai-as-promised";
 
 use(chaiAsPromised);

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "nativescript",
   "main": "./lib/nativescript-cli-lib.js",
-  "version": "8.9.0",
+  "version": "8.9.0-dev.0",
   "author": "NativeScript <[email protected]>",
   "description": "Command-line interface for building NativeScript projects",
   "bin": {
@@ -123,6 +123,7 @@
     "@types/convert-source-map": "2.0.3",
     "@types/glob": "^8.1.0",
     "@types/lodash": "4.17.15",
+    "@types/marked-terminal": "^6.1.1",
     "@types/node": "^20.0.0",
     "@types/npmcli__arborist": "^6.3.0",
     "@types/pacote": "^11.1.8",