avajs/ava

First parameter for "snapshot" assertion should be called "value" for consistency

Open

#2.931 aberto em 5 de jan. de 2022

Ver no GitHub
 (9 comments) (1 reaction) (0 assignees)JavaScript (1.408 forks)batch import
help wanted

Métricas do repositório

Stars
 (20.600 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Currently, it is called "expected": https://github.com/avajs/ava/blob/main/docs/03-assertions.md#snapshotexpected-message

However, that is inconsistent with other assertion APIs like "is" where parameters are named "value" and "expected": https://github.com/avajs/ava/blob/main/docs/03-assertions.md#isvalue-expected-message

In the case of "snapshot", the expected data is represented by the previously-captured snapshot and the test data (often called "actual") is what gets passed to the function via the first parameter.

Guia do colaborador

Direção de pesquisa
A questão solicita a renomeação do primeiro parâmetro da asserção 'snapshot' de 'expected' para 'value' para consistência com outras asserções como 'is'. Isso envolve atualizar a documentação em 'docs/03 assertions.md' e potencialmente o código fonte onde a asserção snapshot é definida. Verifique se há testes relacionados que referenciam o nome do parâmetro. A mudança é localizada e não afeta a funcionalidade.
Pilha de tecnologia
javascriptnodejs
Domain
testing
Tipo Issue
Refatoração
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.
1-3 horas
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
JavaScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80