cli-columns

WebJar for cli-columns

License	MIT
Categories	CLI User Interface
GroupId	org.webjars.npm
ArtifactId	cli-columns
Last Version	3.1.2
Release Date	Jun 29, 2018
Type	jar
Description	cli-columns WebJar for cli-columns
Project URL	http://webjars.org
Source Code Management	https://github.com/shannonmoeller/cli-columns

Download cli-columns

Filename	Size
cli-columns-3.1.2.pom
cli-columns-3.1.2.jar	7 KB
cli-columns-3.1.2-sources.jar	22 bytes
cli-columns-3.1.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/cli-columns/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>cli-columns</artifactId>
    <version>3.1.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/cli-columns/
implementation 'org.webjars.npm:cli-columns:3.1.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/cli-columns/
implementation ("org.webjars.npm:cli-columns:3.1.2")

Apache Buildr

'org.webjars.npm:cli-columns:jar:3.1.2'

Apache Ivy

<dependency org="org.webjars.npm" name="cli-columns" rev="3.1.2">
  <artifact name="cli-columns" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='cli-columns', version='3.1.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "cli-columns" % "3.1.2"

Leiningen

[org.webjars.npm/cli-columns "3.1.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : string-width	jar	[2.0.0,3)
org.webjars.npm : strip-ansi	jar	[3.0.1,4)

Project Modules

There are no modules declared in this project.

cli-columns

Columnated lists for the CLI. Unicode and ANSI safe.

Install

$ npm install --save cli-columns

Usage

const columns = require('cli-columns');
const chalk = require('chalk');

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

---

MIT © Shannon Moeller

Versions

Version
3.1.2 Jun 29, 2018