Gathering detailed insights and metrics for consola
Gathering detailed insights and metrics for consola
Gathering detailed insights and metrics for consola
Gathering detailed insights and metrics for consola
@types/consola
Stub TypeScript definitions entry for consola, which provides its own types definitions
@nitra/consola
consola with filename
@loglayer/transport-consola
consola transport for the LogLayer logging library.
@es-js/consola
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
🐨 Elegant Console Logger for Node.js and Browser
npm install consola
Typescript
Module System
Min. Node Version
Node Version
NPM Version
98.6
Supply Chain
99.6
Quality
82.7
Maintenance
100
Vulnerability
100
License
TypeScript (99.03%)
JavaScript (0.97%)
Total Downloads
1,347,166,066
Last Day
632,794
Last Week
12,966,501
Last Month
55,494,789
Last Year
559,985,799
NOASSERTION License
6,730 Stars
579 Commits
202 Forks
29 Watchers
7 Branches
58 Contributors
Updated on Jul 06, 2025
Minified
Minified + Gzipped
Latest Version
3.4.2
Package Id
consola@3.4.2
Unpacked Size
314.05 kB
Size
81.40 kB
File Count
39
NPM Version
10.9.2
Node Version
22.14.0
Published on
Mar 18, 2025
Cumulative downloads
Total Downloads
Last Day
2.5%
632,794
Compared to previous day
Last Week
-6.8%
12,966,501
Compared to previous week
Last Month
2.5%
55,494,789
Compared to previous month
Last Year
73.3%
559,985,799
Compared to previous year
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:
1npm i consola
Using yarn:
1yarn add consola
Using pnpm:
1pnpm i consola
1// ESM 2import { consola, createConsola } from "consola"; 3 4// CommonJS 5const { consola, createConsola } = require("consola"); 6 7consola.info("Using consola 3.0.0"); 8consola.start("Building project..."); 9consola.warn("A new version of consola is available: 3.0.1"); 10consola.success("Project built!"); 11consola.error(new Error("This is an example error. Everything is fine!")); 12consola.box("I am a simple box"); 13await consola.prompt("Deploy to the production?", { 14 type: "confirm", 15});
Will display in the terminal:
You can use smaller core builds without fancy reporter to save 80% of the bundle size:
1import { consola, createConsola } from "consola/basic"; 2import { consola, createConsola } from "consola/browser"; 3import { 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)
add
Register a custom reporter instance.
removeReporter(reporter?)
remove
, clear
Remove 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)
withScope
Create 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
/resume
Globally pause and resume logs.
Consola will enqueue all logs when paused and then sends them to the reported when resumed.
mockTypes
mock
Mock 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:
1// Jest 2consola.mockTypes((typeName, type) => jest.fn()); 3// Vitest 4consola.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:
1// Jest 2const fn = jest.fn(); 3// Vitest 4const fn = vi.fn(); 5consola.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
:
1// Jest 2consola.mockTypes((typeName) => typeName === "fatal" && jest.fn()); 3// Vitest 4consola.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
1import { createConsola } from "consola"; 2 3const consola = createConsola({ 4 reporters: [ 5 { 6 log: (logObj) => { 7 console.log(JSON.stringify(logObj)); 8 }, 9 }, 10 ], 11}); 12 13// Prints {"date":"2023-04-18T12:43:38.693Z","args":["foo bar"],"type":"log","level":2,"tag":""} 14consola.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 createConsola
consola.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.
1import { createConsola } from "consola"; 2 3const logger = createConsola({ 4 // level: 4, 5 // fancy: true | false 6 // formatOptions: { 7 // columns: 80, 8 // colors: false, 9 // compact: false, 10 // date: false, 11 // }, 12});
1describe("your-consola-mock-test", () => { 2 beforeAll(() => { 3 // Redirect std and console to consola too 4 // Calling this once is sufficient 5 consola.wrapAll(); 6 }); 7 8 beforeEach(() => { 9 // Re-mock consola before each test call to remove 10 // calls from before 11 // Jest 12 consola.mockTypes(() => jest.fn()); 13 // Vitest 14 consola.mockTypes(() => vi.fn()); 15 }); 16 17 test("your test", async () => { 18 // Some code here 19 20 // Let's retrieve all messages of `consola.log` 21 // Get the mock and map all calls to their first argument 22 const consolaMessages = consola.log.mock.calls.map((c) => c[0]); 23 expect(consolaMessages).toContain("your message"); 24 }); 25});
1{
2 new jsdom.VirtualConsole().sendTo(consola);
3}
1// ESM 2import { 3 stripAnsi, 4 centerAlign, 5 rightAlign, 6 leftAlign, 7 align, 8 box, 9 colors, 10 getColor, 11 colorize, 12} from "consola/utils"; 13 14// CommonJS 15const { 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:
1// Prints "hello" 2consola.log({ message: "hello" }); 3 4// Prints "{ message: 'hello' }" 5consola.log.raw({ message: "hello" });
MIT
No vulnerabilities found.
No security vulnerabilities found.