TSpew

A simple template printer for the JavaScript console.

Install

npm install tspew

Options

| Name | Description | Type | | ----------------- | ---------------------------------------------------------------------------------------------------------- | ---------- | | resetEachLine | Automatically appends a reset to the end of each line of your template | boolean | | customerReplacers | An array of the Replacer type provided to add your own token replacers to the template | Replacer[] | | typeEffect | Enables the type effect, if you don't want this then just omit this option rather than setting it to false | boolean | | charDelay | Couples with typeEffect and applys a delay in ms between each character being displayed | number | | lineDelay | Adds a delay in ms between each line being printed to the console | number |

Default Supplied Tokens

| Token | Replacer | | ----------- | --------- | | %reset | \x1b[0m | | %bright | \x1b[1m | | %dim | \x1b[2m | | %underscore | \x1b[4m | | %reverse | \x1b[7m | | %tick | \u2713 | | %heavyTick | \u2714 | | %cross | \u2717 | | %heavyCross | \u2718 |

Preview

Example Usage

Create a template file in the root of your project

touch template

Build your template using built in replacers and hex codes or you can supply your own later!

%fgHex[473cc2] _____                           _        _____                    _       _
| ____|_  ____ _ _ __ ___  _ __ | | ___  |_   _|__ _ __ ___  _ __ | | __ _| |_ ___
|  _| \ \/ / _` | '_ ` _ \| '_ \| |/ _ \   | |/ _ \ '_ ` _ \| '_ \| |/ _` | __/ _ \
| |___ >  < (_| | | | | | | |_) | |  __/   | |  __/ | | | | | |_) | | (_| | ||  __/
|_____/_/\_\__,_|_| |_| |_| .__/|_|\___|   |_|\___|_| |_| |_| .__/|_|\__,_|\__\___|
                          |_|                               |_|                    %reset

%bgHex[e37000]%fgHex[ffffff] Stats %reset

%fgHex[24d43b]%tick%reset Node Version: %fgHex[24d43b]20.12.0%reset
%fgHex[24d43b]%tick%reset Port: %fgHex[24d43b]3000%reset
%fgHex[d42424]%cross%reset Test Coverage: %fgHex[d42424]40%%reset

Call the template printer whenever you want to, for example when an express app starts

import express from "express";
import printTemplate from "tspew";

const app = express();

app.listen(3000, () => {
  printTemplate({ lineDelay: 20 });
});