biellts/universidade-automatiza / .claude/skills/backend-usar-result-pattern
backend-usar-result-pattern
VerifiedGuia de uso do Result Pattern para criação e encadeamento de resultados, extração de valores e tratamento de erros. Use este skill quando for trabalhar com Result<T>, Result, erros de domínio, retornos de factory ou encadeamento de operações.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.6 KB |
SKILL.md
View on GitHub---
name: backend-usar-result-pattern
description: Guia de uso do Result Pattern para criação e encadeamento de resultados, extração de valores e tratamento de erros. Use este skill quando for trabalhar com Result<T>, Result, erros de domínio, retornos de factory ou encadeamento de operações.
---
Este projeto usa o **Result Pattern** em vez de exceções para erros de negócio. Siga este guia sempre que trabalhar com `Result<T>` ou `Result` (`Automatiza.SeedWork.DomainObjects`).
## 1. Criando results
```csharp
// Com valor
Result<T>.Ok(value)
Result<T>.Fail(error)
Result<T>.Fail(IEnumerable<Error> errors)
// Sem valor
Result.Ok()
Result.Fail(error)
Result.Fail(IEnumerable<Error> errors)
```
## 2. Conversões implícitas (use para simplificar retornos)
```csharp
// T → Result<T>.Ok(value)
return new Trilha(Guid.CreateVersion7(), tituloTrilha, descricaoNormalizada, publico, funcaoNormalizada);
// Error → Result<T>.Fail(error)
return TrilhaErrors.TrilhaNaoEncontrada.Format(request.Id.ToString());
// List<Error> → Result<T>.Fail(errors)
if (erros.Count > 0)
return erros;
```
`Result` (sem valor) também converte de `Error` e `List<Error>`.
## 3. Extraindo o valor
Sempre via `TryGetValue`, que diz se deu certo e entrega o valor:
```csharp
if (!criacao.TryGetValue(out var trilha))
return Result<CriarTrilhaResponse>.Fail(criacao.Errors);
// trilha disponível aqui
```
## 4. Encadeamento com TryCreate (factory de VO)
Para criar um VO e extrair o valor sem perder o `Result`:
```csharp
var tituloResult = TituloTrilha.Criar(titulo).TryCreate(out var tituloTrilha);
if (!tituloResult.Success)
erros.AddRange(tituloResult.Errors);
// tituloTrilha só é usado se não houver erros
```
## 5. Acumulando múltiplos erros antes de checar
O factory do agregado devolve **todos** os erros de uma vez. Padrão do `Trilha.Criar`:
```csharp
var erros = new List<Error>();
var tituloResult = TituloTrilha.Criar(titulo).TryCreate(out var tituloTrilha);
if (!tituloResult.Success)
erros.AddRange(tituloResult.Errors);
if (!Enum.IsDefined(publico))
erros.Add(TrilhaErrors.PublicoInvalido);
if (erros.Count > 0)
return erros;
return new Trilha(Guid.CreateVersion7(), tituloTrilha, ...);
```
Alternativa com `List<Result>` (extensões `ToResult`, `IsSuccess` e `Fail` de `ResultExtensions`):
```csharp
List<Result> validacoes = [];
validacoes.Add(TituloTrilha.Criar(titulo).TryCreate(out var tituloTrilha).ToResult());
if (!validacoes.IsSuccess())
return Result<Trilha>.Fail(validacoes.Fail().Errors);
```
## 6. Verificando sucesso e propagando erros
```csharp
var criacao = Trilha.Criar(request.Titulo, request.Descricao, request.Publico, request.FuncaoAlvo);
if (!criacao.TryGetValue(out var trilha))
return Result<CriarTrilhaResponse>.Fail(criacao.Errors);
```
## 7. No Endpoint
```csharp
var result = await dispatcher.Send(request, cancellationToken);
return result.TryGetValue(out var criada)
? Results.Created($"/api/v1/admin/tracks/{criada.Id}", criada)
: Results.BadRequest(result.Errors);
```
Leitura por Id que não achou o registro: `Results.NotFound(result.Errors)`.
## 8. Regras obrigatórias
- **Nunca** lance `Exception` para erro de negócio — use `Result.Fail(...)` ou devolva o `Error`.
- Verifique o sucesso antes de usar o valor (`TryGetValue`, ou `Success` + `TryCreate`).
- Propague erros com `.Fail(result.Errors)` — nunca perca mensagens de erro.
- Use conversões implícitas para reduzir verbosidade no retorno.
- Exceção fica para falha inesperada/infraestrutura; o `GlobalErrorHandlingMiddleware` a registra no log e devolve o correlation ID, sem expor a mensagem.
Regras gerais: `AGENTS.md`.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |