在 DeepSeek Harness (DSH) 的开发流程中,直接处理原始 SQL 字符串时,往往缺乏统一的格式标准。dsh-sql-format 插件专注于解决 SQL 输出的可读性问题,通过格式化工具将杂乱的 SQL 转换为结构清晰、关键字大写的文本。
插件定位¶
该插件由用户 istone 维护,属于客户端插件。它并不涉及数据库连接或语义分析,仅对 SQL 字符串进行排版处理。
核心功能¶
插件提供以下能力:
- format_sql:核心工具,用于执行 SQL 格式化。
- SQL 子句换行:将长 SQL 拆分为多行,提升视觉阅读体验。
- 关键字大写:统一 SQL 关键词的大小写,便于识别。
安装与启用¶
安装插件后,需要在项目的配置文件中声明启用。
- 执行安装命令:
dsh plugin add github:uckkk/dsh-sql-format
- 打开 profile 的
package.json文件。 - 在
dsh.profile.bundles配置项中添加"dsh-sql-format"。
典型用法¶
安装并在会话中加载插件后,直接调用 format_sql 函数,传入待格式化的 SQL 字符串即可。
示例:
format_sql(sql="select * from users where age > 18 order by id desc")
注意事项¶
- 纯 Node 实现:插件不解析 SQL 的语义或语法逻辑,仅做字符串排版。
- 代码执行权限:安装即在本机运行第三方代码。请务必在安装前审阅源码与许可证。