Consola

Import the global consola instance or use createConsola to create a new instance. Consola provides various log types like info, start, warn, success, error, and box. It also supports interactive prompts via prompt.

// ESM
import { consola, createConsola } from "consola";

// CommonJS
const { consola, createConsola } = require("consola");

consola.info("Using consola 3.0.0");
consola.start("Building project...");
consola.warn("A new version of consola is available: 3.0.1");
consola.success("Project built!");
consola.error(new Error("This is an example error. Everything is fine!"));
consola.box("I am a simple box");
await consola.prompt("Deploy to the production?", {
  type: "confirm",
});

To reduce bundle size (up to 80%), you can use smaller core builds instead of the full package. Available entry points include consola/basic, consola/browser, and consola/core.

import { consola, createConsola } from "consola/basic";
import { consola, createConsola } from "consola/browser";
import { createConsola } from "consola/core";

You can install Consola using npm, yarn, or pnpm.

npm i consola
# or
yarn add consola
# or
pnpm i consola

To redirect jsdom's virtual console to Consola, use the sendTo method.

{ 
  new jsdom.VirtualConsole().sendTo(consola); 
}

To test Consola output, wrap the environment and mock the types in your test setup.

describe("your-consola-mock-test", () => {
  beforeAll(() => {
    // Redirect std and console to consola too
    consola.wrapAll();
  });

  beforeEach(() => {
    // Re-mock consola before each test call
    // Jest
    consola.mockTypes(() => jest.fn());
    // Vitest
    consola.mockTypes(() => vi.fn());
  });

  test("your test", async () => {
    // ... code ...
    const consolaMessages = consola.log.mock.calls.map((c) => c[0]);
    expect(consolaMessages).toContain("your message");
  });
});

Consola only shows logs with the configured level or below. The default level is 3. You can set the level via createConsola({ level: X }), consola.level = X, or the CONSOLA_LEVEL environment variable (not supported in browser/core builds).

Available levels:

• 0: Fatal and Error
• 1: Warnings
• 2: Normal logs
• 3: Informational logs, success, fail, ready, start, ...
• 4: Debug logs
• 5: Trace logs
• -999: Silent
• +999: Verbose logs

The await prompt(message, { type, cancel }) method shows an input prompt. Supported types are text, confirm, select, or multiselect.

If the user cancels (Ctrl+C), the behavior is determined by the cancel option:

• "default": Resolves with the default or initial value.
• "undefined": Resolves with undefined.
• "null": Resolves with null.
• "symbol": Resolves with Symbol.for("cancel").
• "reject": Rejects the promise with an error.

Consola can globally intercept standard output methods:

• wrapConsole(): Redirects console.log, etc., to Consola.
• wrapStd(): Redirects stdout/stderr to Consola.
• wrapAll(): Redirects both console and std (ensuring console.info maps to the correct type).

Use restoreConsole(), restoreStd(), or restoreAll() to revert these changes.

If you want to log an object that contains message or args properties without Consola interpreting them as log metadata, use the .raw() method chained to any log type.

// Prints "hello"
consola.log({ message: "hello" });

// Prints "{ message: 'hello' }"
consola.log.raw({ message: "hello" });

Consola provides several string and color utilities via consola/utils:

• stripAnsi
• centerAlign, rightAlign, leftAlign, align
• box
• colors, getColor, colorize

// ESM
import {
  stripAnsi,
  centerAlign,
  rightAlign,
  leftAlign,
  align,
  box,
  colors,
  getColor,
  colorize,
} from "consola/utils";