开发工具代码质量Lint静态分析【免费下载链接】markdownlintA Node.js style checker and lint tool for Markdown/CommonMark files.项目地址https://gitcode.com/gh_mirrors/ma/markdownlint点击查看免费下载本篇以 markdownlint 仓库自带的测试文件 table-column-style-default.md 为主体完整讲解 MD060/table-column-style 规则在默认参数style: any、aligned_delimiter: false下的检查行为默认模式如何为每张表选择违规最少的最接近风格、6 组风格 × 有无边界管道测试表格各自的预期违规行以及 lib/md060.mjs 中按有效列宽对齐、按空格 token 修复的源码级实现。读完后你可以精确预测任意表格在默认配置下的 MD060 违规结果并理解其自动修复fixInfo的边界。MD060 规则概览MD060 是 markdownlint 内置的表格样式规则用于检查 GitHub Flavored Markdown 表格中列分隔管道符|的使用是否一致。规则元数据在 lib/md060.mjs 第 80–85 行声明export default { names: [ MD060, table-column-style ], description: Table column style, tags: [ table ], parser: micromark, // ...关键元信息与 doc/md060.md 一致名称MD060别名table-column-style配置文件中两个名字均可使用标签tagstable解析器micromark从源码结构看规则基于 micromark 的 GFM table 扩展 token 而非 markdown-it这也是本仓库多数表格规则的实现路径支持自动修复部分违规Some violations can be fixed by tooling具体边界见下文自动修复一节。参数只有两个schema/markdownlint-config-schema.json 中MD060节点第 4674–4724 行定义了与文档一致的取值参数说明类型默认值可选值style表格列样式stringanyaligned/any/compact/tightaligned_delimiter分隔行delimiter row的管道是否与标题行管道对齐booleanfalse—除参数外规则配置还支持通用字段enabled默认true与severityerror/warning默认error。四种列样式的定义与示例MD060 基于常见用法识别三种列样式any是不做限定的默认取值。三种风格各自的规范形态如下继承自 doc/md060.md 的示例aligned管道垂直对齐aligned风格要求管道符在各行上垂直对齐| Character | Meaning | | --------- | ------- | | Y | Yes | | N | No |aligned只关注管道位置忽略单元格内容本身因此下面的写法同样合法| Character | Meaning | |-----------|---------| | Y | Yes | | N | No |compact单元格内容两侧各保留单个空格compact风格避免多余填充单元格内容两侧各用一个空格| Character | Meaning | | --- | --- | | Y | Yes | | N | No |tight完全无填充tight风格对单元格内容不做任何空格填充|Character|Meaning| |---|---| |Y|Yes| |N|No|aligned_delimiter强制分隔行与标题行对齐将aligned_delimiter参数设为true后分隔行中的管道必须与标题行中的管道对齐。该选项常与compact/tight搭配使用使表头文字更醒目对aligned风格的表这一点本来就已经是必需的。compactaligned_delimiter| Character | Meaning | | --------- | ------- | | Y | Yes | | N | No |tightaligned_delimiter|Character|Meaning| |---------|-------| |Y|Yes| |N|No|两条重要说明Note不要求边界管道MD060 并不要求表格首尾带|所以下面这种没有边界管道的写法同样是合法的compact表格Character | Meaning --- | --- Y | Yes N | No这正是本文测试文件把每一组表格都拆成Edge Pipes / No Edge Pipes两个变体的原因——边界管道的有无不影响 MD060 判定。对齐按视觉宽度而非字符数计算aligned风格判断管道对齐时依据的是视觉外观。由于编辑器通常把 emoji 与 CJK 字符渲染为拉丁字符的两倍宽度规则对此做了补偿处理。下面的表格是正确格式在大多数编辑器和等宽字体中都会呈现对齐效果| Response | Emoji | | -------- | ----- | | Yes | ✅ | | No | ❎ |该行为的实现证据见下文 lib/md060.mjs 的getTableDividerColumns对齐比较用的是stringWidth计算出的有效列号而不是原始字符列号。默认行为style: any的工作原理当style参数设为aligned、compact或tight时每一张表格都必须匹配对应风格违规都会被报告默认any下每张表格会独立分析它是否满足任一支持的风格若满足任一种则不报告任何违规若不满足任何风格则报告哪种风格产生的违规最少即最接近匹配的风格的那一组违规。这条最接近风格策略是本文测试文件全部预期结果的依据。源码中该策略的完整实现见 lib/md060.mjs 第 190–206 行// Report errors for whatever (allowed) style has the fewest let errorInfos errorsIfAligned; if ( styleCompactAllowed ((errorsIfCompact.length errorInfos.length) || !styleAlignedAllowed) ) { errorInfos errorsIfCompact; } if ( styleTightAllowed ((errorsIfTight.length errorInfos.length) || (!styleAlignedAllowed !styleCompactAllowed)) ) { errorInfos errorsIfTight; } for (const errorInfo of errorInfos) { onError(errorInfo); }从源码结构看选择逻辑是以 aligned 错误为基准compact/tight 只有在严格更少时才替换。结合前文满足任一风格即零违规的文档描述可以推断默认配置下实际报告的总是三种风格中错误数最小的那一份并列时保留先入选的风格。源码实现解析lib/md060.mjs入口与参数解析lib/md060.mjs 第 86–95 行是规则函数入口function: function MD060(params, onError) { const style String(params.config.style || any); const styleAlignedAllowed (style any) || (style aligned); const styleCompactAllowed (style any) || (style compact); const styleTightAllowed (style any) || (style tight); const alignedDelimiter !!params.config.aligned_delimiter; const lines params.lines; // Scan all tables/rows const tables filterByTypesCached([ table ]);要点style缺省值any在此处落地——文档中默认any的说法与代码params.config.style || any完全对应三个style*Allowed布尔量把当前表格是否允许按该风格判定抽象出来后文同时驱动是否检查与如何比较最少违规表格通过filterByTypesCached([ table ])从 micromark token 流中取出带缓存见 lib/cache.mjs逐张表格、逐行tableDelimiterRow/tableRow检查。aligned 风格检查checkStyleAlignedlib/md060.mjs 第 63–78 行function checkStyleAligned(lines, rows, detail) { const errorInfos []; const headerRow rows[0]; const headerDividerColumns getTableDividerColumns(lines, headerRow); for (const row of rows.slice(1)) { const remainingHeaderDividerColumns new Set(headerDividerColumns.map((column) column.effective)); const rowDividerColumns getTableDividerColumns(lines, row); for (const dividerColumn of rowDividerColumns) { if ((remainingHeaderDividerColumns.size 0) !remainingHeaderDividerColumns.delete(dividerColumn.effective)) { addError(errorInfos, row.startLine, dividerColumn.actual, detail); } } } return errorInfos; }对应行为以第一行为标题行rows[0]只与后续行比较rows.slice(1)——所以标题行自身永远不会被 reported这解释了测试文件中各违规集都不包含首行行号每根标题行管道的位置放进一个Set后续每根管道若能从集合中delete掉同位置元素即视为对齐否则记一条违规。注意这里按顺序消费集合元素标题 2 根、数据行 3 根同列这类错位也能被检出违规的行列信息行号用row.startLine列号用管道符的实际列号dividerColumn.actual1 基与测试注解{MD060:-N}中的 N 对应。有效列宽stringWidth 处理 emoji 与 CJKlib/md060.mjs 第 43–53 行function getTableDividerColumns(lines, row) { return filterByTypes( row.children, [ tableCellDivider ] ).map( (divider) ({ actual: divider.startColumn, effective: stringWidth(lines[row.startLine - 1].slice(0, divider.startColumn - 1)) }) ); }每根tableCellDivider得到两个列号actual原始字符列用于报错定位与effective对管道之前整段内容用stringWidth求出的视觉宽度用于对齐比较。这正是文档 Note 中对齐基于视觉外观而非字符数的实现emoji/CJK 被计为两倍宽从而保证在等宽字体下肉眼对齐的表格不会误报。仓库中与该点相关的其他测试文件如table-column-style-emoji.md、table-column-style-wide-characters.md也从侧面印证了这一设计。compact / tight 检查逐 token 判空格lib/md060.mjs 第 106–188 行对每张表遍历每一行取出tableCellDivider、tableContent、whitespace三类 token对每根有左右邻居的内部管道分别检查左侧与右侧空格。规则可以概括为相邻 token 情况compact 判定tight 判定左侧是whitespace且长度 ≠ 1pipe has extra space to the leftpipe has space to the left左侧不是空格内容紧贴pipe is missing space to the left无违规右侧是whitespace且长度 ≠ 1 且未到行尾pipe has extra space to the rightpipe has space to the right右侧不是空格pipe is missing space to the right无违规两个细节值得注意行尾空格不算右侧空格违规next.endColumn ! row.endColumn这一条件意味着管道后面若直接就是行尾即单元格内容缺失、只剩尾部空格紧凑风格不报多余空格。这就是测试文件中带尾随空格的表如第 53、107 行违规数与看似空格更多的直觉不符的原因每条违规都带fixInfo多余空格记为{ editColumn, deleteCount }缺少空格记为{ editColumn, insertText: }。也就是说compact/tight的违规是单管道局部修复这与文档compact/tight 可自动修复的说法一致。而checkStyleAligned生成的错误不带fixInfo——因为对齐违规往往牵动整表宽度修复需要重排全表所以文档明确说 aligned 的违规不自动修复。aligned_delimiter只查前两行lib/md060.mjs 第 115–119 行if (alignedDelimiter) { const errorInfos checkStyleAligned(lines, rows.slice(0, 2), Table pipe does not align with header for option \aligned_delimiter\); errorsIfCompact.push(...errorInfos); errorsIfTight.push(...errorInfos); }aligned_delimiter: true时把前两行标题行 分隔行的对齐检查同时计入 compact 与 tight 的错误列表即要求分隔行管道对齐标题行管道。这与文档表述对 aligned 风格本来就已要求吻合。一个短路优化lib/md060.mjs 第 111–114 行if ( (styleCompactAllowed || styleTightAllowed) !(styleAlignedAllowed (errorsIfAligned.length 0)) ) {若当前允许 aligned 且该表零 aligned 违规则整表合法直接跳过 compact/tight 的计算。对应文档表述若满足任一支持风格则不报告违规同时避免了不必要的逐 token 扫描。测试文件解读table-column-style-default.md 的 6 组表格table-column-style-default.md 是仓库针对 MD060默认参数style: any、aligned_delimiter: false设计的用例文件。它不写任何table-column-style配置——默认即最接近风格模式——只通过文件底部的markdownlint-configure-file指令关闭了相邻的table-pipe-styleMD059规则以隔离 MD060 行为!-- markdownlint-configure-file { table-pipe-style: false } --文件内共 6 个##小节覆盖 3 种风格aligned / compact / tight× 2 种边界管道形态Edge Pipes / No Edge Pipes。每个小节含 13 张故意制造少量瑕疵的表格表格下方用{MD060:-N}注解标注预期违规行号负数表示该行是相对文件顶部的行号本文件即字面行号多个注解按列号升序排列。测试运行器对test/*.md下所有此类文件批量执行 lint 并校验注解入口见 test/markdownlint-test.mjs 中对test/*.md的文件收集与逐文件断言。以下逐节给出完整表格内容与预期结果的解读。1. Aligned / Edge Pipes有边界管道第一张表完全对齐预期零违规第二张表的分隔行第 2 列短 1 格、数据行又分别多/少空格构成 3 处 aligned 违规表格内容原文照录预期 MD060 违规行:列表 1见下方代码块 A无表 2见下方代码块 B第 17 行{MD060:-5} {MD060:-3} {MD060:-2}代码块 A第 5–9 行| Heading | Heading | Heading | | ------- | --------- | ------- | | Text | Text text | Text | | Text | Text text | Text | | Text | Text text | Text |代码块 B第 11–15 行| Heading | Heading | Heading | | ------- | -------- | ------- | | Text | Text text | Text | | Text | Text text | Text | | Text | Text tex | Text |表 2 的 3 根错位管道第 12 行分隔行第 2 列列 17比标题行短 1 格、第 14 行第 2 列右移 1 格列 18、第 15 行第 3 列左移 1 格列 23恰好对应注解-5列 5、-3列 18、-2列 23——注解按列号升序排列这一点从该表可以直观看出。2. Aligned / No Edge Pipes无边界管道与上一节结构相同仅去掉首尾管道。MD060 不要求边界管道见前文 Note所以预期结果逐行相同第 33 行{MD060:-5} {MD060:-3} {MD060:-2}。Heading | Heading | Heading ------- | --------- | ------- Text | Text text | Text Text | Text text | Text Text | Text text | TextHeading | Heading | Heading ------- | -------- | -------- Text | Text text | Text Text | Text text | Text Text | Text tex | Text这两段分别位于文件第 21–25 行与第 27–31 行注解位于第 33 行。对照第 1 节可以验证边界管道的有无完全不影响 MD060 的违规集合。3. Compact / Edge Pipes三张表注解位于第 55 行{MD060:-4} {MD060:-3} {MD060:-2}。| Heading | Heading | Heading | | ------- | ------- | ------- | | Text | Text text | Text | | Text text | Text text text | Text | | Text | Text | Text || Heading | Heading | Heading | | - | - | - | | Text | Text text | Text | | Text text | Text text text | Text | | Text | Text | Text || Heading | Heading | Heading | | - | --- | - | | Text | Text text | Text | | Text | Text | Text | | Text | Text | Text |前三张表中只有第三张违规标题行第 2 列比后续行宽 1 格导致第 2 列管道在分隔行第 50 行列 18、第 51 行列 19、第 53 行列 21三处错位即注解-4/-3/-2对应的列号。注意在默认any模式下该表虽然报的是看起来像对齐问题的管道错位但按源码的最少违规比较逻辑实际被选定报告的是 compact 错误列表该表 compact 违规 3 条 aligned 违规 5 条错误文案为 Table pipe has extra/missing space … for style compact。4. Compact / No Edge Pipes三张表注解位于第 77 行{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-2}。Heading | Heading | Heading ------- | ------- | ------- Text | Text text | Text Text text | Text text text | Text Text | Text | TextHeading | Heading | Heading -- | -- | -- Text | Text text | Text Text text | Text text text | Text Text | Text | TextHeading | Heading | Heading -- | --- | -- Text | Text text | Text Text text | Text text text | Text Text | Text | Text第三张表第 71–75 行的违规全部来自空格填充而非对齐第 73 行第 1 列管道左侧多 1 个空格列 6、第 73/75 行第 2 列管道左侧多 1 个空格列 15、第 75 行第 2 列管道右侧多 1 个空格列 17。4 条 compact 违规少于 aligned 风格下的 8 条错位违规因此报告的是 compact 一组——这正是默认any模式按最少违规选风格的典型样本。5. Tight / Edge Pipes三张表注解位于第 99 行{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-3} {MD060:-2}。|Heading|Heading|Heading| |-------|-------|-------| |Text|Text text|Text| |Text text|Text text text|Text| |Text|Text|Text||Heading|Heading|Heading| |--|--|--| |Text|Text text|Text| |Text text|Text text text|Text| |Text|Text|Text||Heading|Heading |Heading| |-------|-------|------- | | Text|Text text |Text| |Text text |Text text text|Text| |Text| Text |Text|第三张表第 93–97 行违规 5 处列 6/15/17/26/28标题行第 2 列多 1 个空格导致该列管道后续各行错位外加数据行内单元格左右多出的零星空格。按最少违规比较tight5 条 compact7 条 aligned6 条因此报告 tight 一组文案形如 Table pipe has space to the left for style tight。6. Tight / No Edge Pipes三张表注解位于第 121 行{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-2}。Heading|Heading|Heading -------|-------|------- Text|Text text|Text Text text|Text text text|Text Text|Text|TextHeading|Heading|Heading --|--|-- Text|Text text|Text Text text|Text text text|Text Text|Text|TextHeading|Heading |Heading -------|-------| ------- Text |Text text|Text Text text|Text text text|Text Text| Text |Text第三张表第 115–119 行违规 4 处列 6/14/22/27同样按 tight 风格报告。与第 5 节对照无边界管道版本少了一条行尾第 3 列错位类违规无尾管道时该位置不存在违规集合从 5 个减为 4 个再次印证边界管道不是 MD060 的判定对象。六组表格的完整预期结果速查小节文件行范围表格数违规表注解行注解内容被选定的报告风格推断Aligned / Edge Pipes2第 2 张17{MD060:-5} {MD060:-3} {MD060:-2}alignedAligned / No Edge Pipes2第 2 张33{MD060:-5} {MD060:-3} {MD060:-2}alignedCompact / Edge Pipes3第 3 张55{MD060:-4} {MD060:-3} {MD060:-2}compact3 5Compact / No Edge Pipes3第 3 张77{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-2}compact4 8Tight / Edge Pipes3第 3 张99{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-3} {MD060:-2}tight5 6 7Tight / No Edge Pipes3第 3 张121{MD060:-6} {MD060:-5} {MD060:-4} {MD060:-2}tight从这张速查表可以读出默认any模式的两个特征一是完全合法的表不报任何东西每节第 1、2 张表均未出现在注解中二是瑕疵表按最接近风格报告报告风格取决于三种风格各自错误数的最小值而非表格看起来像哪种风格。如何运行本测试文件并验证结果仓库未提供预装依赖无node_modules只读查看即可若在自己的副本中运行步骤为npm install npx markdownlint test/table-column-style-default.md预期输出应恰好包含 6 条 MD060 违规行 17、33、55、77、99、121列如前表所述且由于文件底部markdownlint-configure-file已关闭table-pipe-style不会出现 MD059 混入。完整测试套件含注解校验的入口是 package.json 中test脚本node --test …驱动的 test/markdownlint-test.mjs 等。若想看其他参数组合下的同一组表格可对照阅读同目录下按参数命名的兄弟文件table-column-style-aligned.mdstyle: aligned、table-column-style-compact.md、table-column-style-tight.md、table-column-style-aligned-delimiter.mdaligned_delimiter: true以及边界场景文件 table-column-style-emoji.md、table-column-style-wide-characters.md、table-column-style-empty-cells.md、table-column-style-trailing-spaces.md、table-column-style-irregular-trailing-pipe.md。实际配置方式与自动修复边界在配置文件中如.markdownlint.json启用并固定风格{ MD060: { style: aligned, aligned_delimiter: false } }或使用别名{ table-column-style: { enabled: true, severity: error, style: compact, aligned_delimiter: true } }配置文件中的注释式内联指令本测试文件使用的就是markdownlint-configure-file用于整文件级覆盖另有markdownlint-disable/markdownlint-restore等成对指令其识别正则见 helpers/helpers.cjs 第 27 行也适用于 MD060。自动修复方面结合源码可以给出明确边界compact/tight每条违规的fixInfo都是单管道局部的删空格或补空格可自动修复alignedcheckStyleAligned产生的错误不含fixInfo因为对齐往往需要调整整表列宽文档中的示例如下——|Alpha |Delta| |------|-----| |Charlie|Beta|这类表即使只有个别错位管道修复也可能牵动整表因此不自动修复。小结doc/md060.md 给出了 MD060/table-column-style 的完整语义aligned/compact/tight三种列样式、any默认下的最接近风格报告策略、aligned_delimiter分隔行对齐选项、视觉宽度对齐的 CJK/emoji 补偿以及不要求边界管道的宽松边界test/table-column-style-default.md 则用 6 组 13 张带{MD060:-N}注解的表格把默认参数下每种风格的违规行/列精确钉死而 lib/md060.mjs 提供了全部断言的实现依据——checkStyleAligned的标题行管道位置集合算法、stringWidth有效列宽、逐 token 的空格判定与fixInfo修复信息、以及取违规最少风格的贪心选择。三者对照阅读是理解 markdownlint 表格类规则tagtable下的 MD055/MD056/MD058/MD060见 doc/Rules.md设计模式的典型样本。赞分享开发工具代码质量Lint静态分析【免费下载链接】markdownlintA Node.js style checker and lint tool for Markdown/CommonMark files.项目地址https://gitcode.com/gh_mirrors/ma/markdownlint点击查看免费下载相关推荐markdownlint MD060 规则解析以 style: aligned 表格列风格测试为例markdownlint MD060 规则解析以 style: aligned 表格列风格测试为例 本文基于 markdownlint 测试夹具 test/t开发工具代码质量Lint静态分析markdownlint MD060 表格列风格规则aligned / compact / tight 全解析与源码实现markdownlint MD060 表格列风格规则aligned / compact / tight 全解析与源码实现 MD060 别名 table co开发工具代码质量Lint静态分析markdownlint 规则 MD056table-column-count表格列数一致性检查的原理与实战markdownlint 规则 MD056table column count表格列数一致性检查的原理与实战 MD056 别名 table column开发工具代码质量Lint静态分析上一篇HoneySelect2汉化去和谐整合补丁零代码速装指南HS2-HF Patch十分钟上手全攻略下一篇为什么你的此电脑总有删不掉的图标MyComputerManager 快捷方式清理完整指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考