ansi-to-html
Advanced tools
Package description
The ansi-to-html package is designed to convert ANSI code (often used for colorizing text in terminal outputs) into HTML. This is particularly useful for displaying styled console output on web pages.
Convert ANSI to HTML
This feature allows you to convert ANSI encoded strings to HTML, preserving the color and style formatting for web display. The code sample demonstrates converting a red 'Hello World' string to HTML.
const Convert = require('ansi-to-html');
const convert = new Convert();
const html = convert.toHtml('\x1b[31mHello World\x1b[0m');Customize color palette
This feature enables customization of the foreground and background colors used in the conversion process. The code sample shows how to set custom foreground and background colors.
const Convert = require('ansi-to-html');
const convert = new Convert({ fg: '#000', bg: '#fff' });
const html = convert.toHtml('your-ansi-string');Escape HTML
This feature allows you to ensure that the output HTML is properly escaped. This is useful to avoid XSS attacks when displaying user-generated content. The code sample demonstrates enabling HTML escaping.
const Convert = require('ansi-to-html');
const convert = new Convert({ escapeXML: true });
const html = convert.toHtml('your-ansi-string');Chalk is a popular npm package that allows you to style strings in the terminal with colors and styles. Unlike ansi-to-html, Chalk is used for creating styled terminal output rather than converting ANSI codes to HTML.
ansi_up is another npm package that converts ANSI escape codes into HTML. It is similar to ansi-to-html but offers different API options and additional features like converting ANSI cursor movement into HTML.
ansi-colors is an npm package that focuses on creating ANSI escape sequences for styling strings in the terminal. It is similar to Chalk and does not convert to HTML, but it is lightweight and has no dependencies.
Readme
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:
toHtml().\x1b[K) is dropped from the output.npm install ansi-to-html
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>
*/
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.
ansi-to-html the_filename
git log | ansi-to-html
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
{
fg: '#FFF',
bg: '#000',
newline: false,
escapeXML: false,
stream: false
}
Once you have the git repository cloned, install the dependencies:
cd ansi-to-html
npm install
npm run lint
npm run build
/src files by running babel./lib output directory.babel in Watch mode - will re-build the project each time the files are changed.npm run build:watch
npm test
/lib directory).npm run test:watch
FAQs
Convert ansi escaped text streams to html.
The npm package ansi-to-html receives a total of 1,884,712 weekly downloads. As such, ansi-to-html popularity was classified as popular.
We found that ansi-to-html demonstrated a not healthy version release cadence and project activity because the last version was released 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
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.