refactor: extract Monaco setup and completion providers from QueryEditor

未关闭
#5 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
冷清
技术栈
react, typescript

调研方向

Start with src/components/editor/QueryEditor.tsx and locate the Monaco setup, JOIN and schema completion providers, intention actions, and live-template expansion. Read the existing editor lifecycle and useLiveTemplates usage before deciding how their dependencies are registered and disposed. The requested files are monacoSetup.ts, sqlCompletionProvider.ts, intentionActions.ts, and liveTemplateProvider.ts alongside the component. Done means the component is under roughly 600 lines, the listed features still work, checks pass, and a Vitest test covers pure live-template expansion.

由索引模型根据 Issue 内容生成。

描述

good first issue help wanted refactor

src/components/editor/QueryEditor.tsx is 1,179 lines. The component itself is fine; the noise is Monaco configuration, language definitions, JOIN suggestion providers, and intention actions inlined alongside the React lifecycle.

What to extract

  1. monacoSetup.ts — theme registration, language token registration, editor option defaults.
  2. sqlCompletionProvider.ts — the JOIN-via-foreign-key autocomplete and the schema-aware identifier suggestions.
  3. intentionActions.ts — the Alt+Enter "intention actions" (quick fixes / refactors offered in the editor).
  4. liveTemplateProvider.ts — the snippet expansion that consumes useLiveTemplates.

Suggested approach

  • Files live in src/components/editor/ next to QueryEditor.tsx.
  • Each provider is a pure function that takes its dependencies (current schema, FK map, templates) and returns a Monaco-registered disposable.
  • QueryEditor.tsx orchestrates the disposables in a single useEffect.

Done criteria

  • QueryEditor.tsx drops below ~600 lines.
  • All editor features still work: JOIN suggestions, table/column autocomplete, Alt+Enter actions, live templates.
  • TypeScript / tests / build green.
  • One Vitest test for the live-template expander (pure-string logic).

Out of scope

  • Switching to a different editor (CodeMirror, etc.).
  • Adding language servers / LSP.

Audit reference

K5 in the pre-launch audit.

主要语言
TypeScript
星标
6
派生
1
平均合并
17 分钟
30 天内合并 PR
2

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

openidle-dev/queryden 的其他 Issue

查看 openidle-dev/queryden 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。