The signale npm package is a console logger with various levels of importance, from debugging to fatal errors. It provides an easy way to display colorful and styled log messages in the console. It is designed to be both beautiful and powerful, with custom and configurable loggers.
Customizable Loggers
Allows users to create custom loggers with specific configurations, badges, colors, and labels.
const { Signale } = require('signale');
const options = {
disabled: false,
interactive: false,
logLevel: 'info',
secrets: [],
stream: process.stdout,
types: {
remind: {
badge: '**',
color: 'yellow',
label: 'reminder',
logLevel: 'info'
},
santa: {
badge: '🎅',
color: 'red',
label: 'santa',
logLevel: 'info'
}
}
};
const custom = new Signale(options);
custom.remind('Remember to check your logs!');
custom.santa('Ho Ho Ho! Merry Christmas!');Predefined Loggers
Provides a set of predefined loggers for common logging levels such as success, error, warning, info, and debug.
const signale = require('signale');
signale.success('Operation successful');
signale.error('Something went wrong');
signale.warn('Warning message');
signale.info('Information message');
signale.debug('Debugging message');Interactive Mode
Enables interactive logging, which can be useful for tasks that have a duration, such as pending operations that eventually succeed or fail.
const { Signale } = require('signale');
const interactive = new Signale({ interactive: true, scope: 'custom' });
interactive.pending('Running task');
setTimeout(() => {
interactive.success('Task completed');
}, 1000);Scoped Loggers
Allows the creation of scoped loggers that prefix their output with a given scope, making it easier to distinguish logs from different parts of an application.
const { Signale } = require('signale');
const tasks = new Signale({ scope: 'tasks' });
tasks.info('Starting tasks...');
tasks.complete('All tasks completed!');Winston is a multi-transport async logging library for Node.js. It is designed to be a simple and universal logging library with support for multiple transports. Compared to signale, winston offers more flexibility in terms of transports (e.g., logging to files, databases, etc.) and is widely used in production environments.
Pino is a very low overhead Node.js logger, which focuses on performance. It provides a different set of trade-offs compared to signale, emphasizing speed and low resource usage over user-friendly output.
Debug is a tiny Node.js debugging utility modelled after Node core's debugging technique. It is less about pretty or stylized output and more about providing a simple way to enable or disable debug logs for different parts of an application using environment variables.
Log4js is a logging framework for Node.js, which supports multiple appenders, log levels, and categories. It is similar to the Java logging framework log4j. It is more complex and configurable than signale, suitable for larger applications that require detailed logging control.
Hackable and configurable to the core, signale can be used for logging purposes, status reporting, as well as for handling the output rendering process of other node modules and applications.
Come over to Gitter or Twitter to share your thoughts on the project.
package.jsonnpm install signale
Import signale and start using any of the default loggers.
awaitcompleteerrordebugfatalfavinfonotepausependingstarstartsuccesswarnwatchconst signale = require('signale');
signale.success('Operation successful');
signale.debug('Hello', 'from', 'L59');
signale.pending('Write release notes for 1.2.0');
signale.fatal(new Error('Unable to acquire lock'));
signale.watch('Recursively watching build directory...');
signale.complete({prefix: '[task]', message: 'Fix issue #59', suffix: '(@klauscfhq)'});
To create a custom logger define an options object yielding a types field with the logger data and pass it as argument to a new signale instance.
const {Signale} = require('signale');
const options = {
scope: 'custom',
types: {
remind: {
badge: '**',
color: 'yellow',
label: 'reminder'
},
santa: {
badge: '🎅',
color: 'red',
label: 'santa'
}
}
};
const custom = new Signale(options);
custom.remind('Improve documentation.');
custom.santa('Hoho! You have an unused variable on L45.');
Additionally, all default loggers can be overridden to your own preference.
Here is an example where we override the default error and success loggers.
const {Signale} = require('signale');
const options = {
types: {
error: {
badge: '!!',
color: 'red',
label: 'fatal error'
},
success: {
badge: '++',
color: 'green',
label: 'huge success'
}
}
};
const signale = new Signale();
signale.error('Default Error Log');
signale.success('Default Success Log');
const custom = new Signale(options);
custom.error('Custom Error Log');
custom.success('Custom Success Log');
The options object can hold the scope and types attributes, where the first corresponds to the name of the scope the logger is reporting from and the second is where the objects named after the custom loggers reside.
scopeStringName of the scope.
typesObjectHolds the configuration of the custom and default loggers.
badgeStringThe icon corresponding to the logger.
labelStringThe label used to identify the type of the logger.
colorStringThe color of the label, can be any of the foreground colors supported by chalk.
To create a scoped logger from scratch, define the scope field inside the options object and pass it as argument to a new signale instance.
const {Signale} = require('signale');
const options = {
scope: 'global scope'
};
const global = new Signale(options);
global.success('Successful Operation');
To create a scoped logger based on an already existing one, use the scope() function, which will return a new signale instance, inheriting all custom loggers, timers and configuration from the initial one.
const signale = require('signale');
const global = signale.scope('global scope');
global.success('Hello from the global scope');
function foo() {
const outer = global.scope('outer', 'scope');
outer.success('Hello from the outer scope');
setTimeout(() => {
const inner = outer.scope('inner', 'scope');
inner.success('Hello from the inner scope');
}, 500);
}
foo();
Timer are managed by the time() and timeEnd() functions. A unique label can be used to identify a timer on initialization, though if none is provided the timer will be assigned one automatically. In addition, calling the timeEnd() function without a specified label will have as effect the termination of the most recently initialized timer, that was created without providing a label.
const signale = require('signale');
signale.time('test');
signale.time();
signale.time();
setTimeout(() => {
signale.timeEnd();
signale.timeEnd();
signale.timeEnd('test');
}, 500);
To enable global configuration define the options under the signale namespace in your package.json.
The following illustrates all the available options with their respective default values.
{
"signale": {
"displayScope": true,
"displayBadge": true,
"displayDate": false,
"displayFilename": false,
"displayLabel": true,
"displayTimestamp": false,
"underlineLabel": true,
"underlineMessage": false
}
}
displayScopeBooleantrueDisplay the scope name of the logger.
displayBadgeBooleantrueDisplay the badge of the logger.
displayDateBooleanfalseDisplay the current local date in YY-MM-DD format.
displayFilenameBooleanfalseDisplay the name of the file that the logger is reporting from.
displayLabelBooleantrueDisplay the label of the logger.
displayTimestampBooleanfalseDisplay the current local time in HH:MM:SS format.
underlineLabelBooleantrueUnderline the logger label.
underlineMessageBooleanfalseUnderline the logger message.
To enable local configuration call the config() function on your signale instance. Local configurations will always override any pre-existing configuration inherited from package.json.
In the following example, loggers in the foo.js file will run under their own configuration, overriding the package.json one.
// foo.js
const signale = require('signale');
// Overrides any existing `package.json` config
signale.config({
displayFilename: true,
displayTimestamp: true,
displayDate: false
});
signale.success('Hello from the Global scope');
Also, scoped loggers can have their own independent configuration, overriding the one inherited by the parent instance or package.json.
// foo.js
const signale = require('signale');
signale.config({
displayFilename: true,
displayTimestamp: true,
displayDate: false
});
signale.success('Hello from the Global scope');
function foo() {
// `fooLogger` inherits the config of `signale`
const fooLogger = signale.scope('foo scope');
// Overrides both `signale` and `package.json` configs
fooLogger.config({
displayFilename: true,
displayTimestamp: false,
displayDate: true
});
fooLogger.success('Hello from the foo scope');
}
foo();
<logger>(message[, message]|messageObj|errorObj)loggerFunctionCan be any default or custom logger.
messageStringCan be one or more comma delimited strings.
const signale = require('signale');
signale.success('Successful operation');
//=> ✔ success Successful operation
signale.success('Successful', 'operation');
//=> ✔ success Successful operation
errorObjError ObjectCan be any error object.
const signale = require('signale');
signale.error(new Error('Unsuccessful operation'));
//=> ✖ error Error: Unsuccessful operation
// at Module._compile (module.js:660:30)
// at Object.Module._extensions..js (module.js:671:10)
// ...
messageObjObjectCan be an object holding the prefix, message and suffix attributes, with prefix and suffix always prepended and appended respectively to the logged message.
const signale = require('signale');
signale.complete({prefix: '[task]', message: 'Fix issue #59', suffix: '(@klauscfhq)'});
//=> [task] ☒ complete Fix issue #59 (@klauscfhq)
scope(name[, name])Defines the scope name of the logger.
nameStringCan be one or more comma delimited strings.
const signale = require('signale');
const foo = signale.scope('foo');
const fooBar = signale.scope('foo', 'bar');
foo.success('foo');
//=> [foo] › ✔ success foo
fooBar.success('foo bar');
//=> [foo] [bar] › ✔ success foo bar
unscope()Clears the scope name of the logger.
const signale = require('signale');
const foo = signale.scope('foo');
foo.success('foo');
//=> [foo] › ✔ success foo
foo.unscope();
foo.success('foo');
//=> ✔ success foo
config(settingsObj)Sets the configuration of an instance overriding any existing global or local configuration.
settingsObjObjectCan hold any of the documented options.
// foo.js
const signale = require('signale');
signale.config({
displayFilename: true,
displayTimestamp: true,
displayDate: true
});
signale.success('Successful operations');
//=> [2018-5-15] [11:12:38] [foo.js] › ✔ success Successful operations
time([, label])StringSets a timers and accepts an optional label. If none provided the timer will receive a unique label automatically.
Returns a string corresponding to the timer label.
labelStringLabel corresponding to the timer. Each timer must have its own unique label.
const signale = require('signale');
signale.time();
//=> ▶ timer_0 Initialized timer...
signale.time();
//=> ▶ timer_1 Initialized timer...
signale.time('label');
//=> ▶ label Initialized timer...
timeEnd([, label])ObjectDeactivates the timer to which the given label corresponds. If no label is provided the most recent timer, that was created without providing a label, will be deactivated.
Returns an object {label, span} holding the timer label and the total running time.
labelStringLabel corresponding to the timer, each timer has its own unique label.
const signale = require('signale');
signale.time();
//=> ▶ timer_0 Initialized timer...
signale.time();
//=> ▶ timer_1 Initialized timer...
signale.time('label');
//=> ▶ label Initialized timer...
signale.timeEnd();
//=> ◼ timer_1 Timer run for: 2ms
signale.timeEnd();
//=> ◼ timer_0 Timer run for: 2ms
signale.timeEnd('label');
//=> ◼ label Timer run for: 2ms
For more info on how to contribute to the project, please read the contributing guidelines.
cd signalenpm install or yarn installnpm test or yarn testFAQs
👋 Hackable console logger
The npm package signale receives a total of 745,642 weekly downloads. As such, signale popularity was classified as popular.
We found that signale demonstrated a not healthy version release cadence and project activity because the last version was released 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.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.