DSH Web 的文件浏览器默认提供纯文本预览。对于开发者而言,缺乏语法高亮和直接编辑能力会降低代码阅读和修改的效率。该插件旨在解决这一痛点。
这是什么¶
这是一个由 wolfsonliu 维护的 DSH Web 插件。它注册了一个名为 “Code Editor” 的查看器,覆盖了 dsh-file-explorer 的默认纯文本预览。插件基于 CodeMirror 6 构建,提供按语言的语法高亮、行号、撤销/重做等编辑功能,并支持自动保存和主题跟随。
核心功能¶
该插件提供以下能力:
- 多语言语法高亮:支持 90+ 种编程语言的语法高亮,文件扩展名(如
.ts,.json,.py等)会自动映射到对应语言。 - 真正的编辑器:内置 CodeMirror 编辑器,支持行号、自动换行和撤销/重做操作,而非只读的
<pre>标签。 - 自动保存:编辑结束后 500ms 自动保存,同时也支持
Ctrl/Cmd+S立即保存。 - 状态栏:底部状态栏显示当前语言、光标位置(行/列)以及保存状态(未保存、保存中、已保存、保存失败)。
- 主题跟随:编辑器高亮主题会跟随 DSH 的深色/浅色主题切换。
- 查看器注册:作为命名查看器注册,在文件行的 “Open with…” 菜单中显示,可与其他查看器并存。
安装与启用¶
安装前请确保已安装 dsh-file-explorer 插件,并满足 DSH 核心 v0.9.0+ 的版本要求。
- 克隆仓库并安装依赖
git clone https://github.com/wolfsonliu/dsh-file-explorer-preview-code.git
cd dsh-file-explorer-preview-code
npm install && npm run build
- 添加插件到 Web 环境配置
dsh plugin --profile web add .
典型用法¶
安装完成后,启动 DSH Web (dsh web)。在文件浏览器的文件列表中,找到代码文件(如 .js, .py),点击该文件行的 “Open with…” 菜单,选择 “Code Editor” 即可进入编辑模式。
适用场景与注意¶
- 依赖要求:该插件依赖
@dsh-external/dsh-file-explorer,必须先安装该插件才能正常使用命名查看器功能。 - Markdown 限制:插件不支持 Markdown 文件(
.md/.mdx),这些文件会回退到默认预览。 - 直接写入:编辑操作是直接写入工作区文件,没有差异预览或多标签页功能。
- 大文件性能:对于超过 2MB 的大文件,插件会通过
readRawFile加载,可能导致浏览器性能问题。