cli-truncate

WebJar for cli-truncate

License	MIT
Categories	CLI User Interface
GroupId	org.webjars.npm
ArtifactId	cli-truncate
Last Version	0.2.1
Release Date	Nov 12, 2018
Type	jar
Description	cli-truncate WebJar for cli-truncate
Project URL	http://webjars.org
Source Code Management	https://github.com/sindresorhus/cli-truncate

Download cli-truncate

Filename	Size
cli-truncate-0.2.1.pom
cli-truncate-0.2.1.jar	5 KB
cli-truncate-0.2.1-sources.jar	22 bytes
cli-truncate-0.2.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

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

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/cli-truncate/
implementation 'org.webjars.npm:cli-truncate:0.2.1'

Gradle Kotlin

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

Apache Buildr

'org.webjars.npm:cli-truncate:jar:0.2.1'

Apache Ivy

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

Groovy Grape

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

Scala SBT

libraryDependencies += "org.webjars.npm" % "cli-truncate" % "0.2.1"

Leiningen

[org.webjars.npm/cli-truncate "0.2.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : slice-ansi	jar	[0.0.4]
org.webjars.npm : string-width	jar	[1.0.1,2)

Project Modules

There are no modules declared in this project.

cli-truncate

Truncate a string to a specific width in the terminal

Gracefully handles ANSI escapes. Like a string styled with chalk. It also supports Unicode surrogate pairs and fullwidth characters.

Install

$ npm install cli-truncate

Usage

const cliTruncate = require('cli-truncate');

cliTruncate('unicorn', 4);
//=> 'uni…'

// Truncate at different positions
cliTruncate('unicorn', 4, {position: 'start'});
//=> '…orn'

cliTruncate('unicorn', 4, {position: 'middle'});
//=> 'un…n'

cliTruncate('unicorns rainbow dragons', 6, {position: 'end'})
//=> 'unico…'

cliTruncate('\u001B[31municorn\u001B[39m', 4);
//=> '\u001B[31muni\u001B[39m…'

// Truncate Unicode surrogate pairs
cliTruncate('uni\uD83C\uDE00corn', 5);
//=> 'uni\uD83C\uDE00…'

// Truncate fullwidth characters
cliTruncate('안녕하세요', 3);
//=> '안…'

// Truncate the paragraph to the terminal width
const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
cliTruncate(paragraph, process.stdout.columns));
//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'

API

cliTruncate(text, columns, options?)

text

Type: string

Text to truncate.

columns

Type: number

Columns to occupy in the terminal.

options

Type: object

position

Type: string
Default: 'end'
Values: 'start' 'middle' 'end'

Position to truncate the string.

space

Type: boolean
Default: false

Add a space between the text and the ellipsis.

cliTruncate('unicorns', 5, {space: false});
//=> 'unic…'

cliTruncate('unicorns', 5, {space: true});
//=> 'uni …'

cliTruncate('unicorns', 6, {position: 'start', space: true});
//=> '… orns'

cliTruncate('unicorns', 7, {position: 'middle', space: true});
//=> 'uni … s'

preferTruncationOnSpace

Type: boolean
Default: false

Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.

cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true})
//=> '…rainbow dragons'

// without preferTruncationOnSpace
cliTruncate('unicorns rainbow dragons', 20, {position: 'start'})
//=> '…rns rainbow dragons'

cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true})
//=> 'unicorns…dragons'

cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true})
//=> 'unico…'

// preferTruncationOnSpace would have no effect if space isn't found within next 3 indexes
cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true})
//=> 'uni…ns'

Related

• wrap-ansi - Wordwrap a string with ANSI escape codes
• slice-ansi - Slice a string with ANSI escape codes

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

Versions

Version
0.2.1 Nov 12, 2018