DSH 强调插件化架构,侧边栏插件 dsh-better-sidebar 在处理代码时,若缺乏语法高亮会显著降低可读性。dsh-sidebar-gdhighlight 旨在解决这一问题,为 dsh-better-sidebar 提供原生的高亮支持,使开发者能在侧边栏中直接查看和编辑 Godot 代码。
核心功能¶
该插件基于 CodeMirror 6 构建,并提取了 Godot 4.7 编辑器的颜色配置。
- GDScript 4.x 高亮:支持
.gd和.inc文件的完整语法高亮。 - GDShader 高亮:支持
.gdshader和.shader文件的着色器语法高亮。 - Godot 4.7 配色:颜色直接取自
editor_settings-4.7.tres,确保视觉一致性。 - 全面的语法支持:覆盖所有 GDScript 关键字、控制流、类型、内置函数及注解。
- 定义与元素高亮:对函数定义、变量、信号和枚举有专门的样式。
- 复杂语法支持:支持多行字符串、字符串插值(
$"")、节点路径($Node)、字符串名称(&"Name")。 - 交互功能:支持文本选择后通过浮动按钮将代码片段以 fenced 代码块形式插入对话中。
安装与启用¶
使用官方命令进行安装。安装前请确保 DSH(dsh web)已运行,且 dsh-better-sidebar 已安装。
1、执行安装命令:
dsh plugin --profile web add dsh-sidebar-gdhighlight@latest
2、配置生效:安装完成后,需要在浏览器中执行硬刷新(Cmd/Ctrl+Shift+R)以加载新插件。
典型用法¶
- 查看代码:在侧边栏中打开
.gd或.inc文件,查看带有 Godot 4.7 配色的语法高亮。 - 编辑着色器:在侧边栏中打开
.gdshader或.shader文件,进行着色器代码的编辑。 - 代码分享:选中侧边栏中的代码段,点击出现的浮动按钮,将选中的内容作为 fenced 代码块插入到对话界面中。
适用场景与注意¶
- 依赖项:该插件依赖于
dsh-better-sidebar,必须先安装该插件才能正常工作。 - 运行环境:需要 DSH 环境正在运行。
- 浏览器刷新:安装后务必进行硬刷新,否则高亮可能不会生效。
总结¶
dsh-sidebar-gdhighlight 通过集成 CodeMirror 6 并复用 Godot 4.7 的编辑器配色,解决了在 DSH 侧边栏中阅读和编辑 Godot 代码的可读性问题。