gem-hunter
Language: JavaScript
Truncate a string to a specific width in the terminal
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.
npm install cli-truncate
import cliTruncate from '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' > [!NOTE] > When truncating styled text (ANSI escapes), the truncation character inherits the style at the breaking point for `position: 'start'` and `position: 'end'`. This does not apply to `position: 'middle'`. // 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 ?? 80); //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
Type: string
The text to truncate.
Type: number
The finite number of columns to occupy in the terminal.
Type: object
Type: string
Default: 'end'
Values: 'start' | 'middle' | 'end'
The position to truncate the string.
Type: boolean
Default: false
Add a space between the text and the ellipsis.
import cliTruncate from 'cli-truncate'; 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'
Type: boolean
Default: false
Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.
import cliTruncate from 'cli-truncate'; 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 has no effect if space isn't found within 3 characters cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true}); //=> 'uni…ns'
Type: string
Default: …
The character to use at the breaking point.
import cliTruncate from 'cli-truncate'; cliTruncate('unicorns', 5, {position: 'end'}); //=> 'unic…' cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'}); //=> 'unic.' cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''}); //=> 'unico'