You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
rdrew
1440706ce3
|
6 years ago | |
|---|---|---|
| .. | ||
| LICENSE | 6 years ago | |
| README.md | 6 years ago | |
| index.js | 6 years ago | |
| package.json | 6 years ago | |
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
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
Copyright (c) 2014 - 2016 Shinnosuke Watanabe
Licensed under the MIT License.