## Ansi to Html

![](https://img.shields.io/npm/v/ansi-to-html.svg) ![](https://img.shields.io/npm/dm/ansi-to-html.svg) ![](https://img.shields.io/travis/rburns/ansi-to-html.svg)

This is a port of the ansi to html converter from [bcat](https://github.com/rtomayko/bcat/blob/master/lib/bcat/ansi.rb) to Javascript.

It has a few additions:

* The API has been altered to accept options in the constructor, and input in <code>toHtml()</code>.
* ANSI codes for setting the foreground or background color to default are handled
* the 'erase in line' escape code (\x1b[K) is dropped from the output.

## Installation

	npm install ansi-to-html

## Usage

	var Convert = require('ansi-to-html');
	var convert = new Convert();

	console.log(convert.toHtml('\x1b[30mblack\x1b[37mwhite'));

	/*
		prints:
		<span style="color:#000">black<span style="color:#AAA">white</span></span>
	*/

## Command line usage

Process a file:

```bash
ansi-to-html the_filename
```

From STDIN:

```bash
git log | ansi-to-html
```

When using ansi-to-html from the command line the stream option is set to `true`. Other options can
be provided. See `ansi-to-html -h` for more detail.

## Options

Options can be be passed to the constructor to customize behaviour.

**fg** <code>CSS color values</code> The default foreground color used when reset color codes are encountered.

**bg** <code>CSS color values</code> The default background color used when reset color codes are encountered.

**newline** <code>true or false</code> Convert newline characters to <code>&lt;br/&gt;</code>.

**escapeXML** <code>true or false</code> Generate HTML/XML entities.

**stream** <code>true or false</code> save style state across invocations of toHtml().

### Default options

```coffee
fg: '#FFF'
bg: '#000'
newline: false
escapeXML: false
stream: false
```

## Development

[![](http://issuestats.com/github/rburns/ansi-to-html/badge/issue?style=flat)](http://issuestats.com/github/rburns/ansi-to-html)
[![](http://issuestats.com/github/rburns/ansi-to-html/badge/pr?style=flat)](http://issuestats.com/github/rburns/ansi-to-html)

Once you have the git repository cloned, install the dependencies:

	cd ansi-to-html
	npm install

If you don't have it already, install the grunt command-line tool:

	npm install -g grunt-cli

Build and test

	grunt

All the time

	grunt watch

Or separately

	grunt coffee
	grunt simplemocha  # or npm test