chai 1.8.1 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.npmignore +1 -1
- package/CONTRIBUTING.md +173 -0
- package/History.md +108 -0
- package/README.md +70 -40
- package/ReleaseNotes.md +220 -0
- package/bower.json +1 -1
- package/chai.js +594 -407
- package/karma.conf.js +4 -5
- package/lib/chai/assertion.js +36 -31
- package/lib/chai/config.js +50 -0
- package/lib/chai/core/assertions.js +119 -30
- package/lib/chai/interface/assert.js +15 -39
- package/lib/chai/interface/expect.js +1 -1
- package/lib/chai/interface/should.js +27 -25
- package/lib/chai/utils/addChainableMethod.js +22 -5
- package/lib/chai/utils/addMethod.js +7 -1
- package/lib/chai/utils/addProperty.js +1 -1
- package/lib/chai/utils/flag.js +1 -1
- package/lib/chai/utils/getActual.js +2 -3
- package/lib/chai/utils/getEnumerableProperties.js +1 -1
- package/lib/chai/utils/getMessage.js +2 -1
- package/lib/chai/utils/getName.js +1 -1
- package/lib/chai/utils/getPathValue.js +1 -1
- package/lib/chai/utils/getProperties.js +1 -1
- package/lib/chai/utils/index.js +6 -0
- package/lib/chai/utils/inspect.js +33 -20
- package/lib/chai/utils/objDisplay.js +3 -2
- package/lib/chai/utils/overwriteChainableMethod.js +53 -0
- package/lib/chai/utils/overwriteMethod.js +1 -1
- package/lib/chai/utils/overwriteProperty.js +1 -1
- package/lib/chai/utils/test.js +1 -1
- package/lib/chai/utils/transferFlags.js +1 -1
- package/lib/chai/utils/type.js +1 -1
- package/lib/chai.js +9 -2
- package/package.json +6 -7
package/.npmignore
CHANGED
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# Chai Contribution Guidelines
|
|
2
|
+
|
|
3
|
+
We like to encourage you to contribute to the Chai.js repository. This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request or open an issue.
|
|
4
|
+
|
|
5
|
+
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
|
|
6
|
+
|
|
7
|
+
#### Table of Contents
|
|
8
|
+
|
|
9
|
+
- [TLDR;](#tldr)
|
|
10
|
+
- [Contributing](#contributing)
|
|
11
|
+
- [Bug Reports](#bugs)
|
|
12
|
+
- [Feature Requests](#features)
|
|
13
|
+
- [Pull Requests](#pull-requests)
|
|
14
|
+
- [Support](#support)
|
|
15
|
+
- [Resources](#resources)
|
|
16
|
+
- [Core Contributors](#contributors)
|
|
17
|
+
|
|
18
|
+
<a name="tldr"></a>
|
|
19
|
+
## TLDR;
|
|
20
|
+
|
|
21
|
+
- Creating an Issue or Pull Request requires a [GitHub](http://github.com) account.
|
|
22
|
+
- Issue reports should be **clear**, **concise** and **reproducible**. Check to see if your issue has already been resolved in the [master]() branch or already reported in Chai's [GitHub Issue Tracker](https://github.com/chaijs/chai/issues).
|
|
23
|
+
- Pull Requests must adhere to strict [coding style guidelines](https://github.com/chaijs/chai/wiki/Chai-Coding-Style-Guide).
|
|
24
|
+
- In general, avoid submitting PRs for new Assertions without asking core contributors first. More than likely it would be better implemented as a plugin.
|
|
25
|
+
- Additional support is available via the [Google Group](http://groups.google.com/group/chaijs) or on irc.freenode.net#chaijs.
|
|
26
|
+
- **IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
<a name="contributing"></a>
|
|
31
|
+
## Contributing
|
|
32
|
+
|
|
33
|
+
The issue tracker is the preferred channel for [bug reports](#bugs),
|
|
34
|
+
[feature requests](#features) and [submitting pull
|
|
35
|
+
requests](#pull-requests), but please respect the following restrictions:
|
|
36
|
+
|
|
37
|
+
* Please **do not** use the issue tracker for personal support requests (use
|
|
38
|
+
[Google Group](https://groups.google.com/forum/#!forum/chaijs) or IRC).
|
|
39
|
+
* Please **do not** derail or troll issues. Keep the discussion on topic and
|
|
40
|
+
respect the opinions of others
|
|
41
|
+
|
|
42
|
+
<a name="bugs"></a>
|
|
43
|
+
### Bug Reports
|
|
44
|
+
|
|
45
|
+
A bug is a **demonstrable problem** that is caused by the code in the repository.
|
|
46
|
+
|
|
47
|
+
Guidelines for bug reports:
|
|
48
|
+
|
|
49
|
+
1. **Use the GitHub issue search** — check if the issue has already been reported.
|
|
50
|
+
2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
|
|
51
|
+
3. **Isolate the problem** — create a test case to demonstrate your issue. Provide either a repo, gist, or code sample to demonstrate you problem.
|
|
52
|
+
|
|
53
|
+
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and/or Node.js versions experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
|
|
54
|
+
|
|
55
|
+
Example:
|
|
56
|
+
|
|
57
|
+
> Short and descriptive example bug report title
|
|
58
|
+
>
|
|
59
|
+
> A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
|
|
60
|
+
>
|
|
61
|
+
> 1. This is the first step
|
|
62
|
+
> 2. This is the second step
|
|
63
|
+
> 3. Further steps, etc.
|
|
64
|
+
>
|
|
65
|
+
> `<url>` - a link to the reduced test case OR
|
|
66
|
+
> ```js
|
|
67
|
+
> expect(a).to.equal('a');
|
|
68
|
+
> // code sample
|
|
69
|
+
> ```
|
|
70
|
+
>
|
|
71
|
+
> Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
|
|
72
|
+
|
|
73
|
+
<a name="features"></a>
|
|
74
|
+
### Feature Requests
|
|
75
|
+
|
|
76
|
+
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
|
|
77
|
+
|
|
78
|
+
Furthermore, since Chai.js has a [robust plugin API](http://chaijs.com/guide/plugins/), we encourage you to publish **new Assertions** as plugins. If your feature is an enhancement to an **existing Assertion**, please propose your changes as an issue prior to opening a pull request. If the core Chai.js contributors feel your plugin would be better suited as a core assertion, they will invite you to open a PR in [chaijs/chai](https://github.com/chaijs/chai).
|
|
79
|
+
|
|
80
|
+
<a name="pull-requests"></a>
|
|
81
|
+
### Pull Requests
|
|
82
|
+
|
|
83
|
+
- PRs for new core-assertions are advised against.
|
|
84
|
+
- PRs for core-assertion bug fixes are always welcome.
|
|
85
|
+
- PRs for enhancing the interfaces are always welcome.
|
|
86
|
+
- PRs that increase test coverage are always welcome.
|
|
87
|
+
- PRs are scrutinized for coding-style.
|
|
88
|
+
|
|
89
|
+
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
|
|
90
|
+
|
|
91
|
+
**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
|
|
92
|
+
|
|
93
|
+
Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Please review the [Chai.js Coding Style Guide](https://github.com/chaijs/chai/wiki/Chai-Coding-Style-Guide).
|
|
94
|
+
|
|
95
|
+
Follow this process if you'd like your work considered for inclusion in the project:
|
|
96
|
+
|
|
97
|
+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
# Clone your fork of the repo into the current directory
|
|
101
|
+
git clone https://github.com/<your-username>/<repo-name>
|
|
102
|
+
# Navigate to the newly cloned directory
|
|
103
|
+
cd <repo-name>
|
|
104
|
+
# Assign the original repo to a remote called "upstream"
|
|
105
|
+
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
2. If you cloned a while ago, get the latest changes from upstream:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
git checkout <dev-branch>
|
|
112
|
+
git pull upstream <dev-branch>
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
git checkout -b <topic-branch-name>
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
4. Commit your changes in logical chunks. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public.
|
|
122
|
+
|
|
123
|
+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
git pull [--rebase] upstream <dev-branch>
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
6. Push your topic branch up to your fork:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
git push origin <topic-branch-name>
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
|
|
136
|
+
|
|
137
|
+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.
|
|
138
|
+
|
|
139
|
+
<a name="support"></a>
|
|
140
|
+
## Support
|
|
141
|
+
|
|
142
|
+
<a name="resources"></a>
|
|
143
|
+
### Resources
|
|
144
|
+
|
|
145
|
+
For most of the documentation you are going to want to visit [ChaiJS.com](http://chaijs.com).
|
|
146
|
+
|
|
147
|
+
- [Getting Started Guide](http://chaijs.com/guide/)
|
|
148
|
+
- [API Reference](http://chaijs.com/api/)
|
|
149
|
+
- [Plugins](http://chaijs.com/plugins/)
|
|
150
|
+
|
|
151
|
+
Alternatively, the [wiki](https://github.com/chaijs/chai/wiki) might be what you are looking for.
|
|
152
|
+
|
|
153
|
+
- [Chai Coding Style Guide](https://github.com/chaijs/chai/wiki/Chai-Coding-Style-Guide)
|
|
154
|
+
- [Third-party Resources](https://github.com/chaijs/chai/wiki/Third-Party-Resources)
|
|
155
|
+
|
|
156
|
+
Or finally, you may find a core-contributor or like-minded developer in any of our support channels.
|
|
157
|
+
|
|
158
|
+
- IRC: irc.freenode.org #chaijs
|
|
159
|
+
- [Mailing List / Google Group](https://groups.google.com/forum/#!forum/chaijs)
|
|
160
|
+
|
|
161
|
+
<a name="contributors"></a>
|
|
162
|
+
### Core Contributors
|
|
163
|
+
|
|
164
|
+
Feel free to reach out to any of the core-contributors with you questions or concerns. We will do our best to respond in a timely manner.
|
|
165
|
+
|
|
166
|
+
- Jake Luer
|
|
167
|
+
- GH: [@logicalparadox](https://github.com/logicalparadox)
|
|
168
|
+
- TW: [@jakeluer](http://twitter.com/jakeluer)
|
|
169
|
+
- IRC: logicalparadox
|
|
170
|
+
- Veselin Todorov
|
|
171
|
+
- GH: [@vesln](https://github.com/vesln/)
|
|
172
|
+
- TW: [@vesln](http://twitter.com/vesln)
|
|
173
|
+
- IRC: vesln
|
package/History.md
CHANGED
|
@@ -1,4 +1,112 @@
|
|
|
1
1
|
|
|
2
|
+
1.10.0 / 2014-11-10
|
|
3
|
+
==================
|
|
4
|
+
|
|
5
|
+
* Merge pull request #297 from prodatakey/noopchainfunc
|
|
6
|
+
* Merge pull request #300 from julienw/299-fix-getMessage-test
|
|
7
|
+
* Fix #299: the test is defining global variables
|
|
8
|
+
* Add a couple more unit tests
|
|
9
|
+
* Add unit tests for chained terminating property asserts
|
|
10
|
+
* Revise documentation wording
|
|
11
|
+
* Add docs for function style NOOP asserts
|
|
12
|
+
* Make the NOOP function a shared constant
|
|
13
|
+
* Merge pull request #298 from dasilvacontin/negativeZeroLogging
|
|
14
|
+
* why not more assertions
|
|
15
|
+
* added test for inspecting `-0`
|
|
16
|
+
* a more readable/simple condition statement, as pointed out by @keithamus
|
|
17
|
+
* added check for logging negative zero
|
|
18
|
+
* Change test to not trigger argument bug
|
|
19
|
+
* Allows writing lint-friendly tests
|
|
20
|
+
* readme: update contributors for 1.9.2
|
|
21
|
+
|
|
22
|
+
1.9.2 / 2014-09-29
|
|
23
|
+
==================
|
|
24
|
+
|
|
25
|
+
* Merge pull request #268 from charlierudolph/cr-lazyMessages
|
|
26
|
+
* Merge pull request #269 from charlierudolph/cr-codeCleanup
|
|
27
|
+
* Merge pull request #277 from charlierudolph/fix-doc
|
|
28
|
+
* Merge pull request #279 from mohayonao/fix-closeTo
|
|
29
|
+
* Merge pull request #292 from boneskull/mocha
|
|
30
|
+
* resolves #255: upgrade mocha
|
|
31
|
+
* Merge pull request #289 from charlierudolph/cr-dryUpCode
|
|
32
|
+
* Dry up code
|
|
33
|
+
* Merge pull request #275 from DrRataplan/master
|
|
34
|
+
* assert: .closeTo() verify value's type before assertion
|
|
35
|
+
* Rewrite pretty-printing HTML elements to prevent throwing internal errors Fixes errors occuring when using a non-native DOM implementation
|
|
36
|
+
* Fix assert documentation
|
|
37
|
+
* Remove unused argument
|
|
38
|
+
* Allow messages to be functions
|
|
39
|
+
* Merge pull request #267 from shinnn/master
|
|
40
|
+
* Use SVG badge
|
|
41
|
+
* Merge pull request #264 from cjthompson/keys_diff
|
|
42
|
+
* Show diff for keys assertion
|
|
43
|
+
|
|
44
|
+
1.9.1 / 2014-03-19
|
|
45
|
+
==================
|
|
46
|
+
|
|
47
|
+
* deps update
|
|
48
|
+
* util: [getActual] select actual logic now allows undefined for actual. Closes #183
|
|
49
|
+
* docs: [config] make public, express param type
|
|
50
|
+
* Merge pull request #251 from romario333/threshold3
|
|
51
|
+
* Fix issue #166 - configurable threshold in objDisplay.
|
|
52
|
+
* Move configuration options to config.js.
|
|
53
|
+
* Merge pull request #233 from Empeeric/master
|
|
54
|
+
* Merge pull request #244 from leider/fix_for_contains
|
|
55
|
+
* Merge pull request #247 from didoarellano/typo-fixes
|
|
56
|
+
* Fix typos
|
|
57
|
+
* Merge pull request #245 from lfac-pt/patch-1
|
|
58
|
+
* Update `exports.version` to 1.9.0
|
|
59
|
+
* aborting loop on finding
|
|
60
|
+
* declaring variable only once
|
|
61
|
+
* additional test finds incomplete implementation
|
|
62
|
+
* simplified code
|
|
63
|
+
* fixing #239 (without changing chai.js)
|
|
64
|
+
* ssfi as it should be
|
|
65
|
+
* Merge pull request #228 from duncanbeevers/deep_members
|
|
66
|
+
* Deep equality check for collection membership
|
|
67
|
+
|
|
68
|
+
1.9.0 / 2014-01-29
|
|
69
|
+
==================
|
|
70
|
+
|
|
71
|
+
* docs: add contributing.md #238
|
|
72
|
+
* assert: .throws() returns thrown error. Closes #185
|
|
73
|
+
* Merge pull request #232 from laconbass/assert-throws
|
|
74
|
+
* assert: .fail() parameter mismatch. Closes #206
|
|
75
|
+
* Merge branch 'karma-fixes'
|
|
76
|
+
* Add karma phantomjs launcher
|
|
77
|
+
* Use latest karma and sauce launcher
|
|
78
|
+
* Karma tweaks
|
|
79
|
+
* Merge pull request #230 from jkroso/include
|
|
80
|
+
* Merge pull request #237 from chaijs/coverage
|
|
81
|
+
* Add coverage to npmignore
|
|
82
|
+
* Remove lib-cov from test-travisci dependents
|
|
83
|
+
* Remove the not longer needed lcov reporter
|
|
84
|
+
* Test coverage with istanbul
|
|
85
|
+
* Remove jscoverage
|
|
86
|
+
* Remove coveralls
|
|
87
|
+
* Merge pull request #226 from duncanbeevers/add_has
|
|
88
|
+
* Avoid error instantiation if possible on assert.throws
|
|
89
|
+
* Merge pull request #231 from duncanbeevers/update_copyright_year
|
|
90
|
+
* Update Copyright notices to 2014
|
|
91
|
+
* handle negation correctly
|
|
92
|
+
* add failing test case
|
|
93
|
+
* support `{a:1,b:2}.should.include({a:1})`
|
|
94
|
+
* Merge pull request #224 from vbardales/master
|
|
95
|
+
* Add `has` to language chains
|
|
96
|
+
* Merge pull request #219 from demands/overwrite_chainable
|
|
97
|
+
* return error on throw method to chain on error properties, possibly different from message
|
|
98
|
+
* util: store chainable behavior in a __methods object on ctx
|
|
99
|
+
* util: code style fix
|
|
100
|
+
* util: add overwriteChainableMethod utility (for #215)
|
|
101
|
+
* Merge pull request #217 from demands/test_cleanup
|
|
102
|
+
* test: make it possible to run utilities tests with --watch
|
|
103
|
+
* makefile: change location of karma-runner bin script
|
|
104
|
+
* Merge pull request #202 from andreineculau/patch-2
|
|
105
|
+
* test: add tests for throwing custom errors
|
|
106
|
+
* Merge pull request #201 from andreineculau/patch-1
|
|
107
|
+
* test: updated for the new assertion errors
|
|
108
|
+
* core: improve message for assertion errors (throw assertion)
|
|
109
|
+
|
|
2
110
|
1.8.1 / 2013-10-10
|
|
3
111
|
==================
|
|
4
112
|
|
package/README.md
CHANGED
|
@@ -5,60 +5,90 @@ can be delightfully paired with any javascript testing framework.
|
|
|
5
5
|
|
|
6
6
|
For more information or to download plugins, view the [documentation](http://chaijs.com).
|
|
7
7
|
|
|
8
|
-
[](https://travis-ci.org/chaijs/chai)
|
|
9
9
|
|
|
10
10
|
[](https://saucelabs.com/u/chaijs)
|
|
11
11
|
|
|
12
|
+
### Plugins
|
|
13
|
+
|
|
14
|
+
Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.
|
|
15
|
+
|
|
16
|
+
- Need a plugin? View the [official plugin list](http://chaijs.com/plugins).
|
|
17
|
+
- Have a plugin and want it listed? Open a Pull Request at [chaijs/chai-docs:plugin.js](https://github.com/chaijs/chai-docs/blob/master/plugins.js#L1-L12).
|
|
18
|
+
- Want to build a plugin? Read the [plugin api documentation](http://chaijs.com/guide/plugins/).
|
|
19
|
+
|
|
12
20
|
### Related Projects
|
|
13
21
|
|
|
14
22
|
- [chaijs / assertion-error](https://github.com/chaijs/assertion-error): Custom `Error` constructor thrown upon an assertion failing.
|
|
15
|
-
- [chaijs / deep-eql](https://github.com/chaijs/deep-eql): Improved deep equality testing for Node.js and the browser.
|
|
23
|
+
- [chaijs / deep-eql](https://github.com/chaijs/deep-eql): Improved deep equality testing for Node.js and the browser.
|
|
16
24
|
|
|
17
25
|
### Contributors
|
|
18
26
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
27
|
+
repo age : 2 years, 11 months
|
|
28
|
+
active : 189 days
|
|
29
|
+
commits : 792
|
|
30
|
+
files : 57
|
|
31
|
+
authors :
|
|
32
|
+
551 Jake Luer 69.6%
|
|
33
|
+
79 Veselin Todorov 10.0%
|
|
34
|
+
43 Domenic Denicola 5.4%
|
|
35
|
+
7 Joshua Perry 0.9%
|
|
36
|
+
6 Ruben Verborgh 0.8%
|
|
37
|
+
5 George Kats 0.6%
|
|
38
|
+
5 Jo Liss 0.6%
|
|
39
|
+
5 Juliusz Gonera 0.6%
|
|
40
|
+
5 Scott Nonnenberg 0.6%
|
|
41
|
+
5 leider 0.6%
|
|
42
|
+
4 David da Silva 0.5%
|
|
43
|
+
4 John Firebaugh 0.5%
|
|
44
|
+
4 Max Edmands 0.5%
|
|
45
|
+
4 Nick Heiner 0.5%
|
|
46
|
+
4 Veselin 0.5%
|
|
47
|
+
4 charlierudolph 0.5%
|
|
48
|
+
4 josher19 0.5%
|
|
49
|
+
3 Andrei Neculau 0.4%
|
|
50
|
+
3 Duncan Beevers 0.4%
|
|
51
|
+
3 Jake Rosoman 0.4%
|
|
52
|
+
3 Jeff Barczewski 0.4%
|
|
53
|
+
3 Keith Cirkel 0.4%
|
|
54
|
+
3 Ryunosuke SATO 0.4%
|
|
55
|
+
2 Bartvds 0.3%
|
|
56
|
+
2 Edwin Shao 0.3%
|
|
57
|
+
2 Jakub Nešetřil 0.3%
|
|
58
|
+
2 Roman Masek 0.3%
|
|
59
|
+
2 Teddy Cross 0.3%
|
|
60
|
+
1 Anand Patil 0.1%
|
|
61
|
+
1 Benjamin Horsleben 0.1%
|
|
62
|
+
1 Brandon Payton 0.1%
|
|
63
|
+
1 Chris Connelly 0.1%
|
|
64
|
+
1 Chris Thompson 0.1%
|
|
65
|
+
1 Christopher Hiller 0.1%
|
|
66
|
+
1 Chun-Yi 0.1%
|
|
67
|
+
1 DD 0.1%
|
|
68
|
+
1 Dido Arellano 0.1%
|
|
69
|
+
1 Jeff Welch 0.1%
|
|
70
|
+
1 Julien Wajsberg 0.1%
|
|
71
|
+
1 Kilian Ciuffolo 0.1%
|
|
72
|
+
1 Luís Cardoso 0.1%
|
|
73
|
+
1 Martin Middel 0.1%
|
|
74
|
+
1 Niklas Närhinen 0.1%
|
|
75
|
+
1 Paul Miller 0.1%
|
|
76
|
+
1 Refael Ackermann 0.1%
|
|
77
|
+
1 Sasha Koss 0.1%
|
|
78
|
+
1 Victor Costan 0.1%
|
|
79
|
+
1 Vinay Pulim 0.1%
|
|
80
|
+
1 Virginie BARDALES 0.1%
|
|
81
|
+
1 laconbass 0.1%
|
|
82
|
+
1 mohayonao 0.1%
|
|
83
|
+
1 piecioshka 0.1%
|
|
84
|
+
1 shinnn 0.1%
|
|
85
|
+
|
|
56
86
|
|
|
57
87
|
## License
|
|
58
88
|
|
|
59
89
|
(The MIT License)
|
|
60
90
|
|
|
61
|
-
Copyright (c) 2011-
|
|
91
|
+
Copyright (c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
|
|
62
92
|
|
|
63
93
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
64
94
|
of this software and associated documentation files (the "Software"), to deal
|
package/ReleaseNotes.md
CHANGED
|
@@ -1,5 +1,225 @@
|
|
|
1
1
|
# Release Notes
|
|
2
2
|
|
|
3
|
+
## 1.10.0 / 2014-11-10
|
|
4
|
+
|
|
5
|
+
The following changes are required if you are upgrading from the previous version:
|
|
6
|
+
|
|
7
|
+
- **Users:**
|
|
8
|
+
- No changes required
|
|
9
|
+
- **Plugin Developers:**
|
|
10
|
+
- Review `addChainableNoop` notes below.
|
|
11
|
+
- **Core Contributors:**
|
|
12
|
+
- Refresh `node_modules` folder for updated dependencies.
|
|
13
|
+
|
|
14
|
+
### Noop Function for Terminating Assertion Properties
|
|
15
|
+
|
|
16
|
+
The following assertions can now also be used in the function-call form:
|
|
17
|
+
|
|
18
|
+
* ok
|
|
19
|
+
* true
|
|
20
|
+
* false
|
|
21
|
+
* null
|
|
22
|
+
* undefined
|
|
23
|
+
* exist
|
|
24
|
+
* empty
|
|
25
|
+
* arguments
|
|
26
|
+
* Arguments
|
|
27
|
+
|
|
28
|
+
The above list of assertions are property getters that assert immediately on
|
|
29
|
+
access. Because of that, they were written to be used by terminating the assertion
|
|
30
|
+
chain with a property access.
|
|
31
|
+
|
|
32
|
+
```js
|
|
33
|
+
expect(true).to.be.true;
|
|
34
|
+
foo.should.be.ok;
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
This syntax is definitely aesthetically pleasing but, if you are linting your
|
|
38
|
+
test code, your linter will complain with an error something like "Expected an
|
|
39
|
+
assignment or function call and instead saw an expression." Since the linter
|
|
40
|
+
doesn't know about the property getter it assumes this line has no side-effects,
|
|
41
|
+
and throws a warning in case you made a mistake.
|
|
42
|
+
|
|
43
|
+
Squelching these errors is not a good solution as test code is getting to be
|
|
44
|
+
just as important as, if not more than, production code. Catching syntactical
|
|
45
|
+
errors in tests using static analysis is a great tool to help make sure that your
|
|
46
|
+
tests are well-defined and free of typos.
|
|
47
|
+
|
|
48
|
+
A better option was to provide a function-call form for these assertions so that
|
|
49
|
+
the code's intent is more clear and the linters stop complaining about something
|
|
50
|
+
looking off. This form is added in addition to the existing property access form
|
|
51
|
+
and does not impact existing test code.
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
expect(true).to.be.true();
|
|
55
|
+
foo.should.be.ok();
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
These forms can also be mixed in any way, these are all functionally identical:
|
|
59
|
+
|
|
60
|
+
```js
|
|
61
|
+
expect(true).to.be.true.and.not.false();
|
|
62
|
+
expect(true).to.be.true().and.not.false;
|
|
63
|
+
expect(true).to.be.true.and.not.false;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
#### Plugin Authors
|
|
67
|
+
|
|
68
|
+
If you would like to provide this function-call form for your terminating assertion
|
|
69
|
+
properties, there is a new function to register these types of asserts. Instead
|
|
70
|
+
of using `addProperty` to register terminating assertions, simply use `addChainableNoop`
|
|
71
|
+
instead; the arguments to both are identical. The latter will make the assertion
|
|
72
|
+
available in both the attribute and function-call forms and should have no impact
|
|
73
|
+
on existing users of your plugin.
|
|
74
|
+
|
|
75
|
+
### Community Contributions
|
|
76
|
+
|
|
77
|
+
- [#297](https://github.com/chaijs/chai/pull/297) Allow writing lint-friendly tests. [@joshperry](https://github.com/joshperry)
|
|
78
|
+
- [#298](https://github.com/chaijs/chai/pull/298) Add check for logging `-0`. [@dasilvacontin](https://github.com/dasilvacontin)
|
|
79
|
+
- [#300](https://github.com/chaijs/chai/pull/300) Fix #299: the test is defining global variables [@julienw](https://github.com/julienw)
|
|
80
|
+
|
|
81
|
+
Thank you to all who took time to contribute!
|
|
82
|
+
|
|
83
|
+
## 1.9.2 / 2014-09-29
|
|
84
|
+
|
|
85
|
+
The following changes are required if you are upgrading from the previous version:
|
|
86
|
+
|
|
87
|
+
- **Users:**
|
|
88
|
+
- No changes required
|
|
89
|
+
- **Plugin Developers:**
|
|
90
|
+
- No changes required
|
|
91
|
+
- **Core Contributors:**
|
|
92
|
+
- Refresh `node_modules` folder for updated dependencies.
|
|
93
|
+
|
|
94
|
+
### Community Contributions
|
|
95
|
+
|
|
96
|
+
- [#264](https://github.com/chaijs/chai/pull/264) Show diff for keys assertions [@cjthompson](https://github.com/cjthompson)
|
|
97
|
+
- [#267](https://github.com/chaijs/chai/pull/267) Use SVG badges [@shinnn](https://github.com/shinnn)
|
|
98
|
+
- [#268](https://github.com/chaijs/chai/pull/268) Allow messages to be functions (sinon-compat) [@charlierudolph](https://github.com/charlierudolph)
|
|
99
|
+
- [#269](https://github.com/chaijs/chai/pull/269) Remove unused argument for #lengthOf [@charlierudolph](https://github.com/charlierudolph)
|
|
100
|
+
- [#275](https://github.com/chaijs/chai/pull/275) Rewrite pretty-printing HTML elements to prevent throwing internal errors [@DrRataplan](https://github.com/DrRataplan)
|
|
101
|
+
- [#277](https://github.com/chaijs/chai/pull/277) Fix assert documentation for #sameMembers [@charlierudolph](https://github.com/charlierudolph)
|
|
102
|
+
- [#279](https://github.com/chaijs/chai/pull/279) closeTo should check value's type before assertion [@mohayonao](https://github.com/mohayonao)
|
|
103
|
+
- [#289](https://github.com/chaijs/chai/pull/289) satisfy is called twice [@charlierudolph](https://github.com/charlierudolph)
|
|
104
|
+
- [#292](https://github.com/chaijs/chai/pull/292) resolve conflicts with node-webkit and global usage [@boneskull](https://github.com/boneskull)
|
|
105
|
+
|
|
106
|
+
Thank you to all who took time to contribute!
|
|
107
|
+
|
|
108
|
+
## 1.9.1 / 2014-03-19
|
|
109
|
+
|
|
110
|
+
The following changes are required if you are upgrading from the previous version:
|
|
111
|
+
|
|
112
|
+
- **Users:**
|
|
113
|
+
- Migrate configuration options to new interface. (see notes)
|
|
114
|
+
- **Plugin Developers:**
|
|
115
|
+
- No changes required
|
|
116
|
+
- **Core Contributors:**
|
|
117
|
+
- Refresh `node_modules` folder for updated dependencies.
|
|
118
|
+
|
|
119
|
+
### Configuration
|
|
120
|
+
|
|
121
|
+
There have been requests for changes and additions to the configuration mechanisms
|
|
122
|
+
and their impact in the Chai architecture. As such, we have decoupled the
|
|
123
|
+
configuration from the `Assertion` constructor. This not only allows for centralized
|
|
124
|
+
configuration, but will allow us to shift the responsibility from the `Assertion`
|
|
125
|
+
constructor to the `assert` interface in future releases.
|
|
126
|
+
|
|
127
|
+
These changes have been implemented in a non-breaking way, but a depretiation
|
|
128
|
+
warning will be presented to users until they migrate. The old config method will
|
|
129
|
+
be removed in either `v1.11.0` or `v2.0.0`, whichever comes first.
|
|
130
|
+
|
|
131
|
+
#### Quick Migration
|
|
132
|
+
|
|
133
|
+
```js
|
|
134
|
+
// change this:
|
|
135
|
+
chai.Assertion.includeStack = true;
|
|
136
|
+
chai.Assertion.showDiff = false;
|
|
137
|
+
|
|
138
|
+
// ... to this:
|
|
139
|
+
chai.config.includeStack = true;
|
|
140
|
+
chai.config.showDiff = false;
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
#### All Config Options
|
|
144
|
+
|
|
145
|
+
##### config.includeStack
|
|
146
|
+
|
|
147
|
+
- **@param** _{Boolean}_
|
|
148
|
+
- **@default** `false`
|
|
149
|
+
|
|
150
|
+
User configurable property, influences whether stack trace is included in
|
|
151
|
+
Assertion error message. Default of `false` suppresses stack trace in the error
|
|
152
|
+
message.
|
|
153
|
+
|
|
154
|
+
##### config.showDiff
|
|
155
|
+
|
|
156
|
+
- **@param** _{Boolean}_
|
|
157
|
+
- **@default** `true`
|
|
158
|
+
|
|
159
|
+
User configurable property, influences whether or not the `showDiff` flag
|
|
160
|
+
should be included in the thrown AssertionErrors. `false` will always be `false`;
|
|
161
|
+
`true` will be true when the assertion has requested a diff be shown.
|
|
162
|
+
|
|
163
|
+
##### config.truncateThreshold **(NEW)**
|
|
164
|
+
|
|
165
|
+
- **@param** _{Number}_
|
|
166
|
+
- **@default** `40`
|
|
167
|
+
|
|
168
|
+
User configurable property, sets length threshold for actual and expected values
|
|
169
|
+
in assertion errors. If this threshold is exceeded, the value is truncated.
|
|
170
|
+
|
|
171
|
+
Set it to zero if you want to disable truncating altogether.
|
|
172
|
+
|
|
173
|
+
```js
|
|
174
|
+
chai.config.truncateThreshold = 0; // disable truncating
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Community Contributions
|
|
178
|
+
|
|
179
|
+
- [#228](https://github.com/chaijs/chai/pull/228) Deep equality check for memebers. [@duncanbeevers](https://github.com/duncanbeevers)
|
|
180
|
+
- [#247](https://github.com/chaijs/chai/pull/247) Proofreading. [@didorellano](https://github.com/didoarellano)
|
|
181
|
+
- [#244](https://github.com/chaijs/chai/pull/244) Fix `contain`/`include` 1.9.0 regression. [@leider](https://github.com/leider)
|
|
182
|
+
- [#233](https://github.com/chaijs/chai/pull/233) Improvements to `ssfi` for `assert` interface. [@refack](https://github.com/refack)
|
|
183
|
+
- [#251](https://github.com/chaijs/chai/pull/251) New config option: object display threshold. [@romario333](https://github.com/romario333)
|
|
184
|
+
|
|
185
|
+
Thank you to all who took time to contribute!
|
|
186
|
+
|
|
187
|
+
### Other Bug Fixes
|
|
188
|
+
|
|
189
|
+
- [#183](https://github.com/chaijs/chai/issues/183) Allow `undefined` for actual. (internal api)
|
|
190
|
+
- Update Karam(+plugins)/Istanbul to most recent versions.
|
|
191
|
+
|
|
192
|
+
## 1.9.0 / 2014-01-29
|
|
193
|
+
|
|
194
|
+
The following changes are required if you are upgrading from the previous version:
|
|
195
|
+
|
|
196
|
+
- **Users:**
|
|
197
|
+
- No changes required
|
|
198
|
+
- **Plugin Developers:**
|
|
199
|
+
- Review [#219](https://github.com/chaijs/chai/pull/219).
|
|
200
|
+
- **Core Contributors:**
|
|
201
|
+
- Refresh `node_modules` folder for updated dependencies.
|
|
202
|
+
|
|
203
|
+
### Community Contributions
|
|
204
|
+
|
|
205
|
+
- [#202](https://github.com/chaijs/chai/pull/201) Improve error message for .throw(). [@andreineculau](https://github.com/andreineculau)
|
|
206
|
+
- [#217](https://github.com/chaijs/chai/pull/217) Chai tests can be run with `--watch`. [@demands](https://github.com/demands)
|
|
207
|
+
- [#219](https://github.com/chaijs/chai/pull/219) Add overwriteChainableMethod utility. [@demands](https://github.com/demands)
|
|
208
|
+
- [#224](https://github.com/chaijs/chai/pull/224) Return error on throw method to chain on error properties. [@vbardales](https://github.com/vbardales)
|
|
209
|
+
- [#226](https://github.com/chaijs/chai/pull/226) Add `has` to language chains. [@duncanbeevers](https://github.com/duncanbeevers)
|
|
210
|
+
- [#230](https://github.com/chaijs/chai/pull/230) Support `{a:1,b:2}.should.include({a:1})` [@jkroso](https://github.com/jkroso)
|
|
211
|
+
- [#231](https://github.com/chaijs/chai/pull/231) Update Copyright notices to 2014 [@duncanbeevers](https://github.com/duncanbeevers)
|
|
212
|
+
- [#232](https://github.com/chaijs/chai/pull/232) Avoid error instantiation if possible on assert.throws. [@laconbass](https://github.com/laconbass)
|
|
213
|
+
|
|
214
|
+
Thank you to all who took time to contribute!
|
|
215
|
+
|
|
216
|
+
### Other Bug Fixes
|
|
217
|
+
|
|
218
|
+
- [#225](https://github.com/chaijs/chai/pull/225) Improved AMD wrapper provided by upstream `component(1)`.
|
|
219
|
+
- [#185](https://github.com/chaijs/chai/issues/185) `assert.throws()` returns thrown error for further assertions.
|
|
220
|
+
- [#237](https://github.com/chaijs/chai/pull/237) Remove coveralls/jscoverage, include istanbul coverage report in travis test.
|
|
221
|
+
- Update Karma and Sauce runner versions for consistent CI results. No more karma@canary.
|
|
222
|
+
|
|
3
223
|
## 1.8.1 / 2013-10-10
|
|
4
224
|
|
|
5
225
|
The following changes are required if you are upgrading from the previous version:
|