Feature: generate a version-accurate Unity API index for lookup_api
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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).
- Ngôn ngữ chính
- C#
- Star
- 4
- Fork
- 0
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của TMHSDigital/Unity-Developer-Tools
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
ci priority: low skills
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
-
good first issue skills testing
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 58/100
-
ci priority: medium testing
Độ khó 4/5 1-2 ngày Mức phù hợp với người mới 57/100
-
documentation marketing priority: medium
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Tất cả issue của TMHSDigital/Unity-Developer-Tools
Issue tương tự
-
type:task ux
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
elsa-workflows/elsa-foundation#5253 ·
Maintainer thường phản hồi trong vòng 1 ngày