线条包装
一个叉子 文字包装 速度更快,力量更强, 支持 HTML, ANSI 颜色代码, 多个段落样式, 以及更多.
在3.4GHz Sandy Bridge核心上,线圈在包装时大约能达到20MB/s 在80个列,或者如果在20个列上被包裹,则15MB/s.
线包是 差点 向后兼容文字包装 。 行为只不同 在一些边缘的情况下,我认为 文字包装没有做出最好的选择。 你也许 不会发现正常用途有任何不同.
安装
npm install linewrap
使用量
var linewrap = require('linewrap');
// Wrap the string at 20 columns, using Windows-style line breaks.
var wrap = linewrap(20, {lineBreak: '\r\n' /*, other options */});
console.log(wrap('You and your whole family are made out of meat.'));
// Wrap the string at 20 columns, prepend 10 spaces to each line, and
// skip HTML tags when counting columns for wrapping.
var wrap = linewrap(10, 30, {skipScheme: 'html' /*, other options */});
console.log(wrap('You and your <b>whole family</b> are made out of <i>meat</i>.'));
选项
跳过字符串
相关备选方案数字 : skip, (中文(简体) ), skipScheme。 。 。 .
有时,文本中的某些字符被用来控制样式、注释 附加信息等,且不打算显示。 实例 包括HTML标记和ANSI颜色代码. 不应该算这些角色 当做包装.
支持的数值 联 合 国 skip数字 :
RegExp。 。 。 .string。 。 。 .
指定正则表达式或字符串与输入匹配,全部 输入中的匹配序列仅被复制到输出并被忽略 根据包装算法.
skipScheme 可选择以下值之一: "ansi-color", (中文(简体) ), "html",以及
"bbcode"。它们是用于共同任务的预配置正则表达式.
当两个选项都指定时, skip 以优先为准.
换行字符串
相关备选方案数字 : lineBreak, (中文(简体) ), lineBreakScheme。 。 。 .
要支持自定义换行符,实际上需要两个参数
指定:用于匹配输入中的换行符的正则表达式(P1, (中文(简体) ),
和输出中用作换行符的字符串(P2) (中文(简体) ).
支持的数值 联 合 国 lineBreak数字 :
string它被用作P2,则aRegExp从字符串中创建对象 用作P1。 。 。 .[RegExp, string]编辑RegExp对象用作P1字符串 作为P2。 。 。 .[string, string]A级RegExp对象是从第一个字符串创建并使用的 作为P1,第二个字符串作为P2。 。 。 .RegExp它被用作P1我们将匹配正则表达式与 输入并使用第一个匹配作为P2如果找不到匹配,则例外 抛出. 未建议
例如,您可以使用 /\n/ 作为 P1 财务报告和审定财务报表 "<br>" 作为 P2 转换字符串
从一种格式到另一种格式.
lineBreakScheme 可选择以下值之一: "unix", (中文(简体) ), "dos", (中文(简体) ), "mac", (中文(简体) ),
"html",以及 "xhtml"。每个方案都规定: P1 财务报告和审定财务报表 P2 具体
场景.
当两个选项都指定时, lineBreak 以优先为准.
现有换行符
相关选项数字 : respectLineBreaks。 。 。 .
此选项控制如何处理输入中的现有行间断 。 这很重要 用于支持各种段落样式.
支持的数值数字 :
"all"默认。所有现有的换行符都保留下来."none"。所有现有的换行符都被丢弃."multi"。只有两个或两个以上的连续换行符(可以有空白) )被保留,单行断开被丢弃. 这可能是 用于支持在 段落结构 被保存下来."m<num>"。指定一个数字以表示连续的换行次数 被保留下来。 譬如说,"multi"等同为"m2"。 。 。 ."s<num>"。指定一个数字来表示立即出现的换行符 之后至少保留了多少个白空间 。 这可以用来 支持每一段第一行缩进的段落样式.
空白区
相关选项数字 : whitespace。 。 。 .
此选项可控制是否从中剥去前方和后方的空白 输出。 原始的文字包装在这个区域不一致: 它在前面剥去 除第一行外,所有行的白空格都取出 有些台词,但有些台词不行.
支持的数值数字 :
"default"默认前面和后面的白地都被剥去. 这是最相似的文字包装的行为."collapse"。除此之外"default",也可以连续折叠白空格 在每行内."line"类似"default",但不要剥去前白空间 线条从输入中保留(不是我们所包)。 可用此选项 与"s<num>"选项respectLineBreaks支持缩进 段落样式,以便保留用于标记新段落的缩进. 在Markdown等加分语言中,先入为主的白地也相当显著."all"。所有白空间都保留下来。 在此模式下, 白空格被处理 像其他非麻痹字符一样,显示但可以包裹 在任何职位.
保留行中的其他缩进
相关选项数字 : preservedLineIndent。 。 。 .
此选项对从输入中保存的行应用了额外的缩进. 这个 例如,可用于从空白行分页样式转换为 缩进段落样式.
preservedLineIndent 必须是非负整数,指定该数值
缩入. 如果指定,所有被保存的行会由这个金额缩入.
包裹行中的额外缩进
相关选项数字 : wrapLineIndent, (中文(简体) ), wrapLineIndentBase。 。 。 .
此选项对被包裹的行应用了额外的缩进. 这样可以进行精细控制 以下列实例为例:
Red: the color of blood, rubies
and strawberries.
Green: the color of growing grass
and leaves, of emeralds,
and of jade.
Blue: the color of the clear sky
and the deep sea.
支持的数值 联 合 国 wrapLineIndentBase数字 :
RegExp。 。 。 .string。 。 。 .
wrapLineIndent 必须是指定缩进量的整数。 如果只是这样的话
wrapLineIndent 指定,它必须是非负整数,所有被包裹的行
缩入这个数额。 若为 wrapLineIndentBase 也指定,它被搜索
在每一条被保存行中: 如果找到, 所有属于此被保存行的被包裹行
缩进为总和 wrapLineIndent 和匹配的索引(如果和
正整数; 如果找不到, 属于此保留线的被包线
没有缩进.
譬如说, wrapLineIndentBase: ':', wrapLineIndent: 2 可用于生成
得出上述例子.
硬包装
相关选项数字 : mode。 。 。 .
支持的数值数字 :
"soft"默认拆分块/(\S+\s+/别拆散那些块 比包装长度长。 所以如果一个单词比包装长 它的长度会溢出."hard"拆分块/\b/并打破块 比包装长 长度.
标签宽度
相关选项数字 : tabWidth。 。 。 .
全体 \t 字符在进行前被替换为一定数量的空格
包装。 此选项控制要替换的空格 \t。默认为 4.
预设
相关选项数字 : preset。 。 。 .
你是否为太多的选项而不堪重负? 不要担心,预设是 救援队!
每个预设包含一个或多个选项的值. 您可以指定一个 单个预设或一组预设。 如果数组中的多个预设设置 同样的选择,最后一个获胜.
支持的数值数字 :
"html"设置skipScheme财务报告和审定财务报表lineBreakScheme改为"html",以及whitespace改为"collapse"。 。 。 .
设置的选项明确以预设设置的选项为首.
欢迎您提出新的计划和预设 创建问题。 。 。 .
鸣谢
感谢 詹姆斯·哈利戴(英语:James Halliday) 对文字包装.
许可证
MIT 许可证