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 Pull Request updates dependency chai from
v3.5.0
tov4.1.2
Release Notes
v4.0.0
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: ps command does not have "no-headers" flag in Mac OS X #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)v4.0.1
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.2
We have another bugfix release, addressing some issues for WebPack 1 users.
Bug Fixes
v4.1.0
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.1.1
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.2
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
Commits
v4.0.0
4180242
test: added message argument to negated nested-, deep-, own- and deepOwnInclude33e4403
test: added custom message test to negated .nested-, .deep-, .own.includeb744130
Assert: made documentation more descriptivef3adfd9
fix: PhantomJS 1.x incompatibility (#966)0825826
Merge pull request #964 from zetamorph/assert-nestedInclude-ownInclude8ba95a7
Remove bump command to change lib/chai.js30a4451
Merge pull request #967 from lucasfcosta/remove-lib-bump0fe98b1
[email protected]6349ff4
Merge pull request #972 from lucasfcosta/release-4.0.0545ca2f
chore: uncomment travis linesab1fbad
Merge pull request #973 from chaijs/chore-uncomment-travis-deployv4.0.1
d0ace69
Update supported node version badge in README FIX #975eba5b42
chore(package): update browserify to version 14.4.0b38b8d7
fix: (#978) remove browser field (#982)v4.0.2
616cf8b
Revert get version package json (#986)v4.1.0
7e466af
Add a missing var keyword found by lgtm.come6ddf64
fix: check target's type in `.property` assertione7b2384
refactor: `expectTypes` to access `ssfi` flag351e968
Merge pull request #992 from meeber/property-target-type9116bc8
Merge pull request #993 from meeber/refactor-expect-types5daceab
Merge pull request #988 from samlanning/missing-var3bcb21c
Merge pull request #979 from chaijs/greenkeeper/browserify-14.4.03c932e2
feat: allow dates for isBelow and isAbove assertions (#990)2eddd79
Add ES6 collection support to include() (#994)45cb327
[email protected]11a6f85
test: skip failing `.include` tests in IE113397dda
Merge pull request #1005 from meeber/skip-failing-testscf70b11
Create CODEOWNERScad9933
Merge pull request #1004 from chaijs/code-ownersdf9073c
Merge pull request #998 from v1adko/make-releasev4.1.1
c107abb
fix: `.instanceof` to allow DOM interfaces in IE111847ef8
Merge pull request #1008 from meeber/fix-ie11-instanceofc01cf30
fix: `.include` to work with all objects113a5b8
fix: correct hasAnyKeys comment error8fa24f2
Merge pull request #1014 from zenHeart/fix-hasAnyKeys-commentb625497
Merge pull request #1012 from meeber/fix-include-types92d2cca
docs: re-indent hasAnyKeys coded2e9599
Merge pull request #1016 from chaijs/fix-reindent-code-1014ac48db3
[email protected]02ddebd
Merge pull request #1019 from meeber/release-4.1.1v4.1.2
6e72c5a
fix(package): update deep-eql to version 3.0.0 (#1020)94eb738
chore: add package-lock.json7c1ca16
docs: add missing assert parameters (#1023)786043b
Update license1ae9386
Merge pull request #1025 from yanca018/master31c3559
Use a hardcoded no-op instead of instancingc592551
Merge pull request #1032 from Cutlery-Drawer/csp-fixb534fca
[email protected]529d395
Merge pull request #1037 from Cutlery-Drawer/masterThis PR has been generated by Renovate Bot.