avajs/ava

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

Open

#2 931 ouverte le 5 janv. 2022

Voir sur GitHub
 (9 commentaires) (1 réaction) (0 assignés)JavaScript (1 408 forks)batch import
help wanted

Métriques du dépôt

Stars
 (20 600 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Le problème demande de renommer le premier paramètre de l'assertion 'snapshot' de 'expected' à 'value' pour la cohérence avec d'autres assertions comme 'is'. Cela implique de mettre à jour la documentation dans 'docs/03 assertions.md' et potentiellement le code source où l'assertion snapshot est définie. Vérifiez s'il existe des tests connexes qui font référence au nom du paramètre. Le changement est localisé et n'affecte pas la fonctionnalité.
Stack technique
javascriptnodejs
Domaine
testing
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80