avajs/ava

Make t.fail() accept an object

Open

#2,615 opened on Nov 25, 2020

View on GitHub
 (5 comments) (1 reaction) (0 assignees)JavaScript (1,408 forks)batch import
enhancementhelp wantedscope:assertions

Repository metrics

Stars
 (20,600 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It seems like the only problem with #1094 is providing detailed error output when a custom assertion fails. Everything else is straightforward. What if t.fail() could accept an object to use for creating an AssertionError? The fields could be message, actual, expected, and format that will specifying which formatting function to use for setting the values field on the error object. Could also add an optional assertion field for a custom assertion name.

Would this be compatible with #2435?

If there's interest, I can submit a PR for this.

Contributor guide

Research direction
Examine the current implementation of t.fail() and AssertionError in AVA. Review issue #2435 for potential conflicts. Understand how the error object's formatting works.
Tech stack
javascriptnodejs
Domain
testing
Issue type
Feature
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
78