首页
/ Conform.nvim项目中Tree-sitter解析器对Markdown内HTML标签的格式化问题分析

Conform.nvim项目中Tree-sitter解析器对Markdown内HTML标签的格式化问题分析

2025-06-17 19:20:23作者:宣海椒Queenly

在Neovim生态系统中,Conform.nvim作为一款优秀的代码格式化插件,近期被发现存在一个与Tree-sitter解析器相关的格式化问题。该问题主要出现在Markdown文件中包含HTML标签时的格式化处理上。

问题本质

当用户同时安装markdown和html的Tree-sitter解析器时,Conform.nvim的"injected"格式化功能会将Markdown文档中的HTML标签错误识别为需要格式化的代码块。这导致HTML格式化器(如djlint、prettierd等)被错误地应用于普通的HTML标签,而非预期的仅处理代码块中的HTML内容。

技术细节分析

  1. Tree-sitter解析机制:Tree-sitter的注入查询(injection queries)会将Markdown中的HTML标签和代码块都识别为"注入点",而Conform.nvim的"injected"格式化功能正是基于这些注入点工作。

  2. 格式化流程问题:插件会将文档中所有被识别为HTML的内容(包括普通的HTML标签)提取出来,单独交给HTML格式化器处理,这破坏了Markdown文档的原始结构。

  3. 格式化器兼容性问题:不同的HTML格式化器对此情况的处理方式不同:

    • prettierd会产生多余的闭合标签
    • djlint和htmlbeautifier需要多次格式化才能稳定 但最终都会导致文档格式损坏

解决方案

项目维护者已经提交修复,主要变更包括:

  1. 选择性注入处理:修改了注入查询逻辑,明确区分代码块中的HTML和普通HTML标签

  2. 格式化范围限制:确保HTML格式化器只作用于Markdown的代码块区域,而不处理文档中的普通HTML标签

对用户的影响

这一修复使得:

  1. Markdown文档中的HTML标签保持原样
  2. 代码块中的HTML内容仍能获得正确的格式化
  3. 避免了多次格式化导致的文档损坏问题

最佳实践建议

对于需要在Markdown中混合使用HTML的用户:

  1. 确保使用最新版本的Conform.nvim
  2. 对于必须内联的HTML标签,考虑使用代码块包裹
  3. 复杂的HTML内容建议单独放在.html文件中

这一改进体现了Neovim插件生态对文档结构化处理的深入理解,也展示了Tree-sitter与现代格式化工具整合时需要注意的技术细节。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8