analyze: print next-step guidance when the database is written

Offen Anfängerfreundlich
#116 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
68/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
csharp, sqlite
Bereich
cli, database

Rechercherichtung

Beginne bei der Finalisierungsausgabe des analyze-Befehls und verfolge den Code, der die Anzahl der verarbeiteten Dateien und die Gesamtzeit ausgibt. Füge die vorgeschlagenen Hinweise zu Datenbank, View und Schema-Referenz hinzu, nachdem die Datenbank geschrieben wurde, und führe analyze mit einer Beispieleingabe aus, um die Formulierung von stdout und die URL zu überprüfen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement

When analyze finishes it prints the processed-file counts and the total time, but nothing about what to do next:

Finalizing database. Successfully processed files: 2, Failed files: 0, Files without TypeTrees: 0, Ignored files: 0

Total time: 0.256 s

In a usability experiment, an AI agent given only the binary discovered the built-in views (object_view, view_breakdown_by_type, ...) by running .tables in sqlite3 and called it "a lucky/pleasant discovery, not something --help mentioned". For someone using the downloaded binary, stdout plus the one URL in --help is the entire discovery surface.

Proposal: after finalizing, print a short next-step hint, something like:

Database written to database.db. Start with the object_view and view_breakdown_by_type views.
Schema reference: https://github.com/Unity-Technologies/UnityDataTools/blob/main/Documentation/analyzer.md

The URL should be version-pinned once the --help documentation link is (tracked separately).

Vorherrschende Sprache
C#
Sterne
841
Forks
75
Ø Merge
1 T. 7 Std.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Unity-Technologies/UnityDataTools

Alle Issues in Unity-Technologies/UnityDataTools

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.