Feature: generate a version-accurate Unity API index for lookup_api
还没有人认领这个 Issue。
评估
调研方向
Start by reading the existing lookup_api implementation and the lifecycle-only weekly data workflow; the issue does not name their file paths. Then assess Unity ScriptReference or reference assemblies as data sources and how analyze_project determines the Unity version. Done means version-selectable generated indexes provide accurate signatures and obsolete warnings for supported public UnityEngine types while keeping the data size reasonable.
由索引模型根据 Issue 内容生成。
描述
Why it matters
A hand-curated list of 59 entries cannot compete with the model's own memory, so lookup_api adds little value today. What models genuinely lack is version-accurate facts: which members exist in Unity 6.x, which are obsolete, and what the exact signatures are. A generated index makes the tool authoritative instead of decorative, and fulfils the M2 roadmap goal of "500+ entries".
Proposal
- A build script that generates
unity_api_index.jsonfrom Unity's ScriptReference (or from theUnityEngine/UnityEditorreference assemblies via reflection /System.Reflection.Metadata), capturing type, member, signature,[Obsolete]message, and since-version. - Store per Unity version (6000.0 LTS, latest 6.x), selectable via a
unity_versionargument (defaulting to the version found byanalyze_project). - Keep the curated entries as "examples/notes" layered on top.
- Ranked fuzzy search; return obsolete status and replacement prominently.
- Run the generator in the weekly data workflow (as a PR), replacing the current lifecycle-only refresh.
Done when
lookup_api returns accurate signatures and obsolete warnings for any public UnityEngine type in the supported versions, with size kept reasonable (compressed or SQLite).
- 主要语言
- C#
- 星标
- 4
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
TMHSDigital/Unity-Developer-Tools 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 35/100
-
ci priority: low skills
难度 3/5 1-2 天 新手友好度 55/100
-
good first issue skills testing
难度 3/5 1-2 天 新手友好度 58/100
-
ci priority: medium testing
难度 4/5 1-2 天 新手友好度 57/100
-
documentation marketing priority: medium
难度 5/5 一周以上 新手友好度 35/100
查看 TMHSDigital/Unity-Developer-Tools 的全部 Issue
相似的 Issue
-
type:task ux
难度 2/5 1-3 小时 新手友好度 72/100
elsa-workflows/elsa-foundation#5253 ·
维护者通常 1 天内回复