History

root ab9f8bb658 first commit		2020-02-06 10:09:39 +00:00
..
node_modules	first commit	2020-02-06 10:09:39 +00:00
LICENSE	first commit	2020-02-06 10:09:39 +00:00
README.md	first commit	2020-02-06 10:09:39 +00:00
index.js	first commit	2020-02-06 10:09:39 +00:00
package.json	first commit	2020-02-06 10:09:39 +00:00

README.md

sum-up

Summarize package information

const sumUp = require('sum-up');
console.log(sumUp(require('./package.json')));

It helps your CLI tool to display information with --help flag.

Installation

Use npm.

npm install sum-up

API

const sumUp = require('sum-up');

sumUp(options)

options: Object
Return: String

It joins the name, version, homepage and description of the object (all is optional) into a string colorized with ANSI escape code.

options.color

Type: Boolean
Default: true if the environment supports color, otherwise false

false omits all ANSI escape code from the string.

let data = {
  name: 'cli-name',
  version: '0.6.11',
  description: 'My CLI tool.'
}

sumUp(data); //=> '\u001b[36mcli-name\u001b[39m \u001b[90mv0.6.11\u001b[39m\nMy CLI tool.'

data.color = false;

sumUp(data); //=> 'cli-name v0.6.11\nMy CLI tool.'

License

Licensed under the MIT License.