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(pkgData [, option])
pkgData: Object
option: Object
Return: String
It joins the name
, version
, homepage
and description
properties (all is optional) of the first argument into a string colorized with ANSI escape code.
option.color
Type: Boolean
Default: true
if the environment supports color, otherwise false
false
omits all ANSI escape code from the string.
const data = {
name: 'cli-name',
version: '0.6.11',
description: 'My CLI tool.'
}
sumUp(data);
sumUp(data, {color: false});
License
Copyright (c) 2014 - 2016 Shinnosuke Watanabe
Licensed under the MIT License.