Package Exports
- sum-up
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sum-up) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
npm install sum-upAPI
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 colors, 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); //=> '\u001b[36mcli-name\u001b[39m \u001b[90mv0.6.11\u001b[39m\nMy CLI tool.'
sumUp(data, {color: false}); //=> 'cli-name v0.6.11\nMy CLI tool.'License
ISC License © 2017 Shinnosuke Watanabe