devkitx

Install

Using NPM:

$ npm install devkitx

Using YARN:

$ yarn add devkitx

Usage

const chalks = require('devkitx')
chalks()

Essentials

Development Formatting

The chalk-pretty module can be used to format logs during development:

Transports & Log Processing

Because Node.js operates on a single-threaded event loop, it is strongly advised to handle tasks such as sending, alerting, reformatting, and all log processing in a separate process or thread.

In the context of chalk, these log handlers are referred to as "transports." We recommend running transports within a worker thread using the chalk.transport API for optimal performance and reliability.

For more details see our Transports⇗ document.

Low overhead

Efficient use of resources for logging is crucial. Over time, log messages accumulate, which can cause throttling effects on applications—such as a decrease in requests per second.

In many cases, chalk is over 5x faster than alternatives.

See the Benchmarks document for comparisons.

Bundling support

chalk supports being bundled using tools like webpack or esbuild.

See Bundling document for more information.

Contributing

chalk is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the CONTRIBUTING.md file for more details.

Acknowledgments

This project was kindly sponsored by nearForm. This project is kindly sponsored by Platformatic.

Logo and identity designed by Cosmic Fox Design: https://www.behance.net/cosmicfox.

License

Licensed under MIT.