SuperAPI AI 工具集

script-kit-architecture

编程与开发

查看项目

更新于 10-16 14:59

技能介绍

用途

本文档介绍 Script Kit GPUI 代码库的整体结构,用于在浏览代码库、理解模块组织方式或追踪数据流向时作为参考。

仓库结构(关键模块)

根目录为 src/,主要模块如下:

  • main.rs — 应用入口、窗口设置,以及通过 include!() 引入 app_impl / main_sections / render_prompts 等的枢纽。
  • lib.rs — crate 导出。
  • main_sections/ — 应用状态、渲染分发、窗口可见性(通过 include!() 并入 main.rs)。
  • app_impl/ — 应用逻辑:快捷键、输入处理、启动流程(通过 include!() 并入 main.rs)。
  • app_execute/ — 内置执行、脚本执行(通过 include!() 并入 main.rs)。
  • render_prompts/ — 外层提示包装器:arg、div、editor、form 等(通过 include!() 并入 main.rs)。
  • prompts/ — 内层提示实体:chat、env、select、term_prompt(正式 module)。
  • components/ — 可复用 UI 组件:text_input、alias_input、shortcut_recorder(正式 module)。
  • protocol/ — stdin/stdout JSON 协议、消息类型(正式 module)。
  • theme/ — 主题系统、颜色、不透明度常量、HexColorExt(正式 module)。
  • ai/ — AI 聊天窗口、提供方、流式传输(正式 module)。
  • notes/ — Notes 窗口模块(正式 module)。
  • platform/ — macOS ObjC 互操作、面板配置、光标、可见性(正式 module,含 include!())。
  • scripts/ — 脚本加载、执行(正式 module)。
  • builtins/ — 内置命令定义(正式 module)。
  • hotkeys/ — 全局快捷键注册(正式 module)。
  • watcher/ — 文件系统监听器(正式 module)。
  • ui_foundation/ — 按键辅助函数(is_key_*)、布局常量、十六进制颜色工具。

日志路径:~/.scriptkit/logs/script-kit-gpui.jsonl

SDK 部署架构

SDK 源文件:scripts/kit-sdk.ts

采用两级部署:

  • 构建时(开发):build.rs 将 scripts/kit-sdk.ts 复制到 ~/.scriptkit/sdk/。
  • 编译时:executor.rs 通过 include_str!("../scripts/kit-sdk.ts") 嵌入。
  • 运行时:ensure_sdk_extracted() 将嵌入的 SDK 写入 ~/.scriptkit/sdk/kit-sdk.ts。
  • 执行:bun run --preload ~/.scriptkit/sdk/kit-sdk.ts <script>。

测试从仓库路径 ../../scripts/kit-sdk 导入;生产环境使用运行时提取的 SDK。

tsconfig 映射:

{ "compilerOptions": { "paths": { "@scriptkit/sdk": ["./sdk/kit-sdk.ts"] } } }

用户配置(~/.scriptkit/config.ts)

import type { Config } from "@scriptkit/sdk"; export default { hotkey: { modifiers: ["meta"], key: "Semicolon" }, padding: { top: 8, left: 12, right: 12 }, editorFontSize: 16, terminalFontSize: 14, uiScale: 1.0, builtIns: { clipboardHistory: true, appLauncher: true }, bun_path: "/opt/homebrew/bin/bun", editor: "code" } satisfies Config;

Rust 辅助函数(使用这些函数,它们会处理默认值):

  • config.get_editor_font_size()(默认 14)
  • config.get_terminal_font_size()(默认 14)
  • config.get_padding()(上 8,左/右 12)
  • config.get_ui_scale()(默认 1.0)
  • config.get_builtins()(clipboardHistory/appLauncher 默认 true)
  • config.get_editor()(默认 "code")

字体大小:

  • 编辑器:line_height = font_size * 1.43
  • 终端:line_height = font_size * 1.3

参考文档

  • System Diagrams — 架构、状态机、执行流程图
  • Notes Window — Notes 模块细节
  • AI Window — AI 聊天模块细节
  • Gotchas — 常见问题与修复
  • Vibrancy — macOS 活力/模糊模式

限制

以上仅覆盖资料中明确给出的结构与配置信息;未提及具体功能效果、收费、价格或平台支持范围,暂未提供。