Better log & settingObj in function

Author: moh3n9595

package-lock.json

@@ -31,7 +31,8 @@
  "dependencies": {
  "boxen": "^4.1.0",
  "colors": "^1.4.0",
- "fs-extra": "^8.1.0"
+ "fs-extra": "^8.1.0",
+ "log-update": "^4.0.0"
  },
  "devDependencies": {
  "@types/fs-extra": "^9.0.1",

package.json

@@ -19,6 +19,7 @@ import {
  SettingsFileIOSParamsInterface,
  SettingsFileIOSInterface,
  SettingsFileAndroidInterface,
+ SettingsFileInterface,
 } from "./types";
 
 // Builds for android :
@@ -34,7 +35,7 @@ function buildAndroid(
  const OS = osDetection();
 
  if (!newValues) {
- console.log(logLine);
+ logLine();
  return resolve();
  }
 
@@ -49,8 +50,11 @@ function buildAndroid(
  );
  }
 
- console.log(logLine);
- beautyLog("BUILDING " + newValues.buildName + "...", "info");
+ logLine();
+ beautyLog("building " + newValues.buildName, "info", {
+ boldedTxt: newValues.buildName,
+ loadingLog: true,
+ });
 
  // Set variable :
  try {
@@ -75,7 +79,9 @@ function buildAndroid(
  }
 
  if (stdout.includes("BUILD SUCCESSFUL")) {
- beautyLog(newValues.buildName + " FINISHED", "success");
+ beautyLog(newValues.buildName + " finished", "success", {
+ boldedTxt: newValues.buildName,
+ });
 
  const newPath = path.join(
  ".",
@@ -123,7 +129,7 @@ function buildIOS(
  const iosBuildPath = `/ios/${ARCHIVE_NAME}.xcarchive`;
  const { value: newValues, done } = iosValueGen.next();
  if (!newValues) {
- console.log(logLine);
+ logLine();
  return resolve();
  }
 
@@ -138,8 +144,11 @@ function buildIOS(
  );
  }
 
- console.log(logLine);
- beautyLog("BUILDING " + newValues.buildName + "...", "info");
+ logLine();
+ beautyLog("building " + newValues.buildName, "info", {
+ boldedTxt: newValues.buildName,
+ loadingLog: true,
+ });
 
  // Set variable :
  try {
@@ -161,7 +170,9 @@ function buildIOS(
  }
 
  if (stdout.includes("ARCHIVE SUCCEEDED")) {
- beautyLog(newValues.buildName + " FINISHED", "success");
+ beautyLog(newValues.buildName + " finished", "success", {
+ boldedTxt: newValues.buildName,
+ });
  const newPath = path.join(
  ".",
  `/builds/ios/${newValues.buildName}.xcarchive`
@@ -191,7 +202,7 @@ function buildIOS(
 // Main :
 export default function main(
  platform: PlatformInterface,
- settingFilePath: string
+ settingFilePath: string | SettingsFileInterface
 ): Promise<any> {
  packageInfoLog();
 
@@ -200,11 +211,15 @@ export default function main(
  beautyErrorLog("invalid setting file address!");
  reject(new Error("invalid setting file address!"));
  }
- const parsedSettingFile = initializeSettingFile(
- platform,
- settingFilePath,
- reject
- )!;
+
+ let parsedSettingFile: SettingsFileInterface;
+ if (typeof settingFilePath === "string")
+ parsedSettingFile = initializeSettingFile(
+ platform,
+ settingFilePath,
+ reject
+ )!;
+ else parsedSettingFile = settingFilePath;
 
  const [androidValueGen, iosValueGen] = settingFileParameters(
  platform,
@@ -214,7 +229,9 @@ export default function main(
 
  switch (platform) {
  case "android":
- fs.mkdirSync(buildPathResolver("android"), { recursive: true });
+ fs.mkdirSync(buildPathResolver("android"), {
+ recursive: true,
+ });
  buildAndroid(
  androidValueGen!,
  buildObjectResolver(parsedSettingFile, "android"),
@@ -227,7 +244,9 @@ export default function main(
  beautyErrorLog("ios need mac operating system!");
  return reject(new Error("ios need mac operating system!"));
  }
- fs.mkdirSync(buildPathResolver("ios"), { recursive: true });
+ fs.mkdirSync(buildPathResolver("ios"), {
+ recursive: true,
+ });
  buildIOS(
  iosValueGen!,
  buildObjectResolver(
@@ -239,12 +258,16 @@ export default function main(
  );
  break;
  case "both":
- fs.mkdirSync(buildPathResolver("android"), { recursive: true });
+ fs.mkdirSync(buildPathResolver("android"), {
+ recursive: true,
+ });
  buildAndroid(
  androidValueGen!,
  buildObjectResolver(parsedSettingFile, "android"),
  () => {
- fs.mkdirSync(buildPathResolver("ios"), { recursive: true });
+ fs.mkdirSync(buildPathResolver("ios"), {
+ recursive: true,
+ });
  buildIOS(
  iosValueGen!,
  buildObjectResolver(

src/index.ts

@@ -1,16 +1,38 @@
 import colors from "colors";
 import boxen from "boxen";
+import logUpdate from "log-update";
 import {
  name as packageName,
  version as packageVersion,
  description as packageDescription,
 } from "../package.json";
 
-export const logLine = colors.gray("\n---------------------------------");
+let loadingLogInterval: NodeJS.Timeout;
+let loadingLogTxt: string | boolean;
+
+function loadingLog(txt: string): void {
+ loadingLogTxt = txt;
+ const frames = ["", ".", "..", "..."];
+ let i = 0;
+
+ loadingLogInterval = setInterval(() => {
+ const frame = frames[(i = ++i % frames.length)];
+ logUpdate(txt + `${frame}`);
+ }, 1000);
+}
+
+function clearLoadingLog(): void {
+ clearInterval(loadingLogInterval);
+ logUpdate.clear();
+ logUpdate.done();
+}
+
+export const logLine = (): void =>
+ log(colors.gray("\n---------------------------------"));
 
 // Package info log :
 export function packageInfoLog(): void {
- console.log(
+ log(
  "\n" +
  boxen(
  packageName + " v" + packageVersion + "\n\n " + packageDescription,
@@ -19,23 +41,41 @@ export function packageInfoLog(): void {
  );
 }
 
-export function beautyLog(message: string, type = "warn"): void {
+export interface BeautyLogOptionsInterface {
+ boldedTxt?: string;
+ loadingLog?: boolean;
+}
+
+export function beautyLog(
+ message: string,
+ type = "warn",
+ options = {
+ boldedTxt: "",
+ loadingLog: false,
+ } as BeautyLogOptionsInterface
+): void {
+ message = message.replace(
+ options.boldedTxt!,
+ colors.bold(options.boldedTxt!)
+ );
+ let logTxt = "";
  switch (type) {
  case "warn":
- console.log("\n " + colors.bold(colors.yellow("warn")) + " " + message);
+ logTxt = "\n " + colors.bold(colors.yellow("warn")) + " " + message;
  break;
  case "info":
- console.log("\n " + colors.bold(colors.cyan("info")) + " " + message);
+ logTxt = "\n " + colors.bold(colors.cyan("info")) + " " + message;
  break;
  case "success":
- console.log(
- "\n " + colors.bold(colors.green("success")) + " " + message
- );
+ logTxt = "\n " + colors.bold(colors.green("success")) + " " + message;
  break;
  default:
- console.log("\n " + message);
+ logTxt = "\n " + message;
  break;
  }
+
+ if (options.loadingLog) loadingLog(logTxt);
+ else log(logTxt);
 }
 
 // read error better :
@@ -46,11 +86,23 @@ export function beautyErrorLog(err: string | Error): void {
  } else {
  errMessage = err;
  }
- console.log(
+ log(
  "\n " +
  colors.bold(colors.red("error")) +
  " " +
  errMessage.replace(/\n/g, "\n ") +
  "\n"
  );
 }
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function log(param?: any): void {
+ clearLoadingLog();
+
+ if (loadingLogTxt) {
+ console.log(loadingLogTxt);
+ loadingLogTxt = false;
+ }
+
+ console.log(param);
+}