Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
chai-jest-diff
Advanced tools
A plugin to make Chai’s equality assertions (shallow or deep) fail with Jest-like diffs
Chai’s assertions have a built-in showDiff
flag, but do not produce the diff themselves; it’s up to the test runner to produce such output.
The very popular Mocha does that, but Jest doesn’t: its neat diffs are produced internally by its built-in matchers; it doesn’t rely on any sort of metadata to produce diff for third-party assertions.
When you start using Jest, if you still prefer Chai for your assertions, you quickly miss Jest’s neat JSON diffs, especially if you used to run tests with Mocha, which produced similar diffs on its own.
This Chai plugin tries to fix that, piggybacking on Jest’s jest-diff
and jest-matcher-utils
for maximum compatibility with Jest’s built-in expectation output.
It focuses on deep equality testing (through any variation of .deep.equal
or .eql
), where such diffs are most relevant. Because Jest uses diffs even for its ===
-based .toBe
expectation, it also provides it for shallow equal
testing, just for consistency’s sake.
On the other hand, it currently doesn’t provide it for .property
value testing, unlike Jest’s .toHaveProperty
expectation. This seemed to require too much duplication of code between Chai’s internal assertions and this plugin, as there are many edge cases. We’ll see.
const chai = require('chai')
const chaiJestDiff = require('chai-jest-diff')
chai.use(chaiJestDiff())
The plugin factory accepts a boolean argument, expand
, that mirrors Jest’s expand
configuration setting, for full-length diffs (instead of close-context diffs). I couldn’t figure out a way to get this information dynamically from Jest’s exposed API, so you’d have to pass that in manually if you need it.
© 2017 Delicious Insights
This plugin is provided under the MIT license. See LICENSE.md
for details.
FAQs
A plugin to make Chai’s equality assertions (shallow or deep) fail with Jest-like diffs
The npm package chai-jest-diff receives a total of 1,574 weekly downloads. As such, chai-jest-diff popularity was classified as popular.
We found that chai-jest-diff demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.