Name: js-handler/node_modules/nodeunit/deps/ejs/node_modules/expresso/Readme.md
| 1: | # Expresso |
| 2: | |
| 3: | TDD framework for [nodejs](http://nodejs.org). |
| 4: | |
| 5: | ## Features |
| 6: | |
| 7: | - light-weight |
| 8: | - intuitive async support |
| 9: | - intuitive test runner executable |
| 10: | - test coverage support and reporting |
| 11: | - uses the _assert_ module |
| 12: | - `assert.eql()` alias of `assert.deepEqual()` |
| 13: | - `assert.response()` http response utility |
| 14: | - `assert.includes()` |
| 15: | - `assert.type()` |
| 16: | - `assert.isNull()` |
| 17: | - `assert.isUndefined()` |
| 18: | - `assert.isNotNull()` |
| 19: | - `assert.isDefined()` |
| 20: | - `assert.match()` |
| 21: | - `assert.length()` |
| 22: | |
| 23: | ## Installation |
| 24: | |
| 25: | To install both expresso _and_ node-jscoverage run: |
| 26: | |
| 27: | $ make install |
| 28: | |
| 29: | To install expresso alone (no build required) run: |
| 30: | |
| 31: | $ make install-expresso |
| 32: | |
| 33: | Install via npm: |
| 34: | |
| 35: | $ npm install expresso |
| 36: | |
| 37: | ## Usage |
| 38: | |
| 39: | Create a directory named `test` in your project and place JavaScript files in it. Each JavaScript file can export multiple tests of this format: |
| 40: | |
| 41: | ```js |
| 42: | exports['test String#length'] = function(beforeExit, assert) { |
| 43: | assert.equal(6, 'foobar'.length); |
| 44: | }; |
| 45: | ``` |
| 46: | |
| 47: | To run tests, type `expresso`. |
| 48: | |
| 49: | For more information, [see the manual](http://visionmedia.github.com/expresso/). |
| 50: | |
| 51: | ## License |
| 52: | |
| 53: | (The MIT License) |
| 54: | |
| 55: | Copyright (c) 2010 TJ Holowaychuk <[email protected]> |
| 56: | |
| 57: | Permission is hereby granted, free of charge, to any person obtaining |
| 58: | a copy of this software and associated documentation files (the |
| 59: | 'Software'), to deal in the Software without restriction, including |
| 60: | without limitation the rights to use, copy, modify, merge, publish, |
| 61: | distribute, sublicense, and/or sell copies of the Software, and to |
| 62: | permit persons to whom the Software is furnished to do so, subject to |
| 63: | the following conditions: |
| 64: | |
| 65: | The above copyright notice and this permission notice shall be |
| 66: | included in all copies or substantial portions of the Software. |
| 67: | |
| 68: | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
| 69: | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 70: | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 71: | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
| 72: | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
| 73: | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 74: | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
