Have ideas to improve npm?Join in the discussion! »

    cli-columns

    3.1.2 • Public • Published

    cli-columns

    NPM version Downloads Build Status Coverage Status Chat Tip

    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));
    screenshot

    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

    Install

    npm i cli-columns

    DownloadsWeekly Downloads

    444,092

    Version

    3.1.2

    License

    MIT

    Last publish

    Collaborators

    • avatar