avajs/ava

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

Open

#2931 opened on Jan 5, 2022

View on GitHub
 (9 comments) (1 reaction) (0 assignees)JavaScript (20,600 stars) (1,408 forks)batch import
help wanted

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.

Contributor guide

Tech stack
javascriptnodejs
Domain
testing
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript basicsAVA testing framework basicsGit and GitHub workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.