power-assert-formatter

power-assert-formatter
================================

[![Build Status][travis-image]][travis-url]
[![NPM package][npm-image]][npm-url]
[![Bower package][bower-image]][bower-url]
[![Dependency Status][depstat-image]][depstat-url]
[![Coverage Status][coverage-image]][coverage-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[![License][license-image]][license-url]
[![Built with Gulp][gulp-image]][gulp-url]

Power Assert output formatter.

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

Pull-requests, issue reports and patches are always welcomed. See power-assert project for more documentation.

CHANGELOG
---------------------------------------
See CHANGELOG

API
---------------------------------------

$3

| return type |
|:------------|
| function |

Returns creator function for power-assert.

$3

| return type |
|:------------|
| function |

Create formatter function with options. options argument is optional.

#### options

| type | default value |
|:---------|:--------------|
| object | (return value of createFormatter.defaultOptions()) |

Configuration options. If not passed, default options will be used.

#### options.lineDiffThreshold

| type | default value |
|:---------|:--------------|
| number | 5 |

Threshold to show diff at character level or line level. If number of lines in target string is greater than lineDiffThreshold, then line diff mode will be used to show diff output.

#### options.maxDepth

| type | default value |
|:---------|:--------------|
| number | 1 |

Depth of object traversal. If object depth is greater than maxDepth, compound object (IOW, Array or object) will be pruned with # like ["foo",#Array#,#Object#].

#### options.outputOffset

| type | default value |
|:---------|:--------------|
| number | 2 |

Number of spaces inserted at the left in power-assert output.

#### options.anonymous

| type | default value |
|:---------|:--------------|
| string | "Object" |

Type name to show when target object is created by anonymous constructor.

#### options.circular

| type | default value |
|:---------|:----------------|
| string | "#@Circular#" |

Name to show when target object is detected as circular structure.

#### options.lineSeparator

| type | default value |
|:---------|:--------------|
| string | "\n" |

Line separator in power assert output.

#### options.ambiguousEastAsianCharWidth

| type | default value |
|:---------|:--------------|
| number | 2 |

Width of 'Ambiguous' characters defined in Unicode Standard Annex \#11 EAST ASIAN WIDTH. Configure options.ambiguousEastAsianCharWidth to treat ambiguous east asian character as fullwidth (= 2) or narrow (= 1). Default is 2.

#### options.widthOf

| type | default value |
|:-----------|:--------------|
| function | string-width.js |

Function to calculate width of string.

#### options.stringify

| type | default value |
|:-----------|:--------------|
| function | stringifier module |

Function to stringify any target value.

#### options.diff

| type | default value |
|:-----------|:--------------|
| function | udiff.js |

Function to create diff string between two strings.

#### options.writerClass

| type | default value |
|:-----------|:--------------|
| function | string-writer.js |

Constructor Function for output writer class.

#### options.renderers

| type | default value |
|:------------------------------------|:--------------|
| Array of (string or function )| shown below |

``javascript
[
'./built-in/file',
'./built-in/assertion',
'./built-in/diagram',
'./built-in/binary-expression'
]
`

Output renderers. Power assert output is rendered by renderers in order. You can create custom renderer and add its constructor function to customize power-assert-output.

`javascript
[
'./built-in/file',
'./built-in/assertion',
YourCustomRenderer,
'./built-in/binary-expression'
]
`

$3

Returns default options object for createFormatter function. In other words, returns

`javascript
{
lineDiffThreshold: 5,
maxDepth: 1,
anonymous: 'Object',
circular: '#@Circular#',
lineSeparator: '\n',
ambiguousEastAsianCharWidth: 2,
renderers: [
'./built-in/file',
'./built-in/assertion',
'./built-in/diagram',
'./built-in/binary-expression'
]
};
`

$3

| return type |
|:------------|
| string |

Format powerAssertContext into formattedText. powerAssertContext is an internal object structure, containing informations to render. Example of powerAssertContext is:

`javascript
{
source: {
content: "assert.equal(foo, bar)",
filepath: "/path/to/some_test.js",
line: 1
},
args: [
{
value: "foo",
events: [
{
value: "foo",
espath: "arguments/0"
}
]
},
{
value: "bar",
events: [
{
value: "bar",
espath: "arguments/1"
}
]
}
]
}
`

Note that structure of powerAssertContext may change.


INSTALL
---------------------------------------

$3

Install

$ npm install --save-dev power-assert-formatter


#### use power-assert-formatter npm module on browser

powerAssertFormatter function is exported

$3

Install

$ bower install --save-dev power-assert-formatter

Then load (powerAssertFormatter` function is exported)

AUTHOR
---------------------------------------
* Takuto Wada

CONTRIBUTORS
---------------------------------------
* James Talmage (jamestalmage)

LICENSE
---------------------------------------
Licensed under the MIT license.

[npm-url]: https://npmjs.org/package/power-assert-formatter
[npm-image]: https://badge.fury.io/js/power-assert-formatter.svg

[bower-url]: https://badge.fury.io/bo/power-assert-formatter
[bower-image]: https://badge.fury.io/bo/power-assert-formatter.svg

[travis-url]: https://travis-ci.org/power-assert-js/power-assert-formatter
[travis-image]: https://secure.travis-ci.org/power-assert-js/power-assert-formatter.svg?branch=master

[depstat-url]: https://gemnasium.com/power-assert-js/power-assert-formatter
[depstat-image]: https://gemnasium.com/power-assert-js/power-assert-formatter.svg

[license-url]: https://github.com/power-assert-js/power-assert-formatter/blob/master/MIT-LICENSE.txt
[license-image]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat

[codeclimate-url]: https://codeclimate.com/github/power-assert-js/power-assert-formatter
[codeclimate-image]: https://codeclimate.com/github/power-assert-js/power-assert-formatter/badges/gpa.svg

[coverage-url]: https://coveralls.io/r/power-assert-js/power-assert-formatter?branch=master
[coverage-image]: https://coveralls.io/repos/power-assert-js/power-assert-formatter/badge.svg?branch=master

[gulp-url]: http://gulpjs.com/
[gulp-image]: https://img.shields.io/badge/built_with-gulp-brightgreen.svg