cli- truncate 语法
将字符串切入终端的特定宽度
优雅地处理 ANSI逃脱。像一个字符串样式 chalk,它也支持Unicode代对和全宽字符.
安装
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'
// Truncate Unicode surrogate pairs
cliTruncate('uni\uD83C\uDE00corn', 6);
//=> '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 elit. Aenean commodo ligula…'
[注] 切换样式文本( ANSI 逃脱) 时, 切换字符在断点继承样式
position: 'start'财务报告和审定财务报表position: 'end'。这不适用于position: 'middle'。 。 。 .
API 密码
cliTruncate(文本、列、选项?)
文本
类型 : string
文取为通.
栏
类型 : number
航站楼内占用的柱子数量有限.
选项
类型 : object
职位
类型 : string
默认 : 'end'
数值 : 'start' | 'middle' | 'end'
调弦的位置 .
空间
类型 : boolean
默认 : false
在文本和椭圆之间添加一个空格.
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'
偏好空间上的 Truncation
类型 : boolean
默认 : false
如果字符串在3个字符以内, 则从一个空白空间将字符串从实际的断点截断 .
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'
切换 字符
类型 : string
默认 : …
断点时要使用的字符 .
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'