Skip to content

Revisão funcionamento CLI e no readme - #38

Merged
Gronoxx merged 4 commits into
Gronoxx:mainfrom
FilipeTerra:Filipe
Jun 21, 2026
Merged

Gronoxx merged 4 commits into
Gronoxx:mainfrom
FilipeTerra:Filipe

Conversation

@FilipeTerra

Copy link
Copy Markdown
Contributor

Resumo

Torna a CLI de detecção de code smells mais robusta e intuitiva, e reescreve o
README para atender às seções exigidas pelo enunciado.

CLI (cli.py)

  • Filtro por ID: --smell agora aceita o ID do smell (R1R5,
    case-insensitive) além do nome; valores duplicados são deduplicados e valores inválidos retornam erro claro.
  • Versão (SemVer): adiciona --version (aliases -V e --V), versão 1.0.0.
  • Resumo mais claro: veredito final informativo (✗ N smell(s) em M função(ões)… ou ✓ Nenhum smell…), nomeando o smell buscado quando há filtro.
  • --help documentado: epilogs com exemplos e códigos de saída, textos de ajuda das opções e docstrings dos comandos revisados.

README

  • Novas seções obrigatórias: "Como Instalar" e "Como Executar os Testes".
  • Instalação padronizada via requirements_cli.txt (mesma do CI); exemplos de uso atualizados (--version, filtro por ID, exit codes); contagem de testes.
  • Mantém a Trilha B (mineração de dados + fine-tuning de refatoração) como trabalho em andamento.

Testes

  • Novos testes de unidade para filtro por ID, --version/aliases, veredito e documentação do --help.

FilipeTerra and others added 4 commits June 21, 2026 11:59
feat(cli): adiciona --version (SemVer 1.0.0);
feat(cli): veredito de resumo mais claro no scan;
docs(cli): documenta exit codes e exemplos no --help;
test(cli): cobre filtro por ID, --version, veredito e help
- "Para usar apenas a CLI..." estava cortada; completa a frase (conjunto
  mínimo lizard/click/rich).
- Python 3.11+ agora nota que o CI testa 3.13 em Linux/macOS/Windows.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Gronoxx
Gronoxx merged commit fb68fad into Gronoxx:main Jun 21, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants