Unity-Technologies / Unity-Technologies/UnityDataTools

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

Aberta Para iniciantes
#116 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

enhancement
Linguagem predominante
C#
Estrelas
821
Forks
71
Merge médio
3h 13min
PRs com merge (30d)
9

Descrição

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).

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela saída de finalização do comando analyze e rastreie o código que imprime as contagens de arquivos processados e o tempo total. Adicione as orientações propostas sobre o banco de dados, a view e a referência do schema depois que o banco de dados for gravado; em seguida, execute analyze em uma entrada de exemplo para verificar o texto de stdout e a URL.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp, sqlite
Domínio
cli, database
Tipo de issue
Funcionalidade
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Ativa
Clareza
Razoavelmente clara
Facilidade para iniciantes
68/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.