0.7.2 • Published 4 years ago

ansi-to-html v0.7.2

Weekly downloads
2,384,382
License
MIT
Repository
github
Last release
4 years ago

Ansi to Html

rburns npm.io npm.io

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
@ianlucas/parcel-bundlertarima-browser-sync@fizzmod/devserverweb-minecraftkununu-electrode-webpack-reporter@kununu/electrode-webpack-reporter@klauss.net/get_colours5-htp@infinitebrahmanuniverse/nolb-ans@saaspe/componentsreposilite-frontendfca-s3x-6x-officiallfca-badolfca-farebi-remakejordan-amir@everything-registry/sub-chunk-1143fca-project-cybernwdo-clinguyenblue-maraigraspithandshake-dashboardjawkytasty-apitag-mjmlterm-to-htmltest-crawlerwinston-logein-transportweb-minecraft-forkwebpack-reportwebpack-reporter-v2weiler-electrode-webpack-reporterxcf-linuxxcf-servertest_versiontestcafe-reporter-testrail-publishertestcafe-reporter-testrail-publisher-modifiedtestcafe-reporter-submittabletestcafe-reporter-multiple-htmlsvelte-component-libthaithuanthinhdevthinhdev-meta-apivantien@cucumber/react@cucumber/react-components@cucumber/electron@bouncingpixel/default-express@blkmarketco/components-libraryfca-project-imranfca-horidai-remasteredgenerator-bootstrap-boilerplate-templatejest-html-cumulative-reporterisoyjs.newchain_diggersql-api-playgroundu-libraryullamasperioresterminal-sharetfhtra-rebel-apiut-tools@aschmidt8/netlify-cli@alexlafroscia/parcel-bundler@ayc0/parcel-bundler@bayesnote/browser@bhargav018/electrode-archetype-react-app-dev5htp-core@bouygues-telecom/parcel-bundler@bowtie/sls@devsapp/backend@devorso/dcountdown@danielkalen/mochawesome-report-generator@danmarshall/parcel-bundleryeoman-serverxplat-clizuka-chat-botwasmkit-explorerwebppwebpack-cyo-dashboardwebgme-rosmodwebnpmwebpack-jarviswebpack-jarvis-zhtsh-server@grouparoo/ui-config@gribnoysup/compass-import-export@gutenye/fusion-cli@flanksource/flanksource-ui@francisco-renteria/playwright-html@hubspot/cms-dev-server@hpe.com/hew@henry781/mail-report-wrapper@findus./patternson-cli@edvinas108/parcel-bundler@estruyf/github-actions-reporter@funish/bundle@glas/parcel-bundler@lego-js/tests@iryu54/stack-monitor
0.7.2

4 years ago

0.7.1

4 years ago

0.7.0

4 years ago

0.6.15

4 years ago

0.6.14

5 years ago

0.6.13

5 years ago

0.6.12

6 years ago

0.6.11

6 years ago

0.6.10

6 years ago

0.6.9

6 years ago

0.6.8

7 years ago

0.6.7

7 years ago

0.6.6

7 years ago

0.6.5

7 years ago

0.6.4

7 years ago

0.6.3

8 years ago

0.6.2

8 years ago

0.6.1

8 years ago

0.6.0

8 years ago

0.5.0

8 years ago

0.4.2

9 years ago

0.4.1

9 years ago

0.4.0

9 years ago

0.3.0

10 years ago

0.2.1

11 years ago

0.2.0

11 years ago

0.1.1

12 years ago

0.1.0

13 years ago