michalmuskala/jason

Better error message on invalid `@derive Jason.Encoder` options

Aberta

#183 aberto em 10 de fev. de 2024

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Elixir (178 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (1.680 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Current behavior

When passing an invalid option, eg:

@derive {Jason.Encoder, invalid: [:__meta__]}

It returns the following error: cannot encode metadata from the :__meta__ field for CrosswordsApi.Users.User to JSON.

Expected behavior

Could the error be explicit that expect or only should be passed as valid options only?

Guia do colaborador

Direção de pesquisa
Inspecione a implementação de derive do `Jason.Encoder` em `lib/jason/encoder.ex` para localizar onde as opções são processadas e adicione uma verificação para opções inválidas, gerando uma mensagem de erro clara que lista as opções válidas (`:only`, `:except`).
Pilha de tecnologia
elixir
Domain
backend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Elixir
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85