ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Biome Markdown 格式化器引用块(Blockquote)格式化规则深度解析

Biome Markdown 格式化器引用块(Blockquote)格式化规则深度解析 开发工具Lint格式化静态分析代码质量前端【免费下载链接】biomeA toolchain for web projects, aimed to provide functionalities to maintain them. Biome offers formatter and linter, usable via CLI and LSP.项目地址https://gitcode.com/gh_mirrors/bi/biome点击查看免费下载本文以 Biome 仓库中的格式化工件 blockquote.md 及其配套快照.snap为核心依据系统梳理 Biome Markdown 格式化器对引用块blockquote的规范化行为包括标记符空格规范化、嵌套层级展开、懒续行合并、边界空行修剪、超长行检测以及引用块与代码块、列表的组合格式化规则。读完本文你将能准确预测任意 Markdown 引用块经 Biome 格式化后的输出并能复现与验证这些规则。一、blockquote.md一份可执行的格式化规范在 Biome 仓库中blockquote.md 是 Markdown 格式化器biome_markdown_formatter的测试规范文件spec。这类文件与大多数文档不同它不是给人阅读的散文而是一份可直接编译执行的输入样例——测试框架会读取该文件内容作为输入运行格式化器再将输出与同目录下的 blockquote.md.snap 快照进行比对任何不一致都会导致测试失败。快照文件头部记录了生成方式source: crates/biome_formatter_test/src/snapshot_builder.rs info: markdown/blockquote.md即快照由 snapshot_builder.rs 生成info字段标明其对应的源 spec 文件。因此这份文档 快照的组合就是引用块格式化规则的白纸黑字规范下面所有结论均可在输入/输出对中逐条验证。二、标记符规范化空格的处理边界Markdown 的引用标记是及可选的后续空格。Biome 格式化器对标记后的空格有一套明确的处理策略从 blockquote.md 的前四组用例即可看出输入输出规则 simple quote simple quote已有标准空格保持不变 quote with multiple words on a single line不变长行内容不截断、不换行no space after marker no space after marker标记后无空格 → 自动补一个空格 extra space after marker extra space after marker标记后多个空格 → 原样保留三条结论值得强调缺空格补齐no space会被规范化为 no space这是引用块最基本的可读性修复多空格保留 extra space的两个空格不会被折叠。这一点在源码中也有印证——引用内容的缩进语义如 4 空格缩进的代码块依赖标记后的空格数量因此格式化器不会粗暴截断不主动断行即使是超长的一行引用内容格式化器也不会将其拆分为多行而是保持原样同时会在诊断中报告超宽详见第六节。三、嵌套引用的展开到 引用块支持任意层级嵌套。Biome 的规范化策略是把紧凑写法的多级标记展开为逐级带空格的写法输入输出 nested quote nested quote nested quote with space nested quote with space triple nested triple nested triple nested with spaces triple nested with spaces first level/ second level/ third level first level/ second level/ third level规则总结为每级引用标记之间补一个空格因此两级→ 三级→ 已经写成 形式的不再改动保持幂等格式化两次结果一致这一规范化让嵌套层级在视觉上一目了然也保证了后续讨论的懒续行合并见第五节能在统一的标记形态上进行。四、引用块内的行内内容与段落结构引用块内部可以是完整的 Markdown 内容Biome 对行内元素与段落结构均有处理4.1 行内格式规范化 quote with **bold** and *italic* → quote with **bold** and _italic_注意*italic*被规范化为_italic_斜体标记符统一为下划线而**bold**保持不变。这是 Biome Markdown 格式化器通用的行内标记规范化在引用块内部同样生效。此外 quote with inline code → 不变 quote with [a link](https://example.com) → 不变行内代码与链接原样保留不做改动。4.2 多段落与空行 first paragraph second paragraph输出保持原样段落间的空行由独立的标记行构成不会被折叠或移除。与此相对真正会被修剪的是边界空行见第六节。4.3 缩进内容保留 indented content → indented content标记后的 4 空格缩进被原样保留。这是引用块内缩进代码indented code的语义基础格式化器不能破坏它。4.4 多个空行与短内容 line one line after multiple blanks输出中连续的两个空引用行也保持不变。另外 short/ a]/ another short这类短内容、包含括号的异常内容均不做特殊处理忠实保留。五、懒续行Lazy Continuation未标记行自动并入引用Markdown 规范允许懒续行引用块之后的缩进或不缩进的行在渲染时仍属于引用内容。Biome 格式化器对此采取显式化策略——给续行补上引用标记这一行为在输入/输出对中非常直观 quote continuation line → quote continuation line quote continuation line → quote continuation line即原本裸写的续行line格式化后统一变成带完整层级标记的 line二级嵌套则补 。相关专项用例见 blockquote_lazy_continuation.md## Canonical foo - bar → 不变规范写法 ## Unformatted foo - bar → foo - bar这里更极端- bar这种列表形式的懒续行会被直接合并进引用内的同一行变成 foo - bar。这说明懒续行合并不只是补标记还可能把续行内容并到前一行末尾。对应的快照 blockquote_lazy_continuation.md.snap 证实了这一点。值得注意的是若续行已经写了完整标记 quote continuation/ line输出保持不变——只有裸续行才会被修复。六、边界空行修剪与超长行检测6.1 引用边界的空行修剪看这段输入 trimmed quote boundaries 输入中引用块首尾各有一个孤立的空引用行格式化后输出为 trimmed quote boundaries首尾的空行被完全移除只保留实际内容行。这就是快照输出中trimmed quote boundaries用例的含义——引用块的边界空行属于冗余Biome 会裁剪它们。这项修剪逻辑在源码中有着落点block_list.rs 中定义了QuoteBoundaryTrim枚举与配套的区间计算函数// crates/biome_markdown_formatter/src/markdown/lists/block_list.rs#L133-L174 pub(crate) enum QuoteBoundaryTrim { None, // 保留边界空行 Leading, // 仅移除内容前的引用空行 LeadingAndTrailing, // 移除内容前、后的引用空行 } pub(crate) fn quote_boundary_trim_range( node: MdBlockList, quote_boundary_trim: QuoteBoundaryTrim, ) - std::ops::Rangeusize { ... }从源码注释block_list.rs可以进一步了解到实现细节起始修剪quote_boundary_trim_start引用块开头可能存在两种纯引用空行形态——第一种由MdQuote节点自身前缀加一个前导MdNewline表示后续的空行则以MdQuotePrefix MdNewline成对出现。扫描会只修剪这两种精确形态一旦遇到引用前缀后紧跟真实内容就立即停止结束修剪quote_boundary_trim_end从后向前扫描只移除末尾孤立的MdQuotePrefix或MdQuotePrefix MdNewline形态单独的MdNewline不足以判定为边界空行必须其前一个块是MdQuotePrefix才行。这两个函数体现了引用边界修剪的两个原则只修剪空行绝不误伤真实内容CST 结构不同修剪策略也要分形态处理。6.2 超长行检测80 字符快照文件末尾专门有一段Lines exceeding max width of 80 characters诊断48: This is a long long long long long long long long long long long long long long long paragraph in a quote.这表明 Biome Markdown 格式化器的默认行宽上限为80 字符与lineWidth默认值一致。当引用内容超过该宽度时格式化器不会强行折行保持引用原文不动但会在诊断信息中报告超宽行及其行号此处为输入的第 48 行。这也解释了为什么第二节中长行内容不截断——超宽只是提示不是改写。七、引用块与代码块、列表的组合除了 blockquote.md同目录下还有一组姊妹 spec覆盖引用块与其他块级元素的组合7.1 引用内的代码块blockquote_code_block.md paragraph text code paragraph text js const x 1; 引用块内的围栏代码块fenced code block可带语言标识如js每一行都带引用标记格式化后保持该结构不变。引用内段落 空引用行 代码块的混合结构也原样保留。7.2 引用内的列表blockquote_list_items.md 1. first item 2. second item 3. third item - alpha - beta引用内的有序列表与无序列表均保持原有编号与符号不做重排。快照 blockquote_list_items.md.snap 确认输入输出完全一致。7.3 列表内嵌引用blockquote_list_stability.md - list - nested quote continuation列表项内再嵌引用块的三明治结构也被稳定保留说明引用块的标记规范化不会破坏列表的缩进层级。八、规则速查表与验证方法8.1 引用块格式化规则速查场景行为后无空格自动补一个空格no→ no后多空格原样保留 x→ x多级标记/展开为 / 斜体*x*规范化为_x_懒续行裸续行补全引用标记或与前一行合并引用开头/结尾的纯空行修剪移除引用内缩进内容保留超 80 字符的行不折行报告超宽诊断引用内代码块/列表原样保留8.2 如何在本仓库复现验证spec 测试由biome_markdown_formattercrate 的测试框架驱动。可在仓库根目录运行 Markdown 格式化器相关测试来复现上述所有行为cargo test相关 target 以biome_markdown_formatter为前缀或直接查看各.snap快照比对输入输出。若后续修改了格式化逻辑只需重新生成快照并人工审查 diff即可确认是否破坏上述规则。九、总结通过 blockquote.md 及其快照Biome 的引用块格式化策略可以凝练为一句话内容语义零改写标记形态规范化。格式化器只负责修复写法问题——补空格、展开嵌套标记、合并懒续行、修剪边界空行、统一斜体标记——而绝不触碰内容本身不折叠多空格、不拆分长行、不重排列表编号、不破坏缩进。这种格式修复、内容不动的设计原则配合 block_list.rs 中按 CST 形态精确修剪边界的实现保证了引用块格式化既安全可预测又幂等稳定。赞分享开发工具Lint格式化静态分析代码质量前端【免费下载链接】biomeA toolchain for web projects, aimed to provide functionalities to maintain them. Biome offers formatter and linter, usable via CLI and LSP.项目地址https://gitcode.com/gh_mirrors/bi/biome点击查看免费下载相关推荐Biome Markdown 格式化器深度解析嵌套列表与 GFM 任务列表的格式化规则Biome Markdown 格式化器深度解析嵌套列表与 GFM 任务列表的格式化规则 导读 Biome 的 Markdown 格式化器 biome_mar开发工具Lint格式化静态分析代码质量前端Biome Markdown 格式化器如何处理引用块内的围栏代码块blockquote_code_block 规格测试深度解析Biome Markdown 格式化器如何处理引用块内的围栏代码块blockquote_code_block 规格测试深度解析 引用块Blockquote开发工具Lint格式化静态分析代码质量前端Biome Markdown 格式化器的有序列表Ordered List格式化规则全解析Biome Markdown 格式化器的有序列表Ordered List格式化规则全解析 本篇技术指南以 Biome 仓库中的 Markdown 格式化规格开发工具Lint格式化静态分析代码质量前端创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表