67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# sum-up
|
|
|
|
[](https://www.npmjs.com/package/sum-up)
|
|
[](https://travis-ci.org/shinnn/sum-up)
|
|
[](https://coveralls.io/r/shinnn/sum-up)
|
|
[](https://david-dm.org/shinnn/sum-up)
|
|
[](https://david-dm.org/shinnn/sum-up#info=devDependencies)
|
|
|
|
Summarize package information
|
|
|
|
```javascript
|
|
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.](https://docs.npmjs.com/cli/install)
|
|
|
|
```
|
|
npm install sum-up
|
|
```
|
|
|
|
## API
|
|
|
|
```javascript
|
|
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](https://github.com/sindresorhus/ansi-styles).
|
|
|
|
#### options.color
|
|
|
|
Type: `Boolean`
|
|
Default: `true` if [the environment supports color](https://github.com/sindresorhus/supports-color), otherwise `false`
|
|
|
|
`false` omits all ANSI escape code from the string.
|
|
|
|
```javascript
|
|
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](https://github.com/shinnn)
|
|
|
|
Licensed under [the MIT License](./LICENSE).
|