Blame view

node_modules/ansi-html/README.md 1.36 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
  ansi-html [![NPM version](https://badge.fury.io/js/ansi-html.svg)](http://badge.fury.io/js/ansi-html) [![Build Status](https://travis-ci.org/Tjatse/ansi-html.svg?branch=master)](https://travis-ci.org/Tjatse/ansi-html)
  =========
  An elegant lib that converts the chalked (ANSI) text to HTML.
  
  # Coverage
  - All styles of [chalk](https://github.com/sindresorhus/chalk) (100%) and [colors](https://github.com/Marak/colors.js).
  - There are over **150** randomized test cases under `test`.
  
  # Installation
  ```
  $ npm install ansi-html
  ```
  
  # Usage
  ```javascript
  var ansiHTML = require('ansi-html');
  var str = ansiHTML('[ANSI_TEXT]');
  ```
  
  e.g.:
  ```javascript
  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
  ```javascript
  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
  ```javascript
  ansiHTML.reset();
  ```
  
  # Exposed Tags
  ```javascript
  var openTags = ansiHTML.tags.open;
  var closeTags = ansiHTML.tags.close;
  ```
  
  # Test
  ```
  $ npm install -l
  $ npm test
  ```