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 代碼的可讀性問題。