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

PR-URL: https://github.com/nodejs/node/pull/20190 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2.6 KiB
2.6 KiB
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
© Shannon Moeller me@shannonmoeller.com (shannonmoeller.com)
Licensed under MIT