anser

A low level parser for ANSI sequences.

:rocket: Features

Converts text containing ANSI color escape codes into equivalent HTML elements.
Allows converting the input into JSON output.
HTML escaping
Converts links into HTML elements
Friendly APIs to use with virtual dom libraries

:cloud: Installation

# Using npm
npm install --save anser

# Using yarn
yarn add anser

:clipboard: Example

const Anser = require("anser");

const txt = "\u001b[38;5;196mHello\u001b[39m \u001b[48;5;226mWorld\u001b[49m";

console.log(Anser.ansiToHtml(txt));
// <span style="color:rgb(255, 0, 0)">Hello</span> <span style="background-color:rgb(255, 255, 0)">World</span>

console.log(Anser.ansiToHtml(txt, { use_classes: true }));
// <span class="ansi-palette-196-fg">Hello</span> <span class="ansi-palette-226-bg">World</span>

console.log(Anser.ansiToJson(txt));
// [ { content: '',
//     fg: null,
//     bg: null,
//     fg_truecolor: null,
//     bg_truecolor: null,
//     clearLine: undefined,
//     decoration: null,
//     was_processed: false,
//     isEmpty: [Function: isEmpty] },
//   { content: 'Hello',
//     fg: '255, 0, 0',
//     bg: null,
//     fg_truecolor: null,
//     bg_truecolor: null,
//     clearLine: false,
//     decoration: null,
//     was_processed: true,
//     isEmpty: [Function: isEmpty] },
//   { content: ' ',
//     fg: null,
//     bg: null,
//     fg_truecolor: null,
//     bg_truecolor: null,
//     clearLine: false,
//     decoration: null,
//     was_processed: false,
//     isEmpty: [Function: isEmpty] },
//   { content: 'World',
//     fg: null,
//     bg: '255, 255, 0',
//     fg_truecolor: null,
//     bg_truecolor: null,
//     clearLine: false,
//     decoration: null,
//     was_processed: true,
//     isEmpty: [Function: isEmpty] },
//   { content: '',
//     fg: null,
//     bg: null,
//     fg_truecolor: null,
//     bg_truecolor: null,
//     clearLine: false,
//     decoration: null,
//     was_processed: false,
//     isEmpty: [Function: isEmpty] } ]

When using TypeScript without --esModuleInterop enabled you can do the following:

import Anser = require('anser');
const txt = "\u001b[38;5;196mHello\u001b[39m \u001b[48;5;226mWorld\u001b[49m";
console.log(Anser.ansiToHtml(txt));
// <span style="color:rgb(255, 0, 0)">Hello</span> <span style="background-color:rgb(255, 255, 0)">World</span>

Or with --esModuleInterop enabled you can do the following:

import Anser from 'anser';
const txt = "\u001b[38;5;196mHello\u001b[39m \u001b[48;5;226mWorld\u001b[49m";
console.log(Anser.ansiToHtml(txt));
// <span style="color:rgb(255, 0, 0)">Hello</span> <span style="background-color:rgb(255, 255, 0)">World</span>

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`Anser.escapeForHtml(txt)`

Escape the input HTML.

This does the minimum escaping of text to make it compliant with HTML. In particular, the '&','<', and '>' characters are escaped. This should be run prior to ansiToHtml.

Params

String txt: The input text (containing the ANSI snippets).

Return

String The escaped html.

`Anser.linkify(txt)`

Adds the links in the HTML.

This replaces any links in the text with anchor tags that display the link. The links should have at least one whitespace character surrounding it. Also, you should apply this after you have run ansiToHtml on the text.

Params

String txt: The input text.

Return

String The HTML containing the tags (unescaped).

`Anser.ansiToHtml(txt, options)`

This replaces ANSI terminal escape codes with SPAN tags that wrap the content.

This function only interprets ANSI SGR (Select Graphic Rendition) codes that can be represented in HTML. For example, cursor movement codes are ignored and hidden from output. The default style uses colors that are very close to the prescribed standard. The standard assumes that the text will have a black background. These colors are set as inline styles on the SPAN tags.

Another option is to set use_classes: true in the options argument. This will instead set classes on the spans so the colors can be set via CSS. The class names used are of the format ansi-*-fg/bg and ansi-bright-*-fg/bg where * is the color name, i.e black/red/green/yellow/blue/magenta/cyan/white.

Params

String txt: The input text.
Object options: The options passed to the ansiToHTML method.

Return

String The HTML output.

`Anser.ansiToJson(txt, options)`

Converts ANSI input into JSON output.

Params

String txt: The input text.
Object options: The options passed to the ansiToHTML method.

Return

String The HTML output.

`Anser.ansiToText(txt)`

Converts ANSI input into text output.

Params

String txt: The input text.

Return

String The text output.

`Anser()`

The Anser class.

Return

Anser

`setupPalette()`

Sets up the palette.

`escapeForHtml(txt)`

Escapes the input text.

Params

String txt: The input text.

Return

String The escpaed HTML output.

`linkify(txt)`

Adds HTML link elements.

Params

String txt: The input text.

Return

String The HTML output containing link elements.

`ansiToHtml(txt, options)`

Converts ANSI input into HTML output.

Params

String txt: The input text.
Object options: The options passed ot the process method.

Return

String The HTML output.

`ansiToJson(txt, options)`

Converts ANSI input into HTML output.

Params

String txt: The input text.
Object options: The options passed ot the process method.

Return

String The JSON output.

`ansiToText(txt)`

Converts ANSI input into HTML output.

Params

String txt: The input text.

Return

String The text output.

`process(txt, options, markup)`

Processes the input.

Params

String txt: The input text.
Object options: An object passed to processChunk method, extended with:
json (Boolean): If true, the result will be an object.
use_classes (Boolean): If true, HTML classes will be appended to the HTML output.
Boolean markup:

`processChunkJson(text, options, markup)`

Processes the current chunk into json output.

Params

String text: The input text.
Object options: An object containing the following fields:
json (Boolean): If true, the result will be an object.
use_classes (Boolean): If true, HTML classes will be appended to the HTML output.
Boolean markup: If false, the colors will not be parsed.

Return

Object The result object:
content (String): The text.
fg (String|null): The foreground color.
bg (String|null): The background color.
fg_truecolor (String|null): The foreground true color (if 16m color is enabled).
bg_truecolor (String|null): The background true color (if 16m color is enabled).
clearLine (Boolean): true if a carriageReturn \r was fount at end of line.
was_processed (Bolean): true if the colors were processed, false otherwise.
isEmpty (Function): A function returning true if the content is empty, or false otherwise.

Add several widely used style codes

`processChunk(text, options, markup)`

Processes the current chunk of text.

Params

String text: The input text.
Object options: An object containing the following fields:
json (Boolean): If true, the result will be an object.
use_classes (Boolean): If true, HTML classes will be appended to the HTML output.
Boolean markup: If false, the colors will not be parsed.

Return

Object|String The result (object if json is wanted back or string otherwise).

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:cake: Thanks

This project is highly based on ansi_up, by @drudru. Thanks! :cake:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

react-native
gatsby
ansi-to-react
react-native-windows
@next/react-dev-overlay
@cubejs-client/react
mesh-devtool
nuclide-commons-ui
@redux-devtools/inspector-monitor-trace-tab
@atom-ide-community/nuclide-commons-ui
@theia/console
transformime
@viankakrisna/react-dev-utils
ansi-to-json
redux-devtools-trace-monitor
@kui-shell/plugin-client-common
react-webpack-build-helper
timer-react-dev-utils
react-native-macos
@axio/react-dev-utils
react-dev-utils-extra
webpack-isomorphic-dev-middleware
ansi-html-themed
react-native-okhttp-fork
uyun-react-dev-utils
ipynb2html-fix
react-dev-utils-sebfl-update
@jjavery/react-error-overlay
lambda-dev-utils
ipynb2html
react-error-overlay-canary
@classflow/react-dev-utils
react-error-overlay-dangerous
@devpodio/console
native-kakao-login
linklog
react-native-ytximkit
@mindinventory/rn-top-navbar
cycle-dev-utils
@viankakrisna/react-error-overlay
callstack-task-react-dev-utils
webpack-universal-compiler
@codewars/jest-reporter
react-native-kakao-maps
@hemith/react-native-tnk
react-native-contact-list
react-native-is7
@nib/e2e-core
react-native-biometric-authenticate
@corelmax/react-native-my2c2p-sdk
@proteria/react-scripts
@prague-digi/react-error-overlay
native-apple-login
react-ansi
rn-custom-tabview
@felipesimmi/react-native-datalogic-module
@blkmarketco/components-library
@datalogic/react-native-datalogic-module
ansi-to-react-with-options
callstack-task-react-error-overlay
react-native-flyy
@geeky-apo/react-native-advanced-clipboard
@apardellass/react-native-audio-stream
kunai
react-native-responsive-size
singularityui-tailer
rn-flatlist-fork
@unforgiven/react-native
ansi-to-react-with-classes
react-native-dsphoto-module
react-native-tvos
react-error-guard
@plansys/react-dev-utils
react-native-plugpag-wrapper
react-native-pulsator-native
react-native-hlf-wrapper
@alloc/react-error-overlay
birken-react-native-community-image-editor
react-dev-utils-custom-hmr
nuclide
@ehyland-org/react-error-overlay
@naze/error
ada-pack
@office-iss/react-native-win32
react-native-sf
native-google-login
zc-react-dev-utils
react-native-dm-player
react-native-test-module-hhh
@openpolitica/matomo-next
@ryfow/react-native-windows
react-native-modal-progress-bar
stack-frame-overlay
@digibear/socket-bridge

anser

:rocket: Features

:cloud: Installation

:clipboard: Example

:question: Get Help

:memo: Documentation

Anser.escapeForHtml(txt)

Params

Return

Anser.linkify(txt)

Params

Return

Anser.ansiToHtml(txt, options)

Params

Return

Anser.ansiToJson(txt, options)

Params

Return

Anser.ansiToText(txt)

Params

Return

Anser()

Return

setupPalette()

escapeForHtml(txt)

Params

Return

linkify(txt)

Params

Return

ansiToHtml(txt, options)

Params

Return

ansiToJson(txt, options)

Params

Return

ansiToText(txt)

Params

Return

process(txt, options, markup)

Params

processChunkJson(text, options, markup)

Params

Return

processChunk(text, options, markup)

Params

Return

:yum: How to contribute

:sparkling_heart: Support my projects

:cake: Thanks

:dizzy: Where is this library used?

:scroll: License

Current Tags

31 Versions

`Anser.escapeForHtml(txt)`

`Anser.linkify(txt)`

`Anser.ansiToHtml(txt, options)`

`Anser.ansiToJson(txt, options)`

`Anser.ansiToText(txt)`

`Anser()`

`setupPalette()`

`escapeForHtml(txt)`

`linkify(txt)`

`ansiToHtml(txt, options)`

`ansiToJson(txt, options)`

`ansiToText(txt)`

`process(txt, options, markup)`

`processChunkJson(text, options, markup)`

`processChunk(text, options, markup)`