pretty-format

What is pretty-format?

The pretty-format npm package is a JavaScript library that allows you to serialize any JavaScript value into a string with a human-readable format. It is particularly useful for snapshot testing, where you want to compare the expected and actual output of your test cases.

What are pretty-format's main functionalities?

Pretty-printing of basic JavaScript types

This feature allows you to convert basic JavaScript types like objects, arrays, strings, numbers, etc., into a nicely formatted string.

const prettyFormat = require('pretty-format');
const value = { foo: 'bar', baz: 42 };
console.log(prettyFormat(value));

Customizing output with plugins

pretty-format supports plugins that can be used to customize the output for specific types of values, such as React elements.

const prettyFormat = require('pretty-format');
const ReactElementPlugin = require('pretty-format/plugins/ReactElement');
const reactElement = <div>Hello World</div>;
console.log(prettyFormat(reactElement, { plugins: [ReactElementPlugin] }));

Minimizing diff output

By using pretty-format in combination with a diffing library like jest-diff, you can minimize the output of diffs to make them easier to read and understand.

const prettyFormat = require('pretty-format');
const diff = require('jest-diff');
const oldValue = { a: 'old', b: 'values' };
const newValue = { a: 'new', b: 'values' };
const difference = diff(prettyFormat(oldValue), prettyFormat(newValue));
console.log(difference);

Other packages similar to pretty-format

chalk

Chalk is a popular npm package for styling terminal strings. While it doesn't serialize objects, it can be used in conjunction with pretty-format to colorize the output, enhancing readability.

util

Util is a core Node.js module that provides a method called 'inspect' for printing objects in a readable format. It is similar to pretty-format but is built into Node.js and does not support plugins.

js-beautify

js-beautify is an npm package that can format HTML, CSS, and JavaScript code. It is more focused on formatting code rather than serializing arbitrary JavaScript values like pretty-format.

README

pretty-format

Stringify any JavaScript value.

Supports objects, arrays (and typed arrays and array buffers), arguments, booleans, dates, errors, functions, Infinity, maps, NaN, null, numbers, regular expressions, sets, strings, symbols, undefined, weak maps, weak sets, and circular data structures.

Installation

$ npm install pretty-format

Usage

var prettyFormat = require('pretty-format');

var obj = { property: {} };
obj.circularReference = obj;
obj[Symbol('foo')] = 'foo';
obj.map = new Map();
obj.map.set('prop', 'value');
obj.array = [1, NaN, Infinity];

console.log(prettyFormat(obj));

Result:

Object {
  "property": Object {},
  "circularReference": [Circular],
  "map": Map {
    "prop" => "value"
  },
  "array": Array [
    1,
    NaN,
    Infinity
  ],
  Symbol(foo): "foo"
}

Plugins

Pretty format also supports adding plugins:

var fooPlugin = {
  test: function(val) {
    return val && val.hasOwnProperty('foo');
  },
  print: function(val, print, indent) {
    return 'Foo: ' + print(val.foo);
  }
};

var obj = { foo: { bar: {} } };

prettyFormat(obj, {
  plugins: [fooPlugin]
});
// Foo: Object {
//   "bar": Object {}
// }

Changelog

23.1.0

Features

• [jest-each] Add pretty-format serialising to each titles (#6357)
• [jest-cli] shouldRunTestSuite watch hook now receives an object with config, testPath and duration (#6350)
• [jest-each] Support one dimensional array of data (#6351)
• [jest-watch] create new package jest-watch to ease custom watch plugin development (#6318)
• [jest-circus] Make hooks in empty describe blocks error (#6320)
• Add a config/CLI option errorOnDeprecated which makes calling deprecated APIs throw hepful error messages (#6339)

Fixes

• [jest-each] Fix pluralising missing arguments error (#6369)
• [jest-each] Stop test title concatenating extra args (#6346)
• [expect] toHaveBeenNthCalledWith/nthCalledWith gives wrong call messages if not matched (#6340)
• [jest-each] Make sure invalid arguments to each points back to the user's code (#6347)
• [expect] toMatchObject throws TypeError when a source property is null (#6313)
• [jest-cli] Normalize slashes in paths in CLI output on Windows (#6310)
• [jest-cli] Fix run beforeAll in excluded suites tests" mode. (#6234)
• [jest-haste-map] Compute SHA-1s for non-tracked files when using Node crawler (#6264)

Chore & Maintenance

• [docs] Improve documentation of mockClear, mockReset, and mockRestore (#6227)
• [jest-each] Refactor each to use shared implementation with core (#6345)
• [jest-each] Update jest-each docs for serialising values into titles (#6337)
• [jest-circus] Add dependency on jest-each (#6309)
• [filenames] Rename "integration-tests" to "e2e" (#6315)
• [docs] Mention the use of commit hash with --changedSince flag (#6330)