{"name":"cliui","version":"2.1.0","description":"easily create complex multi-column command-line-interfaces","main":"index.js","scripts":{"test":"standard && mocha --check-leaks --ui exports --require patched-blanket -R mocoverage"},"repository":{"type":"git","url":"http://github.com/bcoe/cliui.git"},"config":{"blanket":{"pattern":["index.js"],"data-cover-never":["node_modules","test"],"output-reporter":"spec"}},"standard":{"ignore":["**/example/**"],"globals":["it"]},"keywords":["cli","command-line","layout","design","console","wrap","table"],"author":{"name":"Ben Coe","email":"ben@npmjs.com"},"license":"ISC","dependencies":{"center-align":"^0.1.1","right-align":"^0.1.1","wordwrap":"0.0.2"},"devDependencies":{"blanket":"^1.1.6","chai":"^2.2.0","coveralls":"^2.11.2","mocha":"^2.2.4","mocha-lcov-reporter":"0.0.2","mocoverage":"^1.0.0","patched-blanket":"^1.0.1","standard":"^3.6.1"},"readme":"# cliui\n\n[![Build Status](https://travis-ci.org/bcoe/cliui.png)](https://travis-ci.org/bcoe/cliui)\n[![Coverage Status](https://coveralls.io/repos/bcoe/cliui/badge.svg?branch=)](https://coveralls.io/r/bcoe/cliui?branch=)\n[![NPM version](https://img.shields.io/npm/v/cliui.svg)](https://www.npmjs.com/package/cliui)\n\neasily create complex multi-column command-line-interfaces.\n\n## Example\n\n```js\nvar ui = require('cliui')({\n  width: 80\n})\n\nui.div('Usage: $0 [command] [options]')\n\nui.div({\n  text: 'Options:',\n  padding: [2, 0, 2, 0]\n})\n\nui.div(\n  {\n    text: \"-f, --file\",\n    width: 40,\n    padding: [0, 4, 0, 4]\n  },\n  {\n    text: \"the file to load\",\n    width: 25\n  },\n  {\n    text: \"[required]\",\n    align: 'right'\n  }\n)\n\nconsole.log(ui.toString())\n```\n\n## Layout DSL\n\ncliui exposes a simple layout DSL:\n\nIf you create a single `ui.row`, passing a string rather than an\nobject:\n\n* `\\n`: characters will be interpreted as new rows.\n* `\\t`: characters will be interpreted as new columns.\n* ` `: characters will be interpreted as padding.\n\n**as an example...**\n\n```js\nvar ui = require('./')({\n  width: 60\n})\n\nui.div(\n  'Usage: node ./bin/foo.js\\n' +\n  '  <regex>\\t  provide a regex\\n' +\n  '  <glob>\\t  provide a glob\\t [required]'\n)\n\nconsole.log(ui.toString())\n```\n\n**will output:**\n\n```shell\nUsage: node ./bin/foo.js\n  <regex>  provide a regex\n  <glob>   provide a glob          [required]\n```\n\n## Methods\n\n```js\ncliui = require('cliui')\n```\n\n### cliui({width: integer})\n\nSpecify the maximum width of the UI being generated.\n\n### cliui({wrap: boolean})\n\nEnable or disable the wrapping of text in a column.\n\n### cliui.div(column, column, column)\n\nCreate a row with any number of columns, a column\ncan either be a string, or an object with the following\noptions:\n\n* **width:** the width of a column.\n* **align:** alignment, `right` or `center`.\n* **padding:** `[top, right, bottom, left]`.\n\n### cliui.span(column, column, column)\n\nSimilar to `div`, except the next row will be appended without\na new line being created.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/bcoe/cliui/issues"},"homepage":"https://github.com/bcoe/cliui","_id":"cliui@2.1.0","_shasum":"4b475760ff80264c762c3a1719032e91c7fea0d1","_from":"https://registry.npmjs.org/cliui/-/cliui-2.1.0.tgz","_resolved":"https://registry.npmjs.org/cliui/-/cliui-2.1.0.tgz"}