JarCasting
JarCasting JarCasting

ansi-to-html

WebJar for ansi-to-html

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

ansi-to-html
Last Version

Last Version

0.3.0
Release Date

Release Date
Type

Type

jar
Description

Description

ansi-to-html
WebJar for ansi-to-html
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/rburns/ansi-to-html

Download ansi-to-html

Filename Size
ansi-to-html-0.3.0.pom
ansi-to-html-0.3.0.jar 9 KB
ansi-to-html-0.3.0-sources.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/ansi-to-html/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>ansi-to-html</artifactId>
    <version>0.3.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/ansi-to-html/
implementation 'org.webjars.npm:ansi-to-html:0.3.0'
// https://jarcasting.com/artifacts/org.webjars.npm/ansi-to-html/
implementation ("org.webjars.npm:ansi-to-html:0.3.0")
'org.webjars.npm:ansi-to-html:jar:0.3.0'
<dependency org="org.webjars.npm" name="ansi-to-html" rev="0.3.0">
  <artifact name="ansi-to-html" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='ansi-to-html', version='0.3.0')
)
libraryDependencies += "org.webjars.npm" % "ansi-to-html" % "0.3.0"
[org.webjars.npm/ansi-to-html "0.3.0"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : entities jar [1.1.1,2)

Project Modules

There are no modules declared in this project.

Ansi to Html

This was originally a port of the ansi to html converter from bcat to JavaScript. It has since undergone quite a lot of modification.

It has a few additions:

  • The API has been altered to accept options in the constructor, and input in toHtml().
  • 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

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.

Process a file

ansi-to-html the_filename

From STDIN

git log | ansi-to-html

Options

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

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

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

newline true or false. Convert newline characters to <br/>.

escapeXML true or false. Generate HTML/XML entities.

stream true or false. Save style state across invocations of toHtml().

colors Object/Array (with values 0 - 255 containing CSS color values). Can override specific colors or the entire ANSI palette

Default options

{
    fg: '#FFF',
    bg: '#000',
    newline: false,
    escapeXML: false,
    stream: false
}

Development

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

cd ansi-to-html
npm install

Lint

npm run lint

Build

npm run build
  • Builds the /src files by running babel.
  • Saves the built files in /lib output directory.
  • Recommended to run babel in Watch mode - will re-build the project each time the files are changed.
npm run build:watch

Test

npm test
  • Note: Runs the tests against the built files (in the /lib directory).
  • You also run the tests in watch mode (will rerun tests when files are changed).
  • Recommended to run the build in watch mode as well to re-build the project before the tests are run.
npm run test:watch

Versions

Version
0.3.0