"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app/apm/node_modules/cliui/README.md" (8 Mar 2017, 2355 Bytes) of archive /windows/misc/atom-windows.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


Build Status Coverage Status NPM version Standard Version

easily create complex multi-column command-line-interfaces.


var ui = require('cliui')({
  width: 80

ui.div('Usage: $0 [command] [options]')

  text: 'Options:',
  padding: [2, 0, 2, 0]

    text: "-f, --file",
    width: 20,
    padding: [0, 4, 0, 4]
    text: "the file to load." +
      chalk.green("(if this description is long it wraps).")
    width: 20
    text: chalk.red("[required]"),
    align: 'right'


Layout DSL

cliui exposes a simple layout DSL:

If you create a single ui.row, passing a string rather than an object:

as an example...

var ui = require('./')({
  width: 60

  'Usage: node ./bin/foo.js\n' +
  '  <regex>\t  provide a regex\n' +
  '  <glob>\t  provide a glob\t [required]'


will output:

Usage: node ./bin/foo.js
  <regex>  provide a regex
  <glob>   provide a glob          [required]


cliui = require('cliui')

cliui({width: integer})

Specify the maximum width of the UI being generated.

cliui({wrap: boolean})

Enable or disable the wrapping of text in a column.

cliui.div(column, column, column)

Create a row with any number of columns, a column can either be a string, or an object with the following options:

cliui.span(column, column, column)

Similar to div, except the next row will be appended without a new line being created.