wixESLint-plugin-wix-editor
Wix's editor group's custom ESLint rules
Installation
Install ESLint and eslint-plugin-wix-editor into your project.
$ npm install --save-dev eslint eslint-plugin-wix-editorConfiguration
Add plugins section and specify eslint-plugin-wix-editor as a plugin into your .eslintrc:
{
"plugins": ["wix-editor"]
}Finally, enable all of the rules that you would like to use:
{
"rules": {
"wix-editor/no-instanceof-array": 2,
"wix-editor/no-not-not": 2,
"wix-editor/no-unneeded-match": 2,
"wix-editor/prefer-filter": 2,
"wix-editor/prefer-ternary": 2,
"wix-editor/return-boolean": 2,
"wix-editor/simplify-boolean-expression": 2
}
}Rules
- no-instanceof-array: Prevent use of function definition inside boolean expression.
- no-not-not: Prevent casting to boolean with
!! - no-unneeded-match: Prevent using
str.match(rgx)as a boolean value. - prefer-filter: Prevent
forEachstatements that only include anifstatement. - prefer-ternary: Prevent use of
if-elsestatements that only include assignment to the same variable. - return-boolean: Prevent use of
if-elsefor returning boolean values. - simplify-boolean-expression: Prevent use of function definition inside boolean expression.
Contributions
Contributions in the form of issues and pull requests are welcome.
Before creating a pull request, please make sure that:
- Each of your commits is needed and makes sense. Squash/rebase as needed.
- Lint and tests pass. Check with
npm test. - Coverage percentage has not dropped.
To begin:
git clone git@github.com:wix/eslint-plugin-wix-editor.git
cd eslint-plugin-wix-editor
npm i
npm testLicense
eslint-plugin-wix-editor is licensed under the MIT License.