ansi-to-html

Convert ansi escaped text streams to html.

MIT 28 个版本
安装
npm install ansi-to-html
yarn add ansi-to-html
pnpm add ansi-to-html
bun add ansi-to-html
README

Ansi to Html

rburns

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
版本列表
0.7.2 2021-10-05
0.7.1 2021-07-21
0.7.0 2021-07-07
0.6.15 2021-05-13
0.6.14 2020-02-05
0.6.13 2019-11-05
0.6.12 2019-10-14
0.6.11 2019-05-20
0.6.10 2019-01-24
0.6.9 2018-11-22
0.6.8 2018-10-24
0.6.7 2018-10-20
0.6.6 2018-06-30
0.6.5 2018-06-30
0.6.4 2018-01-11
0.6.3 2017-07-09
0.6.2 2017-04-29
0.6.1 2017-04-29
0.6.0 2017-02-17
0.5.0 2016-12-18
0.4.2 2016-09-26
0.4.1 2016-02-27
0.4.0 2016-02-26
0.3.0 2014-12-07
0.2.1 2014-10-26
0.2.0 2014-05-24
0.1.1 2013-01-06
0.1.0 2012-09-16