https://github.com/focusaurus/chaimel
chai.js BDD assertion API using camelCase instead of dot.chaining.syntax
https://github.com/focusaurus/chaimel
Last synced: 6 months ago
JSON representation
chai.js BDD assertion API using camelCase instead of dot.chaining.syntax
- Host: GitHub
- URL: https://github.com/focusaurus/chaimel
- Owner: focusaurus
- Created: 2014-11-29T04:24:30.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-05-25T13:11:22.000Z (about 10 years ago)
- Last Synced: 2025-01-28T00:41:22.270Z (over 1 year ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# chaimel
[](https://semaphoreci.com/focusaurus/chaimel)
[](https://github.com/feross/standard)
[chai.js](http://chaijs.com/) expect BDD api wrapped with `camelCase` method names instead of `dot.chaining.style`.
Lets you do:
- `expect(error).toHaveProperty("message");` instead of
- `expect(error).to.have.property("message");`
## Usage
```
var expect = require("chaimel");
expect(42).notToBeAbove(43);
```
## Why?
`dot.chaining.style` is problematic for me because:
- It's out of convention with the standard JavaScript built-in method names
- `toLowerCase`, `indexOf`, `forEach`, `hasOwnProperty`
- It's awkward to speak and hear. Do you say the "dot"s or just imply them?
- It doesn't work well with text editor autocomplete, whereas `camelCase` does
- I also personally find this kind of use of `Object.defineProperty` unidiomatic for the golden age of JavaScript. It's fully standard and fine, but my opinion is it fundamentally makes the language more magical and ruby-like and these are drawbacks not advantages.
- It was pretty quick and easy to create this module, so I did
## Are all the chai.expect methods supported?
**No**, I left out abbreviations such as `eql`, `lt` `gt` because I hate abbreviations. Use the full words and use `deepEqual` instead of `eql`. Having both `equal` and `eql` with different semantics is error-prone, hard to remember, and confusing to read.
## Browser Support
The code is designed to work in node.js or in the browser via [browserify](http://browserify.org). If you want vanilla browser support, file and issue and I can add the neccessary boilerplate.
## Contributing
- tests: `npm test`
- pull requests welcome
# MIT License
Copyright (c) 2016 Peter Lyons LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.