mirror of https://github.com/nodejs/node.git synced 2025-05-15 02:04:52 +00:00

History

Myles Borins 2e54524955 deps: update npm to 7.0.0-rc.3 PR-URL: https://github.com/nodejs/node/pull/35474 Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>		2020-10-07 09:59:49 -04:00
..
color.js	deps: upgrade npm to 6.1.0	2018-05-24 23:24:45 -07:00
index.js	deps: upgrade npm to 6.1.0	2018-05-24 23:24:45 -07:00
LICENSE	deps: upgrade npm to 6.1.0	2018-05-24 23:24:45 -07:00
package.json	deps: update npm to 7.0.0-rc.3	2020-10-07 09:59:49 -04:00
README.md	deps: upgrade npm to 6.1.0	2018-05-24 23:24:45 -07:00
test.js	deps: upgrade npm to 6.1.0	2018-05-24 23:24:45 -07:00

README.md

`cli-columns`

Columnated lists for the CLI. Unicode and ANSI safe.

Install

$ npm install --save cli-columns

Usage

const chalk = require('chalk');
const columns = require('.');

const values = [
    'blue' + chalk.bgBlue('berry'),
    '笔菠萝' + chalk.yellow('苹果笔'),
    chalk.red('apple'), 'pomegranate',
    'durian', chalk.green('star fruit'),
    'パイナップル', 'apricot', 'banana',
    'pineapple', chalk.bgRed.yellow('orange')
];

console.log(columns(values));

API

columns(values [, options]): String

values {Array<String>} Array of strings to display.
options {Object}
- character {String} (default: ' ') Padding character.
- newline {String} (default: '\n') Newline character.
- padding {Number} (default: 2) Space between columns.
- sort {Boolean} (default: true) Whether to sort results.
- width {Number} (default: process.stdout.columns) Max width of list.

Sorts and formats a list of values into columns suitable to display in a given width.

Contribute

Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.

Test

$ npm test

Licensed under MIT