benderjs-yui-beautified/README.md

Bender.js plugin adding beautified assertions to the YUI adapter.

# benderjs-yui-beautified

Adds assertions beautified assertions to the Bender.js. This plugin utilizes [js-beautify](https://www.npmjs.com/package/js-beautify) to format data.

## Requirements

This plugin requires [`benderjs-yui`](https://www.npmjs.com/package/benderjs-yui) plugin to work correctly.

## API

Adds `bender.assert.beautified` namespace containing following members:

### `html`

Parameters:

* expected - Expected value.
* actual - Actual value.
* msg - optional - Message passed to the `bender.assert.areEqual` assertion.

#### Examples

```javascript
bender.assert.beautified.html( '<p>aaa aaaa</p>', '<p>aaa    aaaa</p>' ); // Pass
bender.assert.beautified.html( '<p>aaa aaaa</p>', '<p>aaaaaaa</p>' ); // Fails
```

### `js`

Parameters:

* expected - Expected value.
* actual - Actual value.
* msg - optional - Message passed to the `bender.assert.areEqual` assertion.

#### Examples

```javascript
bender.assert.beautified.js( 'var aaa = 3;', 'var aaa =    3;' ); // Pass
bender.assert.beautified.js( 'var aaa = 3;', 'var aaa =    33;' ); // Fails
```

### Config

You can also adjust formatting configuration in your `bender.js` config file.

```javascript
'use strict';

var config = {

	applications: {
		// (...)
	},

	framework: '(...)',

	// (...)

	'yui-beautified': {
		'indent_with_tabs': true,
		// All tags should be reformatted.
		'unformatted': 'none'
	}
};

module.exports = config;
```

For more config options check the [js-beautify package](https://www.npmjs.com/package/js-beautify).