@sinonjs/formatio

What is @sinonjs/formatio?

The @sinonjs/formatio package is a utility for pretty-printing JavaScript values, particularly useful for producing human-readable output of complex objects and structures. It is often used in testing frameworks to format output for assertions and logs.

What are @sinonjs/formatio's main functionalities?

Pretty-printing objects

This feature allows the pretty-printing of objects into a string format that is easy to read, especially useful for debugging or displaying complex data structures in logs.

const formatio = require('@sinonjs/formatio');
const obj = { name: 'Alice', age: 25, details: { hobbies: ['reading', 'cycling'] } };
console.log(formatio.ascii(obj));

Custom depth for formatting

This feature enables control over how deep the formatting should go when converting objects to strings. It helps in avoiding too much verbosity by limiting the depth of object traversal.

const formatio = require('@sinonjs/formatio');
const obj = { name: 'Alice', age: 25, details: { hobbies: ['reading', 'cycling'], location: 'City' } };
console.log(formatio.ascii(obj, { maxDepth: 1 }));

Other packages similar to @sinonjs/formatio

pretty-format

pretty-format is a package developed by Facebook as part of the Jest testing framework. It offers similar functionality to @sinonjs/formatio by providing a way to serialize JavaScript objects into strings for snapshot testing. It supports plugins to handle different types of objects and is more extensible compared to @sinonjs/formatio.

util-inspect

util-inspect is a node module that provides an inspection function similar to Node.js core's util.inspect method. It is used for converting objects into strings for debugging purposes. While it shares similar basic functionality with @sinonjs/formatio, it is more tightly integrated with Node.js's core modules and might offer better performance in a Node.js environment.

README

formatio

The cheesy object formatter

Pretty formatting of arbitrary JavaScript values. Currently only supports ascii formatting, suitable for command-line utilities. Like JSON.stringify, it formats objects recursively, but unlike JSON.stringify, it can handle regular expressions, functions, circular objects and more.

formatio is a general-purpose library. It works in browsers (including old and rowdy ones, like IE6) and Node. It will define itself as an AMD module if you want it to (i.e. if there's a define function available).

Installation

npm install @sinonjs/formatio

Documentation

https://sinonjs.github.io/formatio/

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

Licence

formatio was released under BSD-3