Update dependency chai to v4 - autoclosed #30
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.10.0
->4.3.10
Release Notes
chaijs/chai (chai)
v4.3.10
Compare Source
This release simply bumps all dependencies to their latest non-breaking versions.
What's Changed
Full Changelog: chaijs/chai@v4.3.9...v4.3.10
v4.3.9
Compare Source
Upgrade dependencies.
This release upgrades dependencies to address CVE-2023-43646 where a large function name can cause "catastrophic backtracking" (aka ReDOS attack) which can cause the test suite to hang.
Full Changelog: chaijs/chai@v4.3.8...v4.3.9
v4.3.8
Compare Source
What's Changed
New Contributors
Full Changelog: chaijs/chai@v4.3.7...v4.3.8
v4.3.7
Compare Source
What's Changed
Full Changelog: chaijs/chai@v4.3.6...v4.3.7
v4.3.6
Compare Source
Update loupe to 2.3.1
v4.3.5
Compare Source
fca5bb1
747eb4e
022c2fa
5276af6
c8a4e00
v4.3.4
Compare Source
This fixes broken inspect behavior with bigints (#1321) (#1383) thanks @vapier
v4.3.3
: / 2021-03-03Compare Source
This reintroduces
Assertion
as an export in the mjs file. See https://github.com/chaijs/chai/pull/1378 & https://github.com/chaijs/chai/issues/1375v4.3.2
: / 2021-03-03Compare Source
This fixes a regression in IE11. See https://github.com/chaijs/chai/pull/1380 & https://github.com/chaijs/chai/issues/1379
v4.3.1
: / 2021-03-02Compare Source
This releases fixed an engine incompatibility with 4.3.0
The 4.x.x series of releases will be compatible with Node 4.0. Please report any errors found in Node 4 as bugs, and they will be fixed.
The 5.x.x series, when released, will drop support for Node 4.0
This fix also ensures
pathval
is updated to1.1.1
to fix CVE-2020-7751v4.3.0
: / 2021-02-04Compare Source
This is a minor release.
Not many changes have got in since the last release but this one contains a very important change (#1257) which will allow
jest
users to get better diffs. From this release onwards,jest
users will be able to see which operator was used in their diffs. Theoperator
is a property of theAssertionError
thrown when assertions fail. This flag indicates what kind of comparison was made.This is also an important change for plugin maintainers. Plugin maintainers will now have access to the
operator
flag, which they can have access to through an
utilmethod called
getOperator`.Thanks to all the amazing people that contributed to this release.
New Features
contain.oneOf
to take an array of possible values (@voliva)closeTo
error message will now inform the user when adelta
is required (@eouw0o83hf)Docs
Tests
useProxy
config is checked inoverwriteProperty
(@vieiralucas)contain.oneOf
(@voliva )Chores
v4.2.0
: / 2018-09-25Compare Source
This is a minor release. Thank you to all of our contributors and users!
New Features
Bug Fixes
.deep.equal
stack (#1124; @meeber)--use_strict
(#1034, #1040; @shvaikalesh)Performance
Style
Tests
Docs
.string
example (#1156, #1157; @meeber).property
chaining examples (https://github.com/chaijs/chai/issues/193#issuecomment-360334369, #1130; @meeber).ok
description (#1047; @shvaikalesh)Chores
v4.1.2
: / 2017-08-31Compare Source
This release fixes a bug when running in certain environments, and includes a few minor documentation fixes.
Bug Fixes
deep-eql
to version 3.0.0 (#1020)Docs
v4.1.1
: / 2017-08-05Compare Source
This release includes a few bug and documentation fixes.
Bug Fixes
.instanceof
to allow DOM interfaces in IE11 (#1000, #1008; @meeber).include
to work with all objects (#1009, #1012; @meeber)Docs
v4.1.0
: / 2017-07-11Compare Source
This release includes one new feature and a few bug fixes.
New Features
Bug Fixes
.property
assertion (#992; @meeber)Chores
expectTypes
to accessssfi
flag (#993; @meeber)v4.0.2
: / 2017-06-05Compare Source
We have another bugfix release, addressing some issues for WebPack 1 users.
Bug Fixes
v4.0.1
: / 2017-05-31Compare Source
4.0.1
Of course, any major release cannot go without a quick bugfix release shortly after - and here's ours!
Bug Fixes
browser
field which was mistakenly added, and caused bundler tools like Browserify or Webpack to fail as it attempted to rebundle an already bundled file. (#978, #982)v4.0.0
: / 2017-05-26Compare Source
4.0.0
4.0 has been a huge undertaking by the chai community! A lot has changed to ensure Chai 4 is a stable, reliable, well documented codebase. Here are just some of the major improvements:
almost all documentation has been rewritten, with detailed instructions on how assertions work, which flags they can be combined with and the best practices for how to use them.
deep equality has been rewritten from the ground up to support ES6 types like
Map
andSet
, and better support existing types. It is now also much, much faster than before and allows us to bring some great improvements in upcoming releases.we have made sure the
deep
flag now only ever does deep equality. Beforehand, it would sometimes also be used to test nested properties (for exampleexpect(foo).to.have.deep.property('bar.baz')
. For nested assertions, please now use the.nested
flag.many assertions have become more strict, which means you get better error messages explaining where things have gone wrong. For the most part, this wont mean error messages where there weren't error messages before, but it will mean better error messages to replace the, sometimes cryptic, default
TypeError
messages.we've added detections and helpful error messages for common mistakes and typos. The error messages will, in some cases, point you to documentation or in other cases suggest alternatives. These messages will continue to be improved in future releases, so let us know if you have any suggestions!
Breaking Changes
We no longer support Node v0.10 and v0.12 (since their LTS has ended) (PRs: #816, #901)
Instead of allowing the user to write the path of a property, now the deep flag performs a deep equality comparison when used with the
.property
assertion.If you want the old behavior of using the dot or bracket notation to denote the property you want to assert against you can use the new
.nested
flag. (Related Issues: #745, #743, PRs: #758, #757)Please notice that the old methods which used the old behavior of the
deep
flag on theassert
interface have been renamed. They all have had thedeep
word changed by thenested
word. If you want to know more about this please take a look at #757.Previously,
expect(obj).not.property(name, val)
would throw an Error ifobj
didn't have a property namedname
. This change causes the assertion to pass instead.The
assert.propertyNotVal
andassert.deepPropertyNotVal
assertions were renamed toassert.notPropertyVal
andassert.notDeepPropertyVal
, respectively. (Related Issues: #16, #743, #758)You can now use the
deep
flag for the.include
assertion in order to perform adeep
equality check to see if something is included on thetarget
.Previously,
.include
was using strict equality (===
) for non-negated property inclusion, butdeep
equality for negated property inclusion and array inclusion.This change causes the .include assertion to always use strict equality unless the deep flag is set.
Please take a look at this comment if you want to know more about it. (Related Issues: #743, PRs: #760, #761)
Fix unstable behavior of the
NaN
assertion. Now we use the suggested ES6 implementation.The new implementation is now more correct, strict and simple. While the old one threw false positives, the new implementation only checks if something is
NaN
(or not if the.not
flag is used) and nothing else. (Related Issues: #498, #682, #681, PRs: #508)The Typed Array types are now truncated if they're too long (in this case, if they exceed the
truncateThreshold
value on theconfig
). (Related Issues: #441, PRs: #576)The assertions:
within
,above
,least
,below
,most
,increase
,decrease
will throw an error if the assertion's target or arguments are not numbers. (Related Issues: #691, PRs: #692, #796)Previously,
expect(obj).not.ownProperty(name, val)
would throw an Error if obj didn't have an own property (non-inherited) named name. This change causes the assertion to pass instead. (Related Issues: #795, #, PRs: #744, #810)*The
.empty
assertion will now throw when it is passed non-string primitives and functions (PRs: #763, #812)Assertion subject (
obj
) changes when usingownProperty
orown.property
and thus enables chaining. (Related Issues: #281, PRs: #641)The
.change
,.increase
, and.decrease
assertions changed from chainable method assertions to method assertions. They don't have any chaining behavior, and there's no generic semantic benefit to chaining them. (Related Issues: #917, PRs: #925)The
utils
(second argument passed to thechai.use
callback function) no longer exports thegetPathValue
function. If you want to use that please use thepathval
module, which is what chai uses internally now. (Related Issues: #457, #737, PRs: #830)(For plugin authors) Throw when calling
_super
onoverwriteMethod
if the method being overwritten isundefined
.Currently if the method you are trying to overwrite is not defined and your new method calls
_super
it will throw anError
.(Related Issues: #467, PRs: #528)Before this change, calling
_super
would simply returnthis
.(For plugin authors) Now
showDiff
is turned on by default whenever theshowDiff
flag is anything other thanfalse
.This issue will mostly affect plugin creators or anyone that made extensions to the core, since this affects the
Assertion.assert
method. (Related Issues: #574, PRs: #515)New Features
Throw when non-existent property is read. (Related Issues: #407, #766 PRs: #721, #770)
This is a potentially breaking change. Your build will fail if you have typos in your property assertions
Before
4.x.x
when using property assertions they would not throw an error if you wrote it incorrectly.The example below, for example, would pass:
Since this implementation depends on ES6
Proxies
it will only work on platforms that support it.This property can be enabled (default) or disabled through the
config.useProxy
property, for example:Add fix suggestions when accessing a nonexistent property in proxy mode. (Related Issues: #771, PRs: #782)
When a nonexistent property is accessed in proxy mode, Chai will compute the levenshtein distance to all possible properties in order to suggest the best fix to the user.
When non-chainable methods (including overwritten non-chainable methods) are used incorrectly an error will be thrown with a helpful error message. (PRs: #789)
Add a new configuration setting that describes which keys will be ignored when checking for non-existing properties on an assertion before throwing an error.
Since this implementation depends on ES6
Proxies
it will only work on platforms that support it. Also, if you disableconfig.useProxy
, this setting will have no effect. (Related Issues: #765, PRs: #774)Add script that registers should as a side-effect. (Related Issues: #594, #693 PRs: #604)
You can also register should via a
mocha
option:mocha --require chai/should
.The
change
assertion accepts a function as object. (Related Issues: #544, PRs: #607)You can also assert for a delta using the
by
assertion alongside thechange
,increase
anddecrease
assertions. (Related Issues: #339, PRs: #621).keys
assertion can now operate onmap
s andset
s. (Related Issues: #632, PRs: #633, #668)Add compatibility with strict mode. (Related Issues: #578, PRs: #665)
Add
does
andbut
as new no-op assertion. (Related Issues: #700, #339 PRs: #621, #701)Allow
use
to be imported using new ES6 module syntax. (Related Issues: #718, PRs: #724)You can also use
require
alongside the new ES6 destructuring feature:Add ordered flag for members assertion. (Related Issues: #717, PRs: #728)
Add
.own
flag to.property
assertion. It does the same thing as.ownProperty
and cannot be used alongisde the new.nested
flag. (Related Issues: #795, PRs: #810)Add
.deep
support to.property
assertion. (Related Issues: #795, PRs: #810)The
.empty
assertion will now work with ES6 collections (PRs: #763, #812, #814)Please notice that this assertion will throw an error when it is passed a
WeakMap
orWeakSet
.Add script that registers
should
as a side-effect. This change allows you to registershould
via a mocha option by using:mocha spec.js -r chai/register-should
and also allows you to register the testing style globally. (Issues: #693, PRs: #868)Add script that registers
assert
as a side-effect. This change allows you to registerassert
via a mocha option by using:mocha spec.js -r chai/register-assert
(Issues: #693, PRs: #868, #872)Add script that registers
expect
as a side-effect. This change allows you to registerexpect
via a mocha option by using:mocha spec.js -r chai/register-expect
(Issues: #693, PRs: #868, #872)When the
length
assertion is chained directly off of an uninvoked method, it referencesfunction
's built-inlength
property instead of Chai'slength
assertion. This commit adds a guard to Chai methods to detect this problem and throw a helpful error message that advises the user on how to correct it. (Issues: #684, #841, PRs: #897)Allows the
lockSsfi
flag to be set when creating new Assertion. This flag controls whether or not the givenssfi
flag should retain its current value, even as assertions are chained off of this object. This is usually set totrue
when creating a new assertion from within another assertion. It's also temporarily set totrue
before an overwritten assertion gets called by the overwriting assertion. (Issues: #878, #904, PRs: #922)The
nestedInclude
,deepNestedInclude
,ownInclude
anddeepOwnInclude
assertions and there negated pairs were added to theassert
interface. (Issues: #905, PRs: #964)Bug Fixes
this
. (Related Issues: #562, #684, #723, PRs: #642, #660).members
assertion. (Related Issues: #511, PRs: #702)same.members
to properly handle duplicates by treating each one as a unique member. (Related Issues: #590, PRs: #739)overwriteMethod
,overwriteProperty
,addChainableMethod
,overwriteChainableMethod
functions will return new assertion with flags copied over instead of this. (Related Issues: #562, #642, #791, PRs: #799)keys
assertions will now consider size of sets. (Related Issues: #919, PRs: #924)v3.5.0
: / 2016-01-28Compare Source
For
assert
fans: you now haveassert.includeDeepMembers()
which matchesexpect().to.include.deep.members()
and.should.include.deep.members()
!This release also includes a variety of small bugfixes and documentation fixes. Most notably, we are now governed by a Code Of Conduct - which gives Chai contributors (including those who files issues, work on code, or documentation, or even just hang out on our Slack & Gitter channels) safety from harassment and discrimination.
Full changes below:
Community Contributions
assert.includeDeepMembers()
. By @qbolecDocumentation fixes
v3.4.1
: / 2015-11-07Compare Source
This is a small documentation bug fix release - it just fixes a couple of issues with the documentation.
Community Contributions
Documentation fixes
.throws()
example. By @Pklongv3.4.0
: / 2015-10-21Compare Source
This release improves some confusing error messages, and adds some new assertions. Key points:
expect(1).oneOf([1,2,3])
- for asserting that a given value is one of a set..include()
(and variants) will now give better error messages for bad object types. Beforeexpect(undefined).to.include(1)
would say "expected undefined to include 1", now says "object tested must be an array, an object, or a string but undefined given".throw()
(and variants) can now better determine the Error types, for exampleexpect(foo).to.throw(node_assert.AssertionError)
now works..closeTo
is now aliased as.approximately
.empty
changes from 3.3.0 have been reverted, as they caused breaking changes to arrays which manually set keys.Community Contributions
Code Features & Fixes
expect(inList).to.be.oneOf
assertion. By @DroogansDocumentation fixes
new Error
type gets detected by thea
/an
matcher. By @jurko-gospodneticv3.3.0
: / 2015-09-08Compare Source
This release adds some new assertions and fixes some quite important, long standing bugs. Here are the cliff notes:
frozen
,sealed
orextensible
assertions to test primitives (e.g.expect(1).to.be.frozen
), you may have noticed that in older browsers (ES5) these fail, and in new ones (ES6) they pass. They have now been fixed to consistently passassert
interface has been given the following new methods, to align better with other interfaces:,assert.isAtMost
,assert.isAtLeast
,assert.isNotTrue
,assert.isNotFalse
.Community Contributions
Code Features & Fixes
assert.isNotTrue
andassert.isNotFalse
.By @cezarykluczynski
frozen
/extensible
/sealed
assertions behave the same in ES6 and ES5 environments.By @astorije
.empty
assertion.By @Daveloper87
assert.isAtMost
andassert.isAtLeast
.By @wraithan
By @kpdecker
Documentation fixes
isBelow
,isAbove
,isTrue
).By @cezarykluczynski
v3.2.0
: / 2015-07-19Compare Source
This release fixes a bug with the previous additions in
3.1.0
.assert.frozen
/expect().to.be.frozen
/.should.be.frozen
all accidentally calledObject.isSealed()
instead. Now they correctly callObject.isFrozen()
.If you're using these features, please upgrade immediately.
It also adds aliases for a lot of
assert
methods:Community Contributions
Code Features & Fixes
By @keithamus
By @couchand
getProperties()
utilityBy @jluchiji
By @jluchiji
By @astorije
By @astorije
v3.1.0
: / 2015-07-16Compare Source
This release adds assertions for extensibility/freezing/sealing on objects: