Logo

Melhores Práticas

Este guia reúne as melhores práticas e padrões recomendados para desenvolvimento com o LIP.

Estrutura de Projeto

Organização de Arquivos

src/
├── api/
│   ├── controllers/
│   ├── middlewares/
│   └── routes/
├── core/
│   ├── config/
│   ├── database/
│   └── services/
├── domain/
│   ├── entities/
│   ├── repositories/
│   └── use-cases/
├── infrastructure/
│   ├── cache/
│   ├── queue/
│   └── storage/
└── utils/
    ├── helpers/
    └── validators/

Convenções de Nomenclatura

Código Limpo

Single Responsibility

DRY (Don't Repeat Yourself)

Funções Pequenas

Tratamento de Erros

Erros Personalizados

Error Handling Middleware

Segurança

Validação de Entrada

Sanitização

SQL Injection Prevention

Performance

Caching

Database Queries

Paginação

Testes

Estrutura de Testes

Test Coverage

Documentação

JSDoc

README

Cada módulo deve ter um README com:

  • Descrição do propósito
  • Como usar
  • Exemplos de código
  • API reference
  • Dependências

Git Workflow

Commits

Branches

Próximos Passos

Última atualização

26 de novembro de 2025