eslint-plugin-chai-friendly
Advanced tools
Package description
eslint-plugin-chai-friendly is an ESLint plugin designed to work with the Chai assertion library. It helps developers write cleaner and more maintainable test code by preventing false positives when using Chai's assertion syntax.
No-unused-expressions
This feature allows the use of Chai's 'expect' and 'should' assertions without triggering ESLint's 'no-unused-expressions' rule. It ensures that expressions like 'expect(foo).to.be.true;' are not flagged as errors.
/* eslint chai-friendly/no-unused-expressions: 2 */
expect(foo).to.be.true;eslint-plugin-mocha is an ESLint plugin that provides linting rules specific to Mocha test framework. It helps enforce best practices and coding standards in Mocha tests. Unlike eslint-plugin-chai-friendly, which focuses on Chai assertions, eslint-plugin-mocha covers a broader range of Mocha-specific rules.
eslint-plugin-jest is an ESLint plugin for Jest testing framework. It includes rules for ensuring best practices and avoiding common pitfalls in Jest tests. While eslint-plugin-chai-friendly is tailored for Chai assertions, eslint-plugin-jest is designed specifically for Jest, providing a different set of rules and utilities.
Readme
This plugin overrides no-unused-expressions to make it friendly towards chai expect statements.
// this
expect(foo).to.be.true;
// instead of this
expect(foo).to.be.true; // eslint-disable-line no-unused-expressions
You'll first need to install ESLint:
$ npm i eslint --save-dev
Next, install eslint-plugin-chai-friendly:
$ npm install eslint-plugin-chai-friendly --save-dev
Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-chai-friendly globally.
Add chai-friendly to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
"plugins": [
"chai-friendly"
]
}
Then disable original no-unused-expressions rule and configure chai-friendly replacement under the rules section.
{
"rules": {
"no-unused-expressions": 0,
"chai-friendly/no-unused-expressions": 2
}
}
FAQs
This plugin makes 'no-unused-expressions' rule friendly towards chai expect statements.
We found that eslint-plugin-chai-friendly demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.
Security News
The White House is addressing fragmented cybersecurity regulations as CISOs report spending up to 50% of their time on compliance, aiming to harmonize requirements and improve cybersecurity outcomes.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.