power-assert-formatter

What is power-assert-formatter?

The power-assert-formatter npm package is a tool used to format assertion messages in a more readable and expressive way. It is part of the power-assert family, which aims to provide better assertion messages for JavaScript testing.

What are power-assert-formatter's main functionalities?

Customizable Output

This feature allows you to customize the output of assertion messages. You can set options like `lineDiffThreshold` and `maxDepth` to control how detailed the output should be.

const assert = require('assert');
const formatter = require('power-assert-formatter');

const options = {
  lineDiffThreshold: 5,
  maxDepth: 3
};
const format = formatter(options);

try {
  assert.equal(1, 2);
} catch (e) {
  console.log(format(e));
}

Enhanced Assertion Messages

This feature enhances the default assertion messages to make them more readable and informative. It provides a clear and detailed explanation of why the assertion failed.

const assert = require('assert');
const formatter = require('power-assert-formatter');

const format = formatter();

try {
  assert.strictEqual(1, 2);
} catch (e) {
  console.log(format(e));
}

Integration with Testing Frameworks

This feature allows you to integrate power-assert-formatter with popular testing frameworks like Mocha. It helps in providing better assertion messages within the context of your tests.

const assert = require('assert');
const formatter = require('power-assert-formatter');
const mocha = require('mocha');

const format = formatter();

mocha.describe('Sample Test', function() {
  mocha.it('should fail', function() {
    try {
      assert.strictEqual(1, 2);
    } catch (e) {
      console.log(format(e));
    }
  });
});

Other packages similar to power-assert-formatter

chai

Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any JavaScript testing framework. It provides a variety of assertion styles and is known for its flexibility and ease of use.

should

Should.js is an expressive, readable, and powerful assertion library for node and the browser. It extends the Object prototype with a single non-enumerable getter that allows you to express assertions in a natural language style.

expect

Expect is a simple assertion library for JavaScript that works with any test framework. It provides a clean and readable syntax for writing assertions and is often used with Jest.

README

power-assert-formatter

Power Assert output formatter.

DESCRIPTION

power-assert-formatter is a formatter for Power Assert output.

Please note that power-assert-formatter is a alpha version product. Pull-requests, issue reports and patches are always welcomed. See power-assert project for more documentation.

AUTHOR

• Takuto Wada

LICENSE

Licensed under the MIT license.