mjackson/expect

whyNotEqual

Open

#153 opened on Aug 19, 2016

View on GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (2,290 stars) (132 forks)batch import
enhancementhelp wanted

Description

I'm getting what appears to be a bogus error:

    Expected { app: { data: {}, ui: { fetchinUser: false, fetchingInstruments: false, fetchingLoans: false, modalOpen: false, modalView: null, selectedTab: 0, sidebarOpen: false, sidebarView: null, snackbarList: [], snackbarNextId: 0 } }, form: { search: { _active: 'query', _asyncValidating: false, _error: undefined, _initialized: false, _submitFailed: false, _submitting: false, query: { _isFieldValue: true, visited: true } } } } to equal { app: { data: {}, ui: { fetchinUser: false, fetchingInstruments: false, fetchingLoans: false, modalOpen: false, modalView: null, selectedTab: 0, sidebarOpen: false, sidebarView: null, snackbarList: [], snackbarNextId: 0 } }, form: { search: { _active: 'query', _asyncValidating: false, _initialized: false, _submitFailed: false, _submitting: false, query: { _isFieldValue: true, visited: true } } } }

It would be great is failed assertions would use whyNotEqual to report the issue:

https://www.npmjs.com/package/is-equal#want-to-know-why-two-values-are-not-equal

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.
2
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
basic knowledge of JavaScript testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes using the `is equal` npm package to provide detailed diff output when assertions fail. To implement, investigate the current error reporting mechanism in the expect library (likely in files like `lib/assert.js` or similar). Then integrate `is equal` to compare expected and actual values and append the difference to the error message. No linked PRs or comments provide further guidance, so the implementer should refer to the is equal documentation and the expect source code to determine the best integration point.