@ecocode/eslint-plugin v1.5.0
An ESLint plugin which provides JavaScript and TypeScript rules of the ecoCode project.
š See ecoCode-javascript README to have more information.
ā ļø This plugin is in a very early stage and need improvements. Any contribution will be appreciated.
š Getting started
Installation
You'll need to install ESLint (v7 or newer) and this plugin:
# yarn
yarn add -D eslint @ecocode/eslint-plugin
# npm
npm install -D eslint @ecocode/eslint-pluginYou are using TypeScript? You will also need to install typescript-eslint to enable our rules.\ Follow this official guide to install it in a few steps.
Are you working with a GitHub Packages registry?
The plugin is also available from GitHub npm registry under "green-code-initiative" scope:
# yarn
yarn add -D eslint @green-code-initiative/ecocode-eslint-plugin
# npm
npm install -D eslint @green-code-initiative/ecocode-eslint-pluginEnable whole plugin
Add @ecocode recommended configuration to extends section of your .eslintrc:
{
"extends": ["plugin:@ecocode/recommended"]
}Enable only some rules
Add @ecocode to the plugins section of your .eslintrc, followed by rules configuration:
{
"plugins": ["@ecocode"],
"rules": {
"@ecocode/no-multiple-access-dom-element": "error"
}
}šØ Rules
ā ļø Configurations set to warn in.\
ā
Set in the recommended configuration.
| Name | Description | ā ļø |
|---|---|---|
| avoid-css-animations | Avoid usage of CSS animations | ā |
| avoid-high-accuracy-geolocation | Avoid using high accuracy geolocation in web applications. | ā |
| limit-db-query-results | Should limit the number of returns for a SQL query | ā |
| no-empty-image-src-attribute | Disallow usage of image with empty source attribute | ā |
| no-import-all-from-library | Should not import all from library | ā |
| no-multiple-access-dom-element | Disallow multiple access of same DOM element. | ā |
| no-multiple-style-changes | Disallow multiple style changes at once. | ā |
| prefer-collections-with-pagination | Prefer API collections with pagination. | ā |
| prefer-shorthand-css-notations | Encourage usage of shorthand CSS notations | ā |
| provide-print-css | Enforce providing a print stylesheet | ā |
š Distribution
You can follow changelog on GitHub Releases page.