The consola npm package is a console logger for Node.js and browsers. It provides an easy-to-use API for logging information, warnings, errors, and more, with a focus on developer experience and universal compatibility.
Basic Logging
Consola allows you to log messages at various levels, such as info, warn, and error, which are color-coded and formatted for better readability.
const consola = require('consola');
consola.info('Information message');
consola.warn('Warning message');
consola.error('Error message');Reporters
You can add custom reporters to modify how logs are displayed or processed, giving you control over the logging output.
const consola = require('consola');
consola.addReporter({
log(logObj) {
console.log(logObj.message);
}
});Tagged Logging
Consola supports tagged logging, which allows you to prepend a tag to your log messages, making it easier to filter and identify logs related to specific parts of your application.
const consola = require('consola').withTag('my-tag');
consola.info('Tagged information message');Log Level Control
You can control the log level threshold, which determines the minimum level of logs that will be displayed, allowing you to filter out less important logs in different environments.
const consola = require('consola');
consola.level = 3; // Only display logs with a level of 3 (errors) or higherWinston is a multi-transport async logging library for Node.js. It is similar to consola in that it provides logging capabilities, but it also allows for more complex transport configurations, such as logging to files, databases, or remote services.
Pino is a very low overhead Node.js logger, which focuses on performance. It provides similar logging capabilities to consola but is designed to be as efficient as possible, making it suitable for high-performance applications.
Debug is a tiny Node.js debugging utility that is similar to consola's tagged logging feature. It allows you to create debug instances with different namespaces, which you can enable or disable using environment variables.
Log4js is a logging framework for Node.js, which provides similar functionality to consola. It supports multiple appenders, log levels, and layouts, and it can be configured via JSON configuration files.
Elegant Console Wrapper
👌 Easy to use
💅 Fancy output with fallback for minimal environments
🔌 Pluggable reporters
💻 Consistent command line interface (CLI) experience
🏷 Tag support
🚏 Redirect console and stdout/stderr to consola and easily restore redirect.
🌐 Browser support
⏯ Pause/Resume support
👻 Mocking support
👮♂️ Spam prevention by throttling logs
❯ Interactive prompt support powered by clack
Using npm:
npm i consola
Using yarn:
yarn add consola
Using pnpm:
pnpm i consola
// 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",
});
Will display in the terminal:
You can use smaller core builds without fancy reporter to save 80% of the bundle size:
import { consola, createConsola } from "consola/basic";
import { consola, createConsola } from "consola/browser";
import { createConsola } from "consola/core";
<type>(logObject) <type>(args...)Log to all reporters.
Example: consola.info('Message')
await prompt(message, { type, cancel })Show an input prompt. Type can either of text, confirm, select or multiselect.
If prompt is canceled by user (with Ctrol+C), default value will be resolved by default. This strategy can be configured by setting { cancel: "..." } option:
"default" - Resolve the promise with the default value or initial value."undefined" - Resolve the promise with undefined."null" - Resolve the promise with null."symbol" - Resolve the promise with a symbol Symbol.for("cancel")."reject" - Reject the promise with an error.See examples/prompt.ts for usage examples.
addReporter(reporter)addRegister a custom reporter instance.
removeReporter(reporter?)remove, clearRemove a registered reporter.
If no arguments are passed all reporters will be removed.
setReporters(reporter|reporter[])Replace all reporters.
create(options)Create a new Consola instance and inherit all parent options for defaults.
withDefaults(defaults)Create a new Consola instance with provided defaults
withTag(tag)withScopeCreate a new Consola instance with that tag.
wrapConsole() restoreConsole()Globally redirect all console.log, etc calls to consola handlers.
wrapStd() restoreStd()Globally redirect all stdout/stderr outputs to consola.
wrapAll() restoreAll()Wrap both, std and console.
console uses std in the underlying so calling wrapStd redirects console too.
Benefit of this function is that things like console.info will be correctly redirected to the corresponding type.
pauseLogs() resumeLogs()pause/resumeGlobally pause and resume logs.
Consola will enqueue all logs when paused and then sends them to the reported when resumed.
mockTypesmockMock all types. Useful for using with tests.
The first argument passed to mockTypes should be a callback function accepting (typeName, type) and returning the mocked value:
// Jest
consola.mockTypes((typeName, type) => jest.fn());
// Vitest
consola.mockTypes((typeName, type) => vi.fn());
Please note that with the example above, everything is mocked independently for each type. If you need one mocked fn create it outside:
// Jest
const fn = jest.fn();
// Vitest
const fn = vi.fn();
consola.mockTypes(() => fn);
If callback function returns a falsy value, that type won't be mocked.
For example if you just need to mock consola.fatal:
// Jest
consola.mockTypes((typeName) => typeName === "fatal" && jest.fn());
// Vitest
consola.mockTypes((typeName) => typeName === "fatal" && vi.fn());
NOTE: Any instance of consola that inherits the mocked instance, will apply provided callback again.
This way, mocking works for withTag scoped loggers without need to extra efforts.
Consola ships with 3 built-in reporters out of the box. A fancy colored reporter by default and fallsback to a basic reporter if running in a testing or CI environment detected using unjs/std-env and a basic browser reporter.
You can create a new reporter object that implements { log(logObject): () => { } } interface.
Example: Simple JSON reporter
import { createConsola } from "consola";
const consola = createConsola({
reporters: [
{
log: (logObj) => {
console.log(JSON.stringify(logObj));
},
},
],
});
// Prints {"date":"2023-04-18T12:43:38.693Z","args":["foo bar"],"type":"log","level":2,"tag":""}
consola.log("foo bar");
Consola only shows logs with configured log level or below. (Default is 3)
Available log levels:
0: Fatal and Error1: Warnings2: Normal logs3: Informational logs, success, fail, ready, start, ...4: Debug logs5: Trace logs-999: Silent+999: Verbose logsYou can set the log level by either:
level option to createConsolaconsola.level on instanceCONSOLA_LEVEL environment variable (not supported for browser and core builds).Log types are exposed as consola.[type](...) and each is a preset of styles and log level.
A list of all available built-in types is available here.
Consola has a global instance and is recommended to use everywhere. In case more control is needed, create a new instance.
import { createConsola } from "consola";
const logger = createConsola({
// level: 4,
// fancy: true | false
// formatOptions: {
// columns: 80,
// colors: false,
// compact: false,
// date: false,
// },
});
describe("your-consola-mock-test", () => {
beforeAll(() => {
// Redirect std and console to consola too
// Calling this once is sufficient
consola.wrapAll();
});
beforeEach(() => {
// Re-mock consola before each test call to remove
// calls from before
// Jest
consola.mockTypes(() => jest.fn());
// Vitest
consola.mockTypes(() => vi.fn());
});
test("your test", async () => {
// Some code here
// Let's retrieve all messages of `consola.log`
// Get the mock and map all calls to their first argument
const consolaMessages = consola.log.mock.calls.map((c) => c[0]);
expect(consolaMessages).toContain("your message");
});
});
{
new jsdom.VirtualConsole().sendTo(consola);
}
// ESM
import {
stripAnsi,
centerAlign,
rightAlign,
leftAlign,
align,
box,
colors,
getColor,
colorize,
} from "consola/utils";
// CommonJS
const { stripAnsi } = require("consola/utils");
Objects sent to the reporter could lead to unexpected output when object is close to internal object structure containing either message or args props. To enforce the object to be interpreted as pure object, you can use the raw method chained to any log type.
Example:
// Prints "hello"
consola.log({ message: "hello" });
// Prints "{ message: 'hello' }"
consola.log.raw({ message: "hello" });
MIT
v3.3.0
formatTree utility (#223)cause (#308)select type return value type (#238)FAQs
Elegant Console Wrapper
The npm package consola receives a total of 5,006,739 weekly downloads. As such, consola popularity was classified as popular.
We found that consola demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.