name: Vale description: 在Markdown或文本文件上运行Vale散文检查器并自动修复问题。使用当用户要求检查、校对或改进Markdown或文本文件的写作质量时。
Vale 语法检查与修复
运行Vale在文件上,然后基于检查输出直接修复问题。
工作流程
- 运行Vale,输出JSON格式在目标文件上:
vale --output=JSON <文件或通配符>
-
解析JSON输出。 每个问题有:
Line,Span(列范围) — 位置Check— 规则名称(例如Microsoft.Passive,write-good.Weasel)Message— 人类可读的解释Severity—error,warning, 或suggestionAction.Name— 建议的修复类型(replace,remove,edit)Action.Params— 替换候选
-
读取文件并修复每个问题:
- 对于
replace操作有清晰建议:应用最合适的替换 - 对于风格问题(被动语态、冗长、模糊词):重写句子
- 对于需要判断的问题:使用上下文确定最佳修复
- 跳过与文档领域冲突的规则(例如,医学术语被标记为行话)
- 对于
-
重新运行Vale在修复后验证问题已解决。如果需要,重复。
范围规则
- 如果未指定文件,询问用户要检查哪些文件
- 对于通配符(例如
docs/*.md),按顺序处理每个文件 - 默认只修复
error和warning;如果用户要求彻底检查,包括suggestion
什么不修复
- 领域特定术语被错误标记(医疗、法律、技术术语)
- 有意风格选择(例如,博客文章中的第一人称)
- 代码块和前页内容 — Vale应该已经跳过这些,但需双重检查