https://github.com/dedo-finger2/eslint-husky-vitest-typescript-template

Um repositório de template feito para ser um ponto inicial para seus projetos em Typescript seguindo padrões no seu código!
https://github.com/dedo-finger2/eslint-husky-vitest-typescript-template

eslint-config husky-config prettier-config prettier-eslint typescript typescript-config vitest vitest-config

Last synced: 7 days ago
JSON representation

Um repositório de template feito para ser um ponto inicial para seus projetos em Typescript seguindo padrões no seu código!

• Host: GitHub
• URL: https://github.com/dedo-finger2/eslint-husky-vitest-typescript-template
• Owner: Dedo-Finger2
• License: gpl-3.0
• Created: 2024-05-03T11:52:45.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-05-03T12:39:47.000Z (5 months ago)
• Last Synced: 2024-09-28T01:08:38.375Z (7 days ago)
• Topics: eslint-config, husky-config, prettier-config, prettier-eslint, typescript, typescript-config, vitest, vitest-config
• Language: Shell
• Homepage:
• Size: 49.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESLint, Husky, Vitest, Prettier, Typescript project template

> Uma maneira rápida de começar um projeto typescript usando boas práticas de programação.

![](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)

![](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E)

![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![](https://img.shields.io/badge/vitest-6E9F18?style=for-the-badge&logo=vitest&logoColor=white)

![Logo](https://i.imgur.com/fuc7vSu.png)

Este repositório é um template que pode ser usado para obter uma rápida estrutura de pastas para seus projetos Typescript, possuindo já de cara:

- **ESLint** configurado para concertar problemas de linting. 

- **Husky** com o hook dde pre-commit para garantir que as regras do ESLint sejam aplicadas, garantindo assim um padrão no seu código.

- **Vitest** para execução de testes criados no projeto, parando o commit caso os testes falhem.

- **Prettier** organizando e formatando seu código mesmo sem usar a extensão no seu editor de código.

## Instalação

```sh

npm install 

```

## Configuração

Os arquivos: `.lintstagedrc.json`, `.prettierrc.json` e `.eslintrc.json` podem ser configurados a vontade para fazer com que sigam as prátias comuns do seu time / empresa.

- .lintstagedrc.json > Configuração dos comandos que serão executados assim que um commmit for feito.

- .prettierrc.json > Regras do prettier que vão formatar seu código.

- .eslintrc.json > Regras do eslint que vão ditar quais regras de linting seu código vai seguir.

## Histórico de lançamento

* V0.1

    * Configuração inicial;

    * pre-commit hook;

    * npm update depois de um npm install;

    * README.Me.