Create text-based columns suitable for console output from objects orarrays of objects.

Columns are automatically resized to fit the content of the largestcell. Each cell will be padded with spaces to fill the available spaceand ensure column contents are left-aligned.

Designed tohandle sensible wrapping in npm search results.

npm search before & after integrating columnify:

$ npm install --save columnify@latest

varcolumnify=require('columnify')varcolumns=columnify(data,options)console.log(columns)

Objects are converted to a list of key/value pairs:

vardata={"commander@0.6.1":1,"minimatch@0.2.14":3,"mkdirp@0.3.5":2,"sigmund@1.0.0":3}console.log(columnify(data))

KEY               VALUEcommander@0.6.1   1minimatch@0.2.14  3mkdirp@0.3.5      2sigmund@1.0.0     3

vardata={"commander@0.6.1":1,"minimatch@0.2.14":3,"mkdirp@0.3.5":2,"sigmund@1.0.0":3}console.log(columnify(data,{columns:['MODULE','COUNT']}))

MODULE            COUNTcommander@0.6.1   1minimatch@0.2.14  3mkdirp@0.3.5      2sigmund@1.0.0     3

Column headings are extracted from the keys in supplied objects.

varcolumnify=require('columnify')varcolumns=columnify([{name:'mod1',version:'0.0.1'},{name:'module2',version:'0.2.0'}])console.log(columns)

NAME    VERSIONmod1    0.0.1  module2 0.2.0

You can define the maximum width before wrapping for individual cells incolumns. Minimum width is also supported. Wrapping will happen at wordboundaries. Empty cells or those which do not fill the max/min widthwill be padded with spaces.

varcolumns=columnify([{name:'mod1',description:'some description which happens to be far larger than the max',version:'0.0.1',},{name:'module-two',description:'another description larger than the max',version:'0.2.0',})console.log(columns)

NAME       DESCRIPTION                    VERSIONmod1       some description which happens 0.0.1           to be far larger than the maxmodule-two another description larger     0.2.0           than the max

You can disable wrapping and instead truncate content at the maximumcolumn width. Truncation respects word boundaries. A truncation marker,… will appear next to the last word in any truncated line.

varcolumns=columnify(data,{truncate:true,config:{description:{maxWidth:20}}})console.log(columns)

NAME       DESCRIPTION          VERSIONmod1       some description…    0.0.1  module-two another description… 0.2.0

By default, all properties are converted into columns, whether or notthey exist on every object or not.

To explicitly specify which columns to include, and in which order,supply a "columns" or "include" array ("include" is just an alias).

vardata=[{name:'module1',description:'some description',version:'0.0.1',},{name:'module2',description:'another description',version:'0.2.0',}]varcolumns=columnify(data,{columns:['name','version']// note description not included})console.log(columns)

NAME    VERSIONmodule1 0.0.1module2 0.2.0

vardata={"mocha@1.18.2":1,"commander@2.0.0":1,"debug@0.8.1":1}columnify(data,{config:{value:{align:'right'}}})

KEY                  VALUEmocha@1.18.2             1commander@2.0.0          1debug@0.8.1              1

Align Center works in a similar way.

vardata={"shortKey":"veryVeryVeryVeryVeryLongVal","veryVeryVeryVeryVeryLongKey":"shortVal"}columnify(data,{paddingChr:'.'})

KEY........................ VALUE......................shortKey................... veryVeryVeryVeryVeryLongValveryVeryVeryVeryVeryLongKey shortVal...................

By default,columnify sanitises text by replacing any occurance of 1 or more whitespace characters with a single space.

columnify can be configured to respect existing new line characters using thepreserveNewLines option. Note this will still collapse all other whitespace.

vardata=[{name:"glob@3.2.9",paths:["node_modules/tap/node_modules/glob","node_modules/tape/node_modules/glob"].join('\n')},{name:"nopt@2.2.1",paths:["node_modules/tap/node_modules/nopt"]},{name:"runforcover@0.0.2",paths:"node_modules/tap/node_modules/runforcover"}]console.log(columnify(data,{preserveNewLines:true}))

NAME              PATHSglob@3.2.9        node_modules/tap/node_modules/glob                  node_modules/tape/node_modules/globnopt@2.2.1        node_modules/tap/node_modules/noptrunforcover@0.0.2 node_modules/tap/node_modules/runforcover

Compare this with output withoutpreserveNewLines:

console.log(columnify(data,{preserveNewLines:false}))// or justconsole.log(columnify(data))

NAME              PATHSglob@3.2.9        node_modules/tap/node_modules/glob node_modules/tape/node_modules/globnopt@2.2.1        node_modules/tap/node_modules/noptrunforcover@0.0.2 node_modules/tap/node_modules/runforcover

You can change the truncation marker to something other than the default….

varcolumns=columnify(data,{truncate:true,truncateMarker:'>',widths:{description:{maxWidth:20}}})console.log(columns)

NAME       DESCRIPTION          VERSIONmod1       some description>    0.0.1  module-two another description> 0.2.0

If your columns need some bling, you can split columns with customcharacters.

varcolumns=columnify(data,{columnSplitter:' | '})console.log(columns)

NAME       | DESCRIPTION                                                  | VERSIONmod1       | some description which happens to be far larger than the max | 0.0.1module-two | another description larger than the max                      | 0.2.0

columnify usesmycoboco/wcwidth.js to calculate length of multibyte characters:

vardata=[{name:'module-one',description:'some description',version:'0.0.1',},{name:'这是一个很长的名字的模块',description:'这真的是一个描述的内容这个描述很长',version:"0.3.3"}]console.log(columnify(data))

i.e. before columnify added this feature

NAME         DESCRIPTION       VERSIONmodule-one   some description  0.0.1这是一个很长的名字的模块 这真的是一个描述的内容这个描述很长 0.3.3

NAME                     DESCRIPTION                        VERSIONmodule-one               some description                   0.0.1这是一个很长的名字的模块 这真的是一个描述的内容这个描述很长 0.3.3

MIT