The 'anser' npm package is a library that allows you to convert ANSI escape codes into HTML. This is particularly useful for rendering terminal output in web applications, where you want to preserve the color and style formatting.
Convert ANSI to HTML
This feature allows you to convert a string containing ANSI escape codes into an HTML string with equivalent styling. The example converts a red-colored 'Hello, World!' from ANSI to HTML.
const anser = require('anser');
const ansiString = '\u001b[31mHello, World!\u001b[0m';
const htmlString = anser.toHtml(ansiString);
console.log(htmlString); // Outputs: <span style="color:#E34C26;">Hello, World!</span>Strip ANSI codes
This feature allows you to strip ANSI escape codes from a string, leaving just the plain text. The example removes the red color formatting from 'Hello, World!'.
const anser = require('anser');
const ansiString = '\u001b[31mHello, World!\u001b[0m';
const plainString = anser.ansiToText(ansiString);
console.log(plainString); // Outputs: Hello, World!Escape for HTML
This feature escapes HTML special characters in a string containing ANSI escape codes. The example converts '<' and '>' to their HTML entities.
const anser = require('anser');
const ansiString = '\u001b[31mHello, <World>!\u001b[0m';
const escapedHtmlString = anser.escapeForHtml(ansiString);
console.log(escapedHtmlString); // Outputs: \u001b[31mHello, <World>!\u001b[0mChalk is a popular library for styling terminal strings in Node.js. Unlike 'anser', which focuses on converting ANSI codes to HTML, Chalk is primarily used for creating styled terminal output. It supports various styles and colors but does not provide HTML conversion.
The 'ansi-to-html' package is similar to 'anser' in that it converts ANSI escape codes to HTML. However, 'anser' offers more features like stripping ANSI codes and escaping for HTML, making it a more versatile choice for handling ANSI codes.
The 'strip-ansi' package is a simple utility for removing ANSI escape codes from strings. While it performs a similar function to 'anser's' ansiToText method, it lacks the additional features like HTML conversion and escaping.
A low level parser for ANSI sequences.
# Using npm
npm install --save anser
# Using yarn
yarn add anser
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 you can do the following:
import * as 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>
There are few ways to get help:
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.
txt: The input text (containing the ANSI snippets).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.
txt: The input text.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.
txt: The input text.options: The options passed to the ansiToHTML method.Anser.ansiToJson(txt, options)Converts ANSI input into JSON output.
txt: The input text.options: The options passed to the ansiToHTML method.Anser.ansiToText(txt)Converts ANSI input into text output.
txt: The input text.Anser()The Anser class.
setupPalette()Sets up the palette.
escapeForHtml(txt)Escapes the input text.
txt: The input text.linkify(txt)Adds HTML link elements.
txt: The input text.ansiToHtml(txt, options)Converts ANSI input into HTML output.
txt: The input text.options: The options passed ot the process method.ansiToJson(txt, options)Converts ANSI input into HTML output.
txt: The input text.options: The options passed ot the process method.ansiToText(txt)Converts ANSI input into HTML output.
txt: The input text.process(txt, options, markup)Processes the input.
txt: The input text.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.markup:processChunkJson(text, options, markup)Processes the current chunk into json output.
text: The input text.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.markup: If false, the colors will not be parsed.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.processChunk(text, options, markup)Processes the current chunk of text.
text: The input text.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.markup: If false, the colors will not be parsed.json is wanted back or string otherwise).Have an idea? Found a bug? See how to contribute.
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:
This project is highly based on ansi_up, by @drudru. Thanks! :cake:
If you are using this library in one of your projects, add it in this list. :sparkles:
react-nativereact-native-windowsansi-to-reactmesh-devtool@next/react-dev-overlaynuclide-commons-ui@atom-ide-community/nuclide-commons-uitransformime@viankakrisna/react-dev-utilsreact-webpack-build-helperansi-to-jsonredux-devtools-trace-monitor@axio/react-dev-utilsreact-error-overlay-dangeroustimer-react-dev-utilsreact-dev-utils-extraansi-html-themeduyun-react-dev-utilsreact-dev-utils-sebfl-update@jjavery/react-error-overlaylambda-dev-utilsreact-error-overlay-canary@classflow/react-dev-utilsnuclidereact-native-okhttp-fork@devpodio/consoleipynb2html-fixipynb2htmlwebpack-isomorphic-dev-middleware@theia/consolereact-native-macos@ehyland-org/react-error-overlaystack-frame-overlaycycle-dev-utils@viankakrisna/react-error-overlaycallstack-task-react-error-overlaycallstack-task-react-dev-utilsansi-to-react-with-options@plansys/react-dev-utilszc-react-dev-utilsreact-dev-utils-custom-hmransi-to-react-with-classeslinklog@naze/errorreact-error-guardsingularityui-tailer@unforgiven/react-native@digibear/socket-bridgeada-packreact-native-hlf-wrapperwebpack-universal-compiler@apardellass/react-native-audio-streamreact-native-plugpag-wrapper@codewars/jest-reporterreact-native-pulsator-native@proteria/react-scriptskunaireact-native-kakao-mapsreact-ansi@geeky-apo/react-native-advanced-clipboardnative-apple-loginnative-google-login@ryfow/react-native-windowsnative-kakao-login@prague-digi/react-error-overlay@hemith/react-native-tnkreact-native-sfreact-native-contact-list@corelmax/react-native-my2c2p-sdkreact-native-tvos@office-iss/react-native-win32FAQs
A low level parser for ANSI sequences.
The npm package anser receives a total of 1,980,595 weekly downloads. As such, anser popularity was classified as popular.
We found that anser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.