ansi-html-community

What is ansi-html-community?

The ansi-html-community package is a utility for converting ANSI escape codes in strings into HTML. This is particularly useful for displaying styled console output (like colors, bold, underline) directly on web pages.

What are ansi-html-community's main functionalities?

Convert ANSI codes to HTML

This feature allows you to convert strings containing ANSI escape codes into HTML, enabling the display of styled text in web applications.

const ansiHTML = require('ansi-html-community');
const str = '\u001b[31mHello World\u001b[39m';
const html = ansiHTML(str);
console.log(html); // Outputs: '<span style="color:#FF0000;">Hello World</span>'

Other packages similar to ansi-html-community

ansi-to-html

This package also converts ANSI codes to HTML. It is similar to ansi-html-community but offers different configuration options and might have different handling of certain ANSI codes.

chalk

Chalk is a popular package for styling terminal output with ANSI codes but does not convert to HTML. It is used primarily in Node.js scripts for enhancing console output readability.

README

ansi-html

An elegant lib that converts the chalked (ANSI) text to HTML.

Coverage

• All styles of chalk (100%) and colors.
• There are over 150 randomized test cases under test.

Installation

$ npm install ansi-html-community

Usage

var ansiHTML = require('ansi-html-community');
var str = ansiHTML('[ANSI_TEXT]');

e.g.:

var chalk = require('chalk');

var str = chalk.bold.red('foo') + ' bar';
console.log('[ANSI]', str)
console.log('[HTML]', ansiHTML(str));

See complete examples under test / examples directory.

Set Colors

ansiHTML.setColors({
  reset: ['555', '666'], // FOREGROUND-COLOR or [FOREGROUND-COLOR] or [, BACKGROUND-COLOR] or [FOREGROUND-COLOR, BACKGROUND-COLOR]
  black: 'aaa',	// String
  red: 'bbb',
  green: 'ccc',
  yellow: 'ddd',
  blue: 'eee',
  magenta: 'fff',
  cyan: '999',
  lightgrey: '888',
  darkgrey: '777'
});

Reset

ansiHTML.reset();

Exposed Tags

var openTags = ansiHTML.tags.open;
var closeTags = ansiHTML.tags.close;

Test

$ npm install -l
$ npm test