avajs/ava

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

Open

#2.931 geöffnet am 5. Jan. 2022

Auf GitHub ansehen
 (9 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (20.600 Stars) (1.408 Forks)batch import
help wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javascriptnodejs
Domain
testing
Issue Type
refactor
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScript basicsAVA testing framework basicsGit and GitHub workflow
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
The issue requests renaming the first parameter of the 'snapshot' assertion from 'expected' to 'value' for consistency with other assertions like 'is'. This involves updating the documentation in 'docs/03 assertions.md' and potentially the source code where the snapshot assertion is defined. Check for any related tests that reference the parameter name. The change is localized and does not affect functionality.