feat: progress-helper

examples/sample.ts

@@ -6,6 +6,21 @@ async function main() {
   consola.info("Using consola 3.0.0");
   consola.start("Building project...");
   consola.success("Project built!");
+  consola.progress({
+    message: "progress.",
+    overwrite: true,
+    progress: 0.1
+  });
+  consola.progress({
+    message: "progress..",
+    overwrite: true,
+    progress: 0.2
+  });
+  consola.progress({
+    message: "progress...",
+    overwrite: false,
+    progress: 1
+  });
   await consola.prompt("Deploy to the production?", {
     type: "confirm",
   });

src/consola.ts

@@ -284,6 +284,15 @@ export class Consola {
       logObj.args!.push("\n" + logObj.additional.join("\n"));
       delete logObj.additional;
     }
+    if (logObj.progress) {
+      let progress = 0;
+      if (typeof logObj.progress === 'number' && !Number.isNaN(logObj.progress)) {
+        progress = Math.floor(logObj.progress * 100);
+        progress = progress < 0 ? 0 : progress;
+        progress = progress > 100 ? 100 : progress;
+      }
+      logObj.args!.unshift(`[${progress}/100] ${progress}%`);
+    }
 
     // Normalize type and tag to lowercase
     logObj.type = (

src/constants.ts

@@ -17,6 +17,7 @@ export const LogLevels: Record<LogType, number> = {
   debug: 4,
   trace: 5,
   verbose: Number.POSITIVE_INFINITY,
+  progress: 3,
 };
 
 export type LogType =
@@ -37,7 +38,8 @@ export type LogType =
   // Verbose
   | "debug"
   | "trace"
-  | "verbose";
+  | "verbose"
+  | "progress";
 
 export const LogTypes: Record<LogType, Partial<LogObject>> = {
   // Silent
@@ -94,4 +96,8 @@ export const LogTypes: Record<LogType, Partial<LogObject>> = {
   verbose: {
     level: LogLevels.verbose,
   },
+
+  progress: {
+    level: LogLevels.progress,
+  }
 };

src/reporters/basic.ts

@@ -53,7 +53,8 @@ export default class BasicReporter implements ConsolaReporter {
     });
 
     return writeStream(
-      line + "\n",
+      line,
+      // line + "\n",
       logObj.level < 2
         ? ctx.options.stderr || process.stderr
         : ctx.options.stdout || process.stdout

src/reporters/fancy.ts

@@ -12,6 +12,7 @@ export const TYPE_COLOR_MAP: { [k in LogType]?: string } = {
   success: "green",
   ready: "green",
   start: "magenta",
+  progress: "blue",
 };
 
 export const LEVEL_COLOR_MAP: { [k in LogLevel]?: string } = {
@@ -32,6 +33,7 @@ const TYPE_ICONS: { [k in LogType]?: string } = {
   trace: s("→", "→"),
   fail: s("✖", "×"),
   start: s("◐", "o"),
+  progress: s("※", "※"),
   log: "",
 };
 
@@ -105,7 +107,13 @@ export default class FancyReporter extends BasicReporter {
       line += this.formatStack(_err.stack || "");
     }
 
-    return isBadge ? "\n" + line + "\n" : line;
+    const prefix = logObj.type === 'progress' ?
+      "\r" : logObj.overwrite ? '\r' : "";
+    const postfix = logObj.overwrite ? "" : "\n";
+
+    line = prefix + line + postfix;
+    line = isBadge ? "\n" + line + "\n" : line;
+    return line;
   }
 }
 

src/types.ts

@@ -27,6 +27,8 @@ export interface InputLogObject {
   type?: LogType;
   message?: string;
   additional?: string | string[];
+  progress?: number;
+  overwrite?: boolean;
   args?: any[];
   date?: Date;
 }