Skip to main content

Dicas

Claro! Aqui estão as dicas ajustadas para o framework Miolo:

### Model (Modelo)
1. **Responsabilidade Única**: Cada modelo no Miolo deve ser responsável apenas pela lógica de dados do aplicativo. Evite misturar a lógica de negócios com a lógica de apresentação.
2. **Validações**: Centralize as validações dos dados no modelo usando os métodos disponíveis no Miolo. Isso garante que os dados sejam validados antes de serem processados.
3. **Associações**: Defina corretamente as associações entre os modelos (por exemplo, `hasOne`, `hasMany`). Isso facilita as consultas e a manipulação de dados relacionados.
4. **Scopes**: Utilize scopes para criar consultas reutilizáveis no Miolo. Isso ajuda a manter o código limpo e organizado.
5. **Migrations**: Use migrations para gerenciar as mudanças no esquema do banco de dados. Documente cada migração para facilitar o entendimento das alterações.

### View (Visão)
1. **Separação de Lógica**: Mantenha a lógica de apresentação separada da lógica de negócios. Utilize helpers e partials para organizar o código no Miolo.
2. **Simplicidade**: Mantenha as views no Miolo o mais simples possível. Evite colocar muita lógica nas views; isso deve ser feito nos controllers ou helpers.
3. **Layouts e Partials**: Use layouts para definir a estrutura geral do site e partials para componentes reutilizáveis no Miolo. Isso facilita a manutenção e a reutilização de código.
4. **CSS e JS Separados**: Separe o CSS e o JavaScript do código HTML. Utilize arquivos externos para estilização e scripts, mantendo as views mais limpas e organizadas.
5. **Internacionalização (i18n)**: Utilize os mecanismos de internacionalização do Miolo para facilitar a tradução do conteúdo das views.

### Controller (Controlador)
1. **Responsabilidade Única**: Cada ação do controlador no Miolo deve ter uma única responsabilidade. Se uma ação estiver fazendo muitas coisas, considere refatorar.
2. **Filtros**: Utilize filtros (por exemplo, `beforeFilter`) para realizar ações comuns, como autenticação de usuário, antes de executar a lógica principal.
3. **Tratamento de Exceções**: Implemente o tratamento adequado de exceções para garantir que o aplicativo lide graciosamente com erros.
4. **RESTful**: Adote convenções RESTful ao definir as rotas e ações dos controladores no Miolo. Isso torna a API mais previsível e fácil de usar.
5. **Serviços e Interatores**: Considere mover a lógica complexa para objetos de serviço ou interatores. Isso ajuda a manter os controladores pequenos e focados.

### Gerais
1. **Código Limpo**: Siga princípios de código limpo, como a nomenclatura clara de variáveis e métodos, comentários explicativos quando necessário e refatoração regular do código.
2. **Testes**: Escreva testes para seus modelos, controladores e views no Miolo. Use frameworks de teste para garantir que seu código funcione conforme o esperado.
3. **Documentação**: Documente o código e as decisões arquiteturais. Isso facilita a manutenção e a colaboração com outros desenvolvedores.
4. **Reutilização de Código**: Identifique padrões e oportunidades para reutilizar código. Use herança, mixins ou módulos para compartilhar funcionalidades comuns no Miolo.
5. **Segurança**: Esteja atento a práticas de segurança, como proteção contra injeção de SQL, XSS e CSRF. Valide e sanitize todas as entradas do usuário.

Essas dicas específicas para o Miolo ajudarão a manter o código organizado, sustentável e fácil de manter.