ESLint plugin that checks for common chai.js expect() mistakes
npm install --save-dev eslint-plugin-chai-expect
Add a plugins
section and specify chai-expect
as a plugin:
{
"plugins": [
"chai-expect"
]
}
Enable the rules that you would like to use:
{
"rules": {
"chai-expect/missing-assertion": 2,
"chai-expect/terminating-properties": 1
}
}
no-inner-compare
- Prevent using comparisons in theexpect()
argumentmissing-assertion
- Prevent callingexpect(...)
without an assertion like.to.be.ok
terminating-properties
- Prevent callingto.be.ok
and other assertion properties as functions
A number of extenstions to chai add additional terminating properties. For example chai-http adds:
- headers
- html
- ip
- json
- redirect
- text
The terminating-properties rule can be configured to ensure these (or other) additional properties are not used as functions:
{
"rules": {
"chai-expect/terminating-properties": ["error", {
"properties": ["headers", "html", "ip", "json", "redirect", "test"]
}]
}
}
eslint-plugin-chai-expect is licensed under the MIT License.