Feature: generate a version-accurate Unity API index for lookup_api
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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).
- Langage dominant
- C#
- Étoiles
- 4
- Forks
- 0
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de TMHSDigital/Unity-Developer-Tools
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
-
ci priority: low skills
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
-
good first issue skills testing
Difficulté 3/5 1-2 jours Accessibilité débutants 58/100
-
ci priority: medium testing
Difficulté 4/5 1-2 jours Accessibilité débutants 57/100
-
documentation marketing priority: medium
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
Toutes les issues de TMHSDigital/Unity-Developer-Tools
Issues similaires
-
type:task ux
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
elsa-workflows/elsa-foundation#5253 ·
Les mainteneurs répondent en général sous 1 jour