0

0

如何在上传前对XML进行语法高亮和格式化 CodeMirror/Monaco Editor

幻夢星雲

幻夢星雲

发布时间:2026-01-27 06:05:24

|

273人浏览过

|

来源于php中文网

原创

CodeMirror 6 的 @codemirror/lang-xml 仅支持语法高亮,不提供自动缩进或美化功能;需集成 xml-formatter 等工具并在用户触发时调用,同时上传前必须用 DOMParser 校验 XML 合法性。

如何在上传前对xml进行语法高亮和格式化 codemirror/monaco editor

为什么不能直接用 CodeMirror 6 的 XML 模式做格式化

CodeMirror 6 自带的 @codemirror/lang-xml 只负责语法高亮,不提供自动缩进或美化功能。它识别标签、属性、注释,但不会重排换行或补全缩进——你粘贴一段压缩的 XML(比如 text),编辑器默认显示为单行,且无自动格式化入口。

要实现“上传前格式化”,得额外集成 XML 格式化工具,并在用户触发动作(如点击上传按钮、失焦、或 Ctrl+Shift+F)时调用它。

用 xml-formatter + CodeMirror 6 实现一键美化

xml-formatter 是轻量、无依赖、支持缩进/空格/换行控制的纯 JS 库,适配浏览器环境,和 CodeMirror 6 配合最直接。

  • 安装:npm install xml-formatter
  • 导入后,在用户操作时机调用:
    import { format } from 'xml-formatter';
    const formatted = format(editor.state.doc.toString(), {
      indentation: '  ',
      collapseContent: true,
      lineSeparator: '\n'
    });
  • 写回编辑器:
    editor.dispatch({
      changes: { from: 0, to: editor.state.doc.length, insert: formatted }
    });
  • 注意:若 XML 有语法错误(如未闭合标签),format() 会抛出 Error: Parse error,必须 try/catch 并提示用户修正

Monaco Editor 中如何启用 XML 格式化(需后端支持)

Monaco 默认不内置 XML 格式化逻辑,它依赖 Language Server Protocol(LSP)或注册的 documentFormattingProvider。如果你没搭 LS,最简方案是手动注入一个客户端 formatter:

百度文心百中
百度文心百中

百度大模型语义搜索体验中心

下载
  • 先确保 Monaco 加载了 XML 语言支持:monaco.languages.register({ id: 'xml' });
  • 注册格式化提供者(仅客户端,不校验语法):
    monaco.languages.registerDocumentFormattingEditProvider('xml', {
      provideDocumentFormattingEdits(model, options) {
        try {
          const formatted = format(model.getValue(), {
            indentation: options.insertSpaces ? ' '.repeat(options.tabSize) : '\t',
            lineSeparator: '\n'
          });
          return [{
            range: model.getFullModelRange(),
            text: formatted
          }];
        } catch (e) {
          // 不吞错:Monaco 会静默忽略返回空数组,所以这里最好弹个提示
          console.warn('XML 格式化失败:', e.message);
          return [];
        }
      }
    });
  • 之后用户按 Shift+Alt+F 或右键 → “Format Document” 就能触发

上传前校验 XML 合法性比高亮更重要

高亮和格式化都是锦上添花,但上传失败往往卡在解析阶段。别只依赖前端美化,务必在提交前做基础合法性检查:

  • 用原生 DOMParser 快速验证(兼容所有现代浏览器):
    function isValidXML(str) {
      try {
        new DOMParser().parseFromString(str, 'application/xml');
        return !document.querySelector('parsererror');
      } catch {
        return false;
      }
    }
  • 如果返回 false,说明有严重结构错误(如乱码、未闭合、非法字符),此时不应允许上传,也不该尝试格式化——因为 xml-formatter 同样会失败
  • 注意:IE 已淘汰,无需兼容其 ActiveXObject("Microsoft.XMLDOM")

真正容易被忽略的是:格式化函数和校验函数都对 BOM、、非 UTF-8 编码敏感。如果用户从 Windows 记事本复制内容,可能带 BOM 或 \r\n 混用,建议在 format() 前先 .replace(/\r\n/g, '\n') 统一换行符。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

740

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

432

2024.06.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1897

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2091

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1051

2024.11.28

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

510

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

31

2026.01.26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号