Truncate a string to a specific width in the terminal
ES5 compatible
Gracefully handles ANSI escapes. Like a string styled with chalk.
$ npm install --save cli-truncate
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('\u001b[31municorn\u001b[39m', 4);
//=> '\u001b[31muni\u001b[39m…'
// 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…'Type: string
Text to truncate.
Type: number
Columns to occupy in the terminal.
Type: Object
Type: string
Default: 'end'
Values: 'start', 'middle', 'end'
Position to truncate the string.
- wrap-ansi - Wordwrap a string with ANSI escape codes
- slice-ansi - Slice a string with ANSI escape codes
MIT © Getgrover