Template de Biblioteca JS/TS com Automação

Este repositório é um template para criação de novas bibliotecas JavaScript/TypeScript, já preparado com as principais ferramentas modernas para desenvolvimento, testes, lint, commit e release automatizado.

Tecnologias e ferramentas utilizadas

• TypeScript: Superset de JavaScript, com tipagem estática.
• ESLint com @typescript-eslint: Lint para manter código limpo e consistente.
• Prettier: Formatação automática de código.
• Vitest: Framework de testes robusto e rápido.
• Commitlint com Husky: Validação automática do formato dos commits seguindo o Conventional Commits.
• Semantic Release: Automatiza o versionamento e publicação no npm com base nas mensagens de commit.
• Husky: Para Git hooks automáticos.

Como usar

1. Clone este template para iniciar sua nova biblioteca.
2. Modifique o código dentro da pasta src/.
3. Use os scripts npm definidos para:
   • npm run build — para compilar o TypeScript e gerar tipos.
   • npm run test — para rodar os testes com Vitest.
   • npm run lint — para analisar o código com ESLint.
   • npm run format — para formatar o código com Prettier.
   • npm run release — para realizar o release automático com semantic-release.

Publicação automática no NPM

A publicação automática no npm é feita pela ferramenta semantic-release no pipeline de CI/CD.

Importante: Para ativar essa funcionalidade, é necessário descomentar a etapa de release no arquivo .gitlab-ci.yml do projeto, configurar a variável GITLAB_TOKEN com um token válido para publicação no npm, e garantir que os commits sigam o padrão Conventional Commits.

Contribuições e dúvidas

Sinta-se à vontade para abrir issues ou forkar este repositório para suas necessidades.

Criado para acelerar a inicialização de novas bibliotecas JS/TS com melhores práticas.