Summarize package information
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.gitattributes
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json
screenshot.png
test.js

README.md

sum-up

NPM version Build Status Coverage Status Dependency Status devDependency Status

Summarize package information

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

Screenshot

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); //=> '\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

Copyright (c) 2014 - 2016 Shinnosuke Watanabe

Licensed under the MIT License.