Unity-Technologies / Unity-Technologies/UnityDataTools
analyze: print next-step guidance when the database is written
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 821
- Forks
- 71
- Avg merge
- 3h 13m
- Merged PRs (30d)
- 9
Description
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).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the analyze command's finalization output and trace the code that prints the processed-file counts and total time. Add the proposed database, view, and schema-reference guidance after the database is written, then run analyze on a sample input to verify the stdout wording and URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, sqlite
- Domain
- cli, database
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100