avajs/ava

Make t.fail() accept an object

Open

#2615 opened on Nov 25, 2020

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

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

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of AVAJavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the current implementation of t.fail() in AVA's source code. Review issues #1094 and #2435 for context on desired behavior. Look at how AssertionError is created in the codebase. Consider adding a new function or modifying t.fail to accept an object with fields like message, actual, expected, format, and assertion. Ensure compatibility with existing error formatting.