BrasilAPI / cep-promise

Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e outros (Node.js e Browser)
MIT License
2.89k stars 316 forks source link

[TypeScript] Falta de testes para os tipos #263

Closed wellwelwel closed 10 months ago

wellwelwel commented 1 year ago

Fala pessoal, tudo bem? 🙋🏻‍♂️

Recentemente submeti um PR modificando o index.d.ts e notei que ele não possui nenhuma cobertura de testes.

Uma vez que o código principal é feito em JavaScript e já possui toda gama de testes, gostaria de propor um teste de compilação (que não gera arquivos) apenas do index.d.ts.

Esse teste seria uma simples usabilidade básica das opções e métodos existentes em um arquivo TypeScript, assim como é feito atualmente no mysql2, onde o desenvolvimento principal é feito em JS e o projeto é "tipado" separadamente.

Ao longo de vários PRs envolvendo o index.d.ts, notei alterações que quebrariam qualquer projeto que utilize TypeScript (major) sendo lançadas como minor ou patch. Com esse teste isso seria evitado além de garantir que toda modificação nos tipos mantenha a compatibilidade com o projeto principal.

Caso gostem da ideia, seria um prazer contribuir 🤝