Feature: generate a version-accurate Unity API index for lookup_api
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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).
- Lenguaje dominante
- C#
- Estrellas
- 4
- Forks
- 0
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de TMHSDigital/Unity-Developer-Tools
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
ci priority: low skills
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
-
good first issue skills testing
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
-
ci priority: medium testing
Dificultad 4/5 1-2 días Aptitud para principiantes 57/100
-
documentation marketing priority: medium
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de TMHSDigital/Unity-Developer-Tools
Issues similares
-
type:task ux
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
elsa-workflows/elsa-foundation#5253 ·
Los mantenedores suelen responder en 1 día