typo

Typo is a scalable template engine designed for cli, which help to format your console output! Typo supports full 256-color ANSI background and foreground, underline, italic, etc.

npm install typo
38 downloads in the last day
98 downloads in the last week
170 downloads in the last month

Typo

Make typography beautiful in command-line.

Typo is a scalable node.js template engine designed for and focused on command-line (cli), which helps to format and beautify your console output.

Typo supports not only basic ANSI escope codes, such as basic background and foreground colors, underline, bold, etc, and ALSO full 8-bit colors (256 colors).

screenshot

Installation

npm install typo --save

Getting started

var typo = require('typo');

typo.log("There's once in a {{blue blue}} moon~");

Typo Plugins

  • typo-image: display pictures in CLI !
  • typo-ascii: ascii art text in CLI with all kinds of styles ! (on developing)

Usage

Syntax

( '{{<helper[:<data>][|helper[:<data>]]> <text>}}', <object> );

Simple substitution

typo.log('{{1}}{{b}}{{c.a}}{{c.b}}', {'1': 1, b:2, c: {a: 3}}); 
// print '123c.b'.
// in which, `'c.b'` is not matched in `values` and not substituted.

With helper functions

typo.log('{{bold abc}}');         // print a bold 'abc'
typo.log('{{rgb:#00ffcc abc}}');  // with a specified RGB color!

With piped helpers

typo.log('{{bold|blue|underline abc}}'); // print a blue bold 'abc' with a underline
`

Custom helpers

typo.register('sum', function(value){{
    return value.split(',').reduce(function(prev, current){
        return (parseInt(current) || 0) + prev;
    }, 0);
}});

typo.log('{{sum 1,2,3}}');         // print 6

Nested helpers

typo.log('{#list}3{/list}');

Which will not show up before typo@0.2.0.

if you like typo, there will be a billion thanks if you fork typo and make pull request.

Available helpers

The helpers below are built-in helpers of typo, and you could define your own helpers by typo.register method.

There will also be typo plugins soon or gradually.

{{rgb:\ \}}

Highlight your text text with any RGB colors filled in foreground.

Notice that if your RGB color is not a standard 8-bit RGB color, typo will automatically choose the closest one in the color palette, which will be really helpful.

typo.log('{{bg.rgb:#f26d7d|rgb:#000|bold peach bg and black bold font}}');

There's a background version of RGB: {{bg.rgb:<rgb> <text>}}.

Basic colors

Eight basic ANSI colors:

0 1 2 3 4 5 6 7
black red green yellow blue magenta cyan white
typo.log('{{magenta purple text}}');

Other text styles

  • italic # not widely supported. Sometimes treated as inverse.
  • bold
  • underline
  • inverse
  • strikethrough

Methods

typo.log(pattern [,values [,callback]])

Print a formated output to the command-line. Has no return value.

pattern

string

Template pattern

values

Object|Array, optional

If no values passed or not matched, the relevant pattern will not be substituted.

callback

function(err, output), optional

Typo also support asynchronous help functions. See "register asynchronous helpers" section.

typo.template(pattern [,values [,callback]])

Returns the parsed or substituted ouput, if all helpers are synchronous.

Or output will be passed to callback.

typo.register(name, helper)

typo.register(helpers_map)

Register helpers

name

string

helper (sync)

function(str)

Will be treated as a sync helper, if has only one term parameter (also called formal parameter);

Besides, the data (in "syntax" section) could be fetched using this.data inside helper.

helper (async)

function(str, callback)

If helper has more than one term parameters, it will be treated as an async helper.

And the second parameter will be the callback which should be implemented inside the helper function.

helpers_map

Object


Advanced Sections

Register asynchronous helpers

Change '{{'

Using help categories

npm loves you