{"_id":"sum-up","_rev":"29411","name":"sum-up","description":"Summarize package information","dist-tags":{"latest":"3.0.1"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"time":{"modified":"2021-06-03T10:04:34.000Z","created":"2014-11-29T05:26:06.058Z","3.0.1":"2017-12-11T05:16:56.880Z","3.0.0":"2017-07-10T03:00:51.485Z","2.0.0":"2016-03-28T10:26:38.555Z","1.0.3":"2016-03-23T12:28:05.327Z","1.0.2":"2015-06-10T13:16:44.697Z","1.0.1":"2015-02-24T11:06:16.734Z","1.0.0":"2014-11-29T05:27:21.112Z","0.0.0":"2014-11-29T05:26:06.058Z"},"users":{},"author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"versions":{"3.0.1":{"name":"sum-up","version":"3.0.1","description":"Summarize package information","repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint --fix --format=codeframe index.js test.js","test-no-coverage":"node test.js --color && node test.js --no-color","test":"nyc --reporter=html --reporter=text npm run-script test-no-coverage --silent"},"license":"ISC","files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","colour","cli-friendly"],"dependencies":{"chalk":"^2.3.0","inspect-with-kind":"^1.0.3"},"devDependencies":{"@shinnn/eslint-config-node":"^5.0.0","ansi-styles":"^3.2.0","eslint":"^4.13.0","nyc":"^11.4.0","tape":"^4.8.0"},"eslintConfig":{"extends":"@shinnn/node"},"gitHead":"2b0bed8cc5be2429e3631f054b336b4e9b2cecc9","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@3.0.1","_npmVersion":"5.6.0","_nodeVersion":"9.2.1","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"b4d3f6fd3b3cfbea01da2368bf3b17f52e218144","size":2351,"noattachment":false,"key":"/sum-up/-/sum-up-3.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-3.0.1.tgz"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sum-up-3.0.1.tgz_1512969416713_0.13976735365577042"},"directories":{},"publish_time":1512969416880,"_hasShrinkwrap":false,"_cnpm_publish_time":1512969416880},"3.0.0":{"name":"sum-up","version":"3.0.0","description":"Summarize package information","repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint --fix --format=codeframe index.js test.js","test":"node test.js --color && node test.js --no-color","coverage":"node node_modules/.bin/istanbul cover test.js -- --color"},"license":"MIT","files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^2.0.1","inspect-with-kind":"^1.0.2"},"devDependencies":{"@shinnn/eslint-config-node":"^4.0.0","ansi-styles":"^3.1.0","eslint":"^4.2.0","istanbul":"^0.4.5","tape":"^4.7.0"},"eslintConfig":{"extends":"@shinnn/node"},"gitHead":"71d18aa6dea6e4859718efa963150387d36da4f8","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@3.0.0","_npmVersion":"5.1.0","_nodeVersion":"8.1.3","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"74e5b5c33b3ecb183507e5315c488b2c56a32827","size":2554,"noattachment":false,"key":"/sum-up/-/sum-up-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-3.0.0.tgz"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sum-up-3.0.0.tgz_1499655651361_0.5674858072306961"},"directories":{},"publish_time":1499655651485,"_cnpm_publish_time":1499655651485,"_hasShrinkwrap":false},"2.0.0":{"name":"sum-up","version":"2.0.0","description":"Summarize package information","repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint --config @shinnn/node-legacy --rule 'complexity: [error, 15]' index.js test.js","test":"node --strong_mode test.js --color && node test.js --no-color","coverage":"node --strong_mode node_modules/.bin/istanbul cover test.js -- --color","coveralls":"${npm_package_scripts_coverage} && istanbul-coveralls"},"license":"MIT","files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^1.0.0"},"devDependencies":{"@shinnn/eslint-config-node-legacy":"^2.0.0","eslint":"^2.4.0","istanbul":"^0.4.2","tape":"^4.5.1"},"gitHead":"8b343fa25de75f5d6f38de458a6dd1e4e5025306","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@2.0.0","_shasum":"0781c71ef2047c93598653603e393459795db9c0","_from":".","_npmVersion":"3.8.3","_nodeVersion":"5.9.1","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"0781c71ef2047c93598653603e393459795db9c0","size":2593,"noattachment":false,"key":"/sum-up/-/sum-up-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-2.0.0.tgz"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/sum-up-2.0.0.tgz_1459160798124_0.6902368587907404"},"directories":{},"publish_time":1459160798555,"_cnpm_publish_time":1459160798555,"_hasShrinkwrap":false},"1.0.3":{"name":"sum-up","version":"1.0.3","description":"Summarize package information","repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint --config @shinnn/node-legacy index.js test.js","test":"node --strong_mode test.js --color && node test.js --no-color","coverage":"node --strong_mode node_modules/.bin/istanbul cover test.js -- --color","coveralls":"${npm_package_scripts_coverage} && istanbul-coveralls"},"license":"MIT","files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^1.0.0"},"devDependencies":{"@shinnn/eslint-config-node-legacy":"^2.0.0","eslint":"^2.4.0","istanbul":"^0.4.2","tape":"^4.5.1"},"gitHead":"a69ca55de273f1dc8640befe4f9939bd29c12dce","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@1.0.3","_shasum":"1c661f667057f63bcb7875aa1438bc162525156e","_from":".","_npmVersion":"3.8.2","_nodeVersion":"5.9.0","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"dist":{"shasum":"1c661f667057f63bcb7875aa1438bc162525156e","size":2490,"noattachment":false,"key":"/sum-up/-/sum-up-1.0.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-1.0.3.tgz"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/sum-up-1.0.3.tgz_1458736084775_0.2654310546349734"},"directories":{},"publish_time":1458736085327,"_cnpm_publish_time":1458736085327,"_hasShrinkwrap":false},"1.0.2":{"name":"sum-up","version":"1.0.2","description":"Summarize package information","repository":{"type":"git","url":"git+https://github.com/shinnn/sum-up.git"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint --config node_modules/@shinnn/eslintrc-node/rc.json index.js test.js","test":"node test.js --color && node test.js --no-color","coverage":"istanbul cover test.js -- --color","coveralls":"${npm_package_scripts_coverage} && istanbul-coveralls"},"license":"MIT","files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^1.0.0"},"devDependencies":{"@shinnn/eslintrc-node":"^1.0.2","eslint":"^0.22.1","istanbul":"^0.3.15","istanbul-coveralls":"^1.0.3","tape":"^4.0.0"},"gitHead":"75c74abb8c3628679715d2af046fc17d900ff78f","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@1.0.2","_shasum":"e05e5f788cb4d0c570759013ad49442c7b849c88","_from":".","_npmVersion":"2.11.0","_nodeVersion":"2.2.1","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"e05e5f788cb4d0c570759013ad49442c7b849c88","size":2367,"noattachment":false,"key":"/sum-up/-/sum-up-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-1.0.2.tgz"},"directories":{},"publish_time":1433942204697,"_cnpm_publish_time":1433942204697,"_hasShrinkwrap":false},"1.0.1":{"name":"sum-up","version":"1.0.1","description":"Summarize package information","repository":{"type":"git","url":"https://github.com/shinnn/sum-up"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"jscs *.js && eslint *.js","test":"node test.js --color && node test.js --no-color","coverage":"istanbul cover test.js -- --color","coveralls":"${npm_package_scripts_coverage} && istanbul-coveralls"},"licenses":[{"type":"MIT","url":"https://github.com/shinnn/sum-up/blob/master/LICENSE"}],"files":["index.js"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^1.0.0"},"devDependencies":{"eslint":"^0.15.0","istanbul":"^0.3.6","istanbul-coveralls":"^1.0.1","jscs":"^1.11.3","tape":"^3.5.0"},"jscsConfig":{"preset":"google","maximumLineLength":98,"requireBlocksOnNewline":true,"validateLineBreaks":"LF"},"gitHead":"420b903b037e7047d3f3ad8d71670423b4729177","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@1.0.1","_shasum":"5fbb54d7c380b8b41d11c0b95a68ea7e802e9324","_from":".","_npmVersion":"2.6.0","_nodeVersion":"1.3.0","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"5fbb54d7c380b8b41d11c0b95a68ea7e802e9324","size":2461,"noattachment":false,"key":"/sum-up/-/sum-up-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-1.0.1.tgz"},"directories":{},"publish_time":1424775976734,"_cnpm_publish_time":1424775976734,"_hasShrinkwrap":false},"1.0.0":{"name":"sum-up","version":"1.0.0","description":"Summarize package information","repository":{"type":"git","url":"https://github.com/shinnn/sum-up"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint *.js && jscs *.js","test":"node test.js","coverage":"istanbul cover test.js; ${npm_package_scripts_clean}","coveralls":"istanbul cover test.js && istanbul-coveralls"},"licenses":[{"type":"MIT","url":"https://github.com/shinnn/sum-up/blob/master/LICENSE"}],"files":["index.js","LICENSE"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^0.5.1"},"devDependencies":{"eslint":"^0.10.0","istanbul":"^0.3.2","istanbul-coveralls":"^1.0.1","jscs":"^1.8.1","tape":"^3.0.3"},"jscsConfig":{"preset":"google","maximumLineLength":98},"gitHead":"0e132fb9787593a05ded378d3a41d1a3e929beb8","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@1.0.0","_shasum":"aea977b2794d2df695cc8aeb9fe1ba35f9865977","_from":".","_npmVersion":"2.1.9","_nodeVersion":"0.10.33","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"aea977b2794d2df695cc8aeb9fe1ba35f9865977","size":2421,"noattachment":false,"key":"/sum-up/-/sum-up-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-1.0.0.tgz"},"directories":{},"publish_time":1417238841112,"_cnpm_publish_time":1417238841112,"_hasShrinkwrap":false},"0.0.0":{"name":"sum-up","version":"0.0.0","description":"Summarize package information","repository":{"type":"git","url":"https://github.com/shinnn/sum-up"},"homepage":"https://github.com/shinnn/sum-up","author":{"name":"Shinnosuke Watanabe","url":"https://github.com/shinnn"},"scripts":{"pretest":"eslint *.js && jscs *.js","test":"node test.js","coverage":"istanbul cover test.js; ${npm_package_scripts_clean}","coveralls":"istanbul cover test.js && istanbul-coveralls"},"licenses":[{"type":"MIT","url":"https://github.com/shinnn/sum-up/blob/master/LICENSE"}],"files":["index.js","LICENSE"],"keywords":["summerize","summary","brief","outline","info","information","description","data","package","color","cli-friendly"],"dependencies":{"chalk":"^0.5.1"},"devDependencies":{"eslint":"^0.10.0","istanbul":"^0.3.2","istanbul-coveralls":"^1.0.1","jscs":"^1.8.1","tape":"^3.0.3"},"jscsConfig":{"preset":"google","maximumLineLength":98},"gitHead":"d74776e84ef34eb62ab61aa8393969d564617345","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"_id":"sum-up@0.0.0","_shasum":"49d25f81b6cd2b51fd43ec9a5bd139929e408f85","_from":".","_npmVersion":"2.1.9","_nodeVersion":"0.10.33","_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"maintainers":[{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"dist":{"shasum":"49d25f81b6cd2b51fd43ec9a5bd139929e408f85","size":2416,"noattachment":false,"key":"/sum-up/-/sum-up-0.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/sum-up/download/sum-up-0.0.0.tgz"},"directories":{},"publish_time":1417238766058,"_cnpm_publish_time":1417238766058,"_hasShrinkwrap":false}},"readme":"# sum-up\n\n[![npm version](https://img.shields.io/npm/v/sum-up.svg)](https://www.npmjs.com/package/sum-up)\n[![Build Status](https://travis-ci.org/shinnn/sum-up.svg?branch=master)](https://travis-ci.org/shinnn/sum-up)\n[![Coverage Status](https://img.shields.io/coveralls/shinnn/sum-up.svg)](https://coveralls.io/r/shinnn/sum-up)\n\nSummarize package information\n\n```javascript\nconst sumUp = require('sum-up');\nconsole.log(sumUp(require('./package.json')));\n```\n\n![Screenshot](./screenshot.png \"Screenshot\")\n\nIt helps your CLI tool to display information with `--help` flag.\n\n## Installation\n\n[Use npm.](https://docs.npmjs.com/cli/install)\n\n```\nnpm install sum-up\n```\n\n## API\n\n```javascript\nconst sumUp = require('sum-up');\n```\n\n### sumUp(*pkgData* [, *option*])\n\n*pkgData*: `Object`  \n*option*: `Object`  \nReturn: `string`\n\nIt joins the `name`, `version`, `homepage` and `description` properties (all is optional) of the first argument into a string colorized with [ANSI escape code](https://github.com/sindresorhus/ansi-styles).\n\n#### option.color\n\nType: `boolean`  \nDefault: `true` if [the environment supports colors](https://github.com/sindresorhus/supports-color), otherwise `false`\n\n`false` omits all ANSI escape code from the string.\n\n```javascript\nconst data = {\n  name: 'cli-name',\n  version: '0.6.11',\n  description: 'My CLI tool.'\n}\n\nsumUp(data); //=> '\\u001b[36mcli-name\\u001b[39m \\u001b[90mv0.6.11\\u001b[39m\\nMy CLI tool.'\nsumUp(data, {color: false}); //=> 'cli-name v0.6.11\\nMy CLI tool.'\n```\n\n## License\n\n[ISC License](./LICENSE) © 2017 Shinnosuke Watanabe\n","_attachments":{},"homepage":"https://github.com/shinnn/sum-up","bugs":{"url":"https://github.com/shinnn/sum-up/issues"},"license":"ISC"}