Releases: chaijs/chai
4.0.0-canary.2 / 2017-04-17
4.0.0-canary.2 / 2017-04-17
The second release in the 4.0.0 canary release cycle. Around the end of April, barring any showstopper bugs, this will be released as 4.0.0
Breaking Changes
-
We've dropped support for Node 0.10 (See #816) and Node 0.12 (#901). The minimum supported version is now Node 4.0. If you wish to continue using older versions of Node with Chai, please continue to use the
3.5.0
release. Officially, version 4.0.0 of chai supports Nodes 4, 6, 7, as well as the moving LTS version (currently 6.10.2). We plan to support Node 4 until at-least April 2018 (inline with Node Foundation support). -
.not.keys
on its own is now the equivalent of.not.all.keys
(#924). The docs mention this, and suggest to always pair.keys
with something.
New Features
-
Added side-effectful "register" style scripts for each interface, (See #868). This allows one to
require('chai/should')
which will automatically callglobal.should = chai.should()
. This is useful for users who wish to automatically get a global for their codebase. Read the docs for more info! -
Added the
browser
field to the package json (#875). This will help with browser bundling tools. -
Added
.own.include
and.nested.include
(#926). -
If you attempt to call
.throws
with something that isn't a constructor (likeTypeError
) you will now get a more helpful error message about this. (before it would sayRight-hand side of 'instanceof' is not an object
, now it saysThe instanceof assertion needs a constructor but <type> was given
). (#899).
Bug Fixes
-
Minor update deep-eql to 2.0.1 (#871) which fixes bugs around Memoization, and lets comparators override evaluation of primitives.
-
We've updated documentation and error handling around using
.length
(#897) - which can, in some cases, be problematic. Typically, you'll want to use.lengthOf
instead - but the documentation now makes this clear, and errors are more helpful when bad things happen. -
We've improved stack traces to strip out chai's internals, especially in newer environments which use Proxies (#884 and #922).
-
We've gone through and made sure every assertion honors the custom error message you pass it - some didn't! (#947).
-
getFuncName
has had an update since we pulled out the behaviour in4.0.0-canary.1
(#915). Practically this doesn't change anything in Chai.
Documentation
4.0.0-canary.1
4.0.0-canary.1
Breaking Changes
-
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)const obj = {a: 1}; // The `.deep` flag now does deep equality comparisons expect({foo: obj}).to.have.deep.property('foo', {a: 1}); // Use the `nested` flag if you want to assert against a nested property using the bracket or dot notation expect({foo: obj}).to.have.nested.property('foo.a', 1); // You can also use both flags combined const obj2 = {a: {b: 2}}; expect({foo: obj2}).to.have.deep.nested.property('foo.a', {b: 2});
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.
Theassert.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)const obj = {a: 1}; expect([obj]).to.deep.include({a:1}); expect({foo: obj}).to.deep.include({foo: {a:1}});
-
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 isNaN
(or not if the.not
flag is used) and nothing else. (Related Issues: #498, #682, #681, PRs: #508)// Only `NaN` will be considered to be `NaN` and nothing else expect(NaN).to.be.NaN; // Anything that is not `NaN` cannot be considered as `NaN` expect('randomString').not.to.be.NaN; expect(true).not.to.be.NaN; expect({}).not.to.be.NaN; expect(4).not.to.be.NaN;
-
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
.// Considering the method `imaginaryMethod` does not exist, this would throw an error for example: chai.use(function (chai, utilities) { chai.Assertion.overwriteMethod('imaginaryMethod', function (_super) { return function () { _super.apply(this, arguments); } }); }); // This will throw an error since you are calling `_super` which should be a method (in this case, the overwritten assertion) that does not exist expect('anything').to.imaginaryMethod();
-
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 theAssertion.assert
method. (Related Issues: #574, PRs: #515)// Now whenever you call `Assertion.assert` with anything that is not false for the `showDiff` flag it will be true // The assertion error that was thrown will have the `showDiff` flag turned on since it was not passed to the `assert` method try { new chai.Assertion().assert( 'one' === 'two' , 'expected #{this} to equal #{exp}' , 'expected #{this} to not equal #{act}' , 'one' , 'two' ); } catch(e) { assert.isTrue(e.showDiff); } // The assertion error that was thrown will have the `showDiff` flag turned off since here we passed `false` explicitly try { new chai.Assertion().assert( 'one' === 'two' , 'expected #{this} to equal #{exp}' , 'expected #{this} to not equal #{act}' , 'one' , 'two' , false ); } catch(e) { assert.isFalse(e.showDiff); }
-
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)var arr = []; for (var i = 1; i <= 1000; i++) { arr.push(i); } // The assertion below will truncate the diff shown and the enourmous typed array will be shown as: // [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ... ] instead of printing the whole typed array chai.expect(new Float32Array(100)).to.equal(1);
-
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)// These will throw errors, for example: expect(null).to.be.within(0, 1); expect(null).to.be.above(10); expect(null).to.be.at.least(20); expect(null).to.be.below(20); expect(null).to.be.at.most(20); expect(null).to.increase.by(20); expect(null).to.decrease.by(20); // This will not: expect('string').to.have.a.length.of.at.least(3);
-
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)*
expect({ foo: 'baz' }).to.not.have.own.property('quux', 'baz');
-
The
.empty
assertion will now throw when it is passed non-string primitives and functions (PRs: #763, #812)// These will throw TypeErrors: expect(Symbol()).to.be.empty; expect(function() {}).to.be.empty; expect(true).to.be.empty; expect(1).to.be.empty
-
Assertion subject (
obj
) changes when usingownProperty
orown.property
and thus enables chaining. (Related Issues: #281, PRs: #641)expect({val: 20}).to.have.own.property('val').above(10);
-
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)
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
Before4.x.x
when using property assertions they would not throw an error if you wrote it incorrectly.
The example below, for example, would pass:expect(true).to.be.ture; // Oops, typo, now Chai will throw an Error
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:chai.config.useProxy = false; // disable use of Proxy
-
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.expect(false).to.be.fals; // Error: Invalid Chai property: fals. Did you mean "false"? expect('foo').to.be.undefind; // Error: Invalid Chai property: undefind. Did you mean "undefined"? // If the Levenshtein distance between the word and any Chai property is greater than 4, no fix will be suggested expect('foo').to.be.fdsakfdsafsagsadgagsdfasf // error thrown, no fix suggested
-
When non-chainable methods (including overwritten non-chainable methods) are used incorrectly an error will be thrown with a helpful error message. (PRs: #789)
expect(true).to.equal.true; // Invalid Chai property: equal.true. See docs for proper usage of "equal".
-
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 ES6Proxies
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)chai.config.proxyExcludedKeys.push('nonExistingProp'); expect('my string').to.nonExistingProp; // This won't throw an error now
-
Add script that registers should as a side-effect. (Related Issues: #594, #693 PRs: #604)
// You can now write: import 'chai/should'; // as opposed to: import {should} from 'chai'; should();
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)// Now you can also check if the return value of a function changes, for example assert.increases( someOperation, () => getSomething().length )
-
You can ...
3.5.0 / 2016-01-28
For assert
fans: you now have assert.includeDeepMembers()
which matches expect().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
- #589 Add
assert.includeDeepMembers()
. By @qbolec - #570 Fix error when using $ signs in messages. By @jurko-gospodnetic
- #575 Clean browser before karma in Makefile. By @lucasfcosta
- #577 Fix non ES5 compliant regexp. By @zetaben
- #579 Update karma for build. By @greenkeeperio-bot
Documentation fixes
- #561 (docs) Added JSDocs to 'should' interface. By @DavidBR-SW
- #565 Add Code of Conduct. By @keithamus
- #566 Fix typo in .change() docs. By @lizhengnacl
- #567 Add badges for Slack and Gitter. By @outsideris
- #574 clarified assert.isObject & assert.isNotObject documentation. By @gdelmas
3.4.2 / 2015-11-15
This is a small documentation bug fix release - it adds extra metatags to each public method to allow us to generate the docs easier for the website.
Community Contributions
Documentation fixes
- #552 (docs) Add namespace to all public methods. By @keithamus
3.4.1 / 2015-11-07
This is a small documentation bug fix release - it just fixes a couple of issues with the documentation.
Community Contributions
Documentation fixes
- #546 Remove incorrect
.throws()
example. By @Pklong - #547 Fix documentation syntax errors. By @keithamus
3.4.0 / 2015-10-21
This release improves some confusing error messages, and adds some new assertions. Key points:
- Feature: New assertion:
expect(1).oneOf([1,2,3])
- for asserting that a given value is one of a set. - Feature:
.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" - Feature:
.throw()
(and variants) can now better determine the Error types, for exampleexpect(foo).to.throw(node_assert.AssertionError)
now works. - Feature:
.closeTo
is now aliased as.approximately
- BugFix:
.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
- #503 Checking that argument given to expect is of the right type when using with include. By @astorije
- #446 Make chai able to cope with AssertionErrors raised from node's assert. By @danielbprice
- #527 Added approximately alias to close to. By @danielbprice
- #534
expect(inList).to.be.oneOf
assertion. By @Droogans - #538 Revert .empty assertion change from PR #499. By @tusbar
Documentation fixes
- #521 document how the
new Error
type gets detected by thea
/an
matcher. By @jurko-gospodnetic - #522 Fixes spelling error "everthing" -> "everything". By @austinpray
- #529 Fix assert lengthOf example. By @dxuehu
- #533 Fix typo in README.md. By @astorije
3.3.0 / 2015-09-08
This release adds some new assertions and fixes some quite important, long standing bugs. Here are the cliff notes:
- Bugfix: Property assertions that fail now show a stack trace!
- Bugfix: If you've used the
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 pass - The
assert
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
- #494 Add
assert.isNotTrue
andassert.isNotFalse
.
By @cezarykluczynski - #496
frozen
/extensible
/sealed
assertions behave the same in ES6 and ES5 environments.
By @astorije - #499 Simplify the
.empty
assertion.
By @Daveloper87 - #500 Add
assert.isAtMost
andassert.isAtLeast
.
By @wraithan - #512 fixed expect('').to.contain('') so it passes. By @dereke
- #514 Fix stack trace tracking for property assertions.
By @kpdecker
Documentation fixes
- #495 Correct misplaced docs for assertions (
isBelow
,isAbove
,isTrue
).
By @cezarykluczynski
3.2.0 / 2015-07-19
This release fixes a bug with the previous additions in 3.1.0
. assert.frozen
/expect().to.be.frozen
/.should.be.frozen
all accidentally called Object.isSealed()
instead. Now they correctly call Object.isFrozen()
.
If you're using these features, please upgrade immediately.
It also adds aliases for a lot of assert
methods:
- expect/should..respondTo: respondsTo
- expect/should..satisfy: satisfies
- assert.ok: assert.isOk
- assert.notOk: assert.isNotOk
- assert.extensible: assert.isExtensible
- assert.notExtensible: assert.isNotExtensible
- assert.sealed: assert.isSealed
- assert.notSealed: assert.isNotSealed
- assert.frozen: assert.isFrozen
- assert.notFrozen: assert.isNotFrozen
Community Contributions
Code Features & Fixes
- #482 Re-encrypt travis API key
By @keithamus - #482 Add respondsTo and satisfies as aliases
By @couchand - #485 Fixing a typo in the
getProperties()
utility
By @jluchiji - #486 Added links to contribution guidelines to README
By @jluchiji - #489 Various work on aliases
By @astorije - #490 Fix wrong call to the underlying method when checking if an object is frozen
By @astorije
3.1.0 / 2015-07-16
This release adds assertions for extensibility/freezing/sealing on objects:
assert.extensible({});
assert.notExtensible(Object.preventExtensions({}));
expect(Object.preventExtensions({})).to.not.be.extensible;
Object.preventExtensions({}).should.not.be.extensible;
assert.notSealed({});
assert.sealed(Object.seal({}));
expect(Object.seal({})).to.be.sealed;
Object.seal({}).should.be.sealed;
assert.notFrozen({});
assert.frozen(Object.freeze({}));
expect(Object.freeze({})).to.be.frozen;
Object.freeze({}).should.be.frozen;
It also adds assertions for checking if a number is NaN:
assert.isNaN(NaN);
assert.isNotNaN(5);
expect(NaN).to.be.NaN;
expect(5).to.not.be.NaN;
NaN.should.be.NaN;
5.should.not.be.NaN;
Community Contributions
Code Features & Fixes
- #480 Added tests and expectations for NaN
By @bradcypert - #479 Assertions to test if objects are extensible/sealed/frozen.
By @matthewlucock - #468 Remove moot
version
property from bower.json.
By @kkirsche
3.0.0 / 2015-06-04
This release contains some small breaking changes. Most people are unlikely to
notice them - but here are the breaking changes:
- Switched from "Component" builds to "Browserify" builds for Browsers. If
you're using RequireJS with Chai, you might notice a change (chai used to
be a global, now it won't be - instead you'll have torequire
it). .has.property('foo', undefined)
will now specifically test to make sure
that the value'foo'
is actually undefined - before it simply tested that
the key existed (but could have a value)..to.be.a('type')
has changed to support more types, including ES6 types
such as'promise'
,'symbol'
,'float32array'
etc, this also means using
ES6'sSymbol.toStringTag
affects the behaviour.to.be.a()
. In addition to
this, Errors have the type of'error'
.assert.ifError()
now follows Node'sassert.ifError()
behaviour - in other
words, if the first argument is truthy, it'll throw it.- ReleaseNotes.md is no longer maintained, see the Github Releases Page instead.
- History.md is no longer maintained, see the Github Commit Log instead.
Community Contributions
Code Features & Fixes
- #403
assert.ifError()
behaves like Node.js: it throws if the first argument is present.
By @cjqed - #419 assertion-error bumped to
^1.0.1
By @keithamus (special thanks to @simonzack for his work on assertion-error) - #421 replace type.js with type-detect module.
By @Charminbear - #439 Add
.matches()
as alias for.match()
.
By @thejameskyle - #451 Switch to using Browserify for the build system.
By @csnover - #452
.property('foo', undefined)
now actually checks to see ifobj.foo === undefined
(before it did not).
By @onefifth - #460 Automate release process as much as possible
By @keithamus
Documentation fixes
- #397 Improve docs for
.assert()
By @astorije - #401 Add some badges to the Readme.
By @keithamus - #424 Fix typo in docs for
.keys()
By @astorije - #429 Deprecate
.length(n)
from the docs - use.lengthOf(n)
instead.
By @valscion - #444 Change
.length(n)
examples to.lengthOf(n)
instead.
By @keithamus - #458 Remove stray character in
assert.notInclude
docs
By @BinaryMuse