feat: consola.box

examples/box.ts

@@ -0,0 +1,27 @@
+import { consola } from "./utils";
+
+function main() {
+  consola.box(`I am the default banner`);
+
+  consola.box({
+    title: "Box with options",
+    message: `I am a banner with different options`,
+    style: {
+      padding: 1,
+      borderColor: "magenta",
+      borderStyle: "double-single-rounded",
+    },
+  });
+
+  consola.box({
+    title: "Update available for `consola`",
+    message: `\`v1.0.2\` → \`v2.0.0\`\n\nRun \`npm install -g consola\` to update`,
+    style: {
+      padding: 2,
+      borderColor: "yellow",
+      borderStyle: "rounded",
+    },
+  });
+}
+
+main();

src/constants.ts

@@ -34,6 +34,7 @@ export type LogType =
   | "fail"
   | "ready"
   | "start"
+  | "box"
   // Verbose
   | "debug"
   | "trace"
@@ -79,6 +80,9 @@ export const LogTypes: Record<LogType, Partial<LogObject>> = {
   start: {
     level: LogLevels.info,
   },
+  box: {
+    level: LogLevels.info,
+  },
 
   // Level 4
   debug: {

src/reporters/basic.ts

@@ -2,8 +2,8 @@ import { formatWithOptions } from "node:util";
 import type {
   LogObject,
   ConsolaReporter,
-  ConsolaOptions,
   FormatOptions,
+  ConsolaOptions,
 } from "../types";
 import { parseStack } from "../utils/error";
 import { writeStream } from "../utils/stream";
@@ -39,6 +39,21 @@ export class BasicReporter implements ConsolaReporter {
   formatLogObj(logObj: LogObject, opts: FormatOptions) {
     const message = this.formatArgs(logObj.args, opts);
 
+    if (logObj.type === "box") {
+      return (
+        "\n" +
+        [
+          bracket(logObj.tag),
+          logObj.title && logObj.title,
+          ...message.split("\n"),
+        ]
+          .filter(Boolean)
+          .map((l) => " > " + l)
+          .join("\n") +
+        "\n"
+      );
+    }
+
     return this.filterAndJoin([
       bracket(logObj.type),
       bracket(logObj.tag),

src/reporters/fancy.ts

@@ -4,6 +4,7 @@ import * as colors from "colorette";
 import { parseStack } from "../utils/error";
 import { FormatOptions, LogObject } from "../types";
 import { LogLevel, LogType } from "../constants";
+import { BoxOpts, box } from "../utils/box";
 import { BasicReporter } from "./basic";
 
 export const TYPE_COLOR_MAP: { [k in LogType]?: string } = {
@@ -76,11 +77,24 @@ export class FancyReporter extends BasicReporter {
       "\n"
     );
 
-    const isBadge = (logObj as any).badge ?? logObj.level < 2;
+    if (logObj.type === "box") {
+      return box(
+        highlightBackticks(
+          message + (additional.length > 0 ? "\n" + additional.join("\n") : "")
+        ),
+        {
+          title: logObj.title
+            ? highlightBackticks(logObj.title as string)
+            : undefined,
+          style: logObj.style as BoxOpts["style"],
+        }
+      );
+    }
 
     const date = this.formatDate(logObj.date, opts);
     const coloredDate = date && colors.gray(date);
 
+    const isBadge = (logObj.badge as boolean) ?? logObj.level < 2;
     const type = this.formatType(logObj, isBadge, opts);
 
     const tag = logObj.tag ? colors.gray(logObj.tag) : "";

src/types.ts

@@ -22,7 +22,7 @@ export interface FormatOptions {
   date?: boolean;
   colors?: boolean;
   compact?: boolean | number;
-  [key: string]: any;
+  [key: string]: unknown;
 }
 
 export interface InputLogObject {
@@ -41,6 +41,7 @@ export interface LogObject extends InputLogObject {
   tag: string;
   args: any[];
   date: Date;
+  [key: string]: unknown;
 }
 
 export interface ConsolaReporter {