Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document terminating-properties rule #23

Merged
merged 3 commits into from
Oct 27, 2017
Merged

Document terminating-properties rule #23

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dec56b9
document terminating-properties extension
whamondg Oct 26, 2017
b2145a4
fix json
whamondg Oct 26, 2017
378a10d
remove yaml and clean docs
whamondg Oct 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,31 @@ Enable the rules that you would like to use:
- `terminating-properties` - Prevent calling `to.be.ok` and other assertion properties as functions


### Additional configuration

#### terminating-properties rule

A number of extenstions to chai add additional terminating properties. For example [chai-http](https://github.com/chaijs/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:

```json
{
"rules": {
"chai-expect/terminating-properties": ["error", {
"properties": ["headers", "html", "ip", "json", "redirect", "test"]
}]
}
}
```

## License

eslint-plugin-chai-expect is licensed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).