eslint-plugin-chai-expect-keywords v2.1.0

eslint-plugin-chai-expect-keywords

ESLint plugin that checks for unsupported keywords in chai.js expect() assertions. Chai allows you to chain words to make readable assertions, but unfortunately you can include keywords that chai knows nothing about, and it will not fail the test. This eslint plugin helps you catch any such unsupported chains.

Installation

npm install eslint-plugin-chai-expect-keywords

Rules

• no-unsupported-keywords - Prevent using unsupported keywords in the expect() chains

Options

• allowKeywords adds an array of additional keywords to the allowed list
• allowSinonChai includes sinon-chai keywords in the allowed list
• allowChaiAsPromised includes chai-as-promised keywords in the allowed list. (You may also find eslint-plugin-chai-as-promised of interest in ensuring that return statements (or its notify method) are present as expected by chai-as-promised.)
• allowChaiDOM includes chai-dom keywords in the allowed list
• allowChaiExclude includes chai-exclude keywords in the allowed list

Configuration

Add a plugins section and specify chai-expect-keywords as a plugin:

{
  "plugins": [
    "chai-expect-keywords"
  ]
}

Enable the rule:

{
  "rules": {
    "chai-expect-keywords/no-unsupported-keywords": "error"
  }
}

Or with options:

{
  "rules": {
    "chai-expect-keywords/no-unsupported-keywords": [ "error", {
      "allowKeywords": ["length"],
      "allowSinonChai": true,
      "allowChaiAsPromised": true,
      "allowChaiDOM": true,
      "allowChaiExclude": true
    } ]
  }
}

If you want the rule enabled with only its boolean options, you can avoid the steps of adding to plugins and rules and just add:

{
  "extends": ["plugin:chai-expect-keywords/all"]
}

Or if you want the rule only with no booleans set, just add:

{
  "extends": ["plugin:chai-expect-keywords/recommended"]
}

License

eslint-plugin-chai-expect-keywords is licensed under the MIT License.