Código

Descrição

Aqui serão apresentadas as convenções do código desenvolvido. padrões, documentação e conceitos básicos serão alguns dos assuntos abordados.

Sumário

• Ferramentas
  • Nomenclatura de Arquivos
  • Documentação

Ferramentas de Padronização

Iniciando o projeto, é importante notar que foram aplicadas regras de:

• Prettier
• Conventional Commits

e não será possível realizar um commit bem sucedido caso o código adicionado fuja dos padrões especificados nas regras.

1. Prettier

O Prettier é uma ferramenta de formatação de código que padroniza coisas como identação, espaçamento, etc. As configurações do Prettier já estão definidas no projeto, porém é preciso adicioná-lo em seu editor de prefêrencia.

Caso esteja usando o VSCode, basta abrir o painel de Extenções com Ctrl + Shift + x , pesquisar por "Prettier" e instalar.

As configurações do Prettier no VSCode também estão no repositório em settings.json, portanto basta usar Ctrl + s que o editor salva e realiza as formatações.

Códigos que fojem dos padrões de formatação do Prettier serão rejeitados automaticamente.

Configurações definidas:

"semi": true         --> Adiciona ponto e vírgula no final
"singleQuote": true  --> Garante o uso de aspas simples sempre
"tabWidth": 2        --> Identa usando 2 espaços
"printWidth": 100    --> Define tamanho máximo de uma linha do código

2. Conventional Commits

O Conventional Commits é um padrão de commit vastamente utilizado na indústria, inicialmente concebido pelo Google Angular, veja mais sobre aqui!

Nesse projeto, existem ferramentas para facilitar os commits de acordo com as regras estipuladas, basta escrever:

yarn commit

e um menu irá guiar o usuário para realizar o commit da maneira adequada.

É importante notar que o processo de commit também pode ser feito normalmente da maneira tradicional.

Commits que fojem dos padrões de commit do Conventional Commits serão rejeitados automaticamente.

Nomenclatura de Arquivos

TBD

Documentação

Para documentação foram aplicadas regras de:

• Swagger

1. Swagger

O Swagger é definido como uma aplicação open source que auxilia desenvolvedores nos processos de definir, criar, documentar e consumir APIs REST. Em suma, o Swagger visa padronizar este tipo de integração, descrevendo os recursos que uma API deve possuir, como endpoints, dados recebidos, dados retornados, códigos HTTP e métodos de autenticação, entre outros.

Código

TBD