SuperAPI AI 工具集

semantic-line-breaks

通用与其它

查看项目

更新于 10-16 04:58

技能介绍

用途:在 specs/、doc/ 下的 Markdown 散文(规格、需求、ADR、README 式文档)中执行语义换行(Semantic Line Breaks,又称 ventilated prose),使渲染结果不变而 diff 更易评审,让单句修改显示为单行差异而非整段重排。

主要能力:句号不自动换行——缩写、小数、版本号等非终结句号保持同行;语义上属于同一单元的句子可同行。可在主要从句边界(;, :, 破折号后、长插入语前)额外断行。规范参见 https://sembr.org。

行宽:适用散文每行最多 80 字符(含空格与缩进)。超限时在从句、短语、词等自然边界加软换行,直到无行超过 80 字符。

使用方式:换行位置只能靠人判断,不可用脚本、格式化器、正则重排或批量修行工具处理。编辑既有段落时,若该段原为含多句的长行,需在同一编辑中手工整段重排为语义换行并满足 80 字符上限,即使未改动其中的句子;此后该段 diff 保持干净。段落仍以空行分隔。

不适用范围:不得在围栏代码块、行内代码、表格行、链接引用定义、YAML frontmatter、原始 HTML 块内插入句中换行。列表项的散文仍受 80 字符约束,必要时按句换行,续行缩进对齐该项文本列。

硬换行:同一渲染段落内需可见换行时(如地址行),行尾用恰好两个空格;不得用一个、三个及以上空格或 <br> 标签,doc-validate 会拒绝其他形式。

限制:资料未提供具体安装命令、脚本名称、许可与平台支持信息;规则本身明确不适用于自动工具批量重排。