Skip to content

ecocode-eslint-plugin 1.5.0

Install from the command line:
Learn more about npm packages
$ npm install @green-code-initiative/ecocode-eslint-plugin@1.5.0
Install via package.json:
"@green-code-initiative/ecocode-eslint-plugin": "1.5.0"

About this version

Logo

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-plugin

You 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-plugin

Enable 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.

Details

Assets

  • ecocode-eslint-plugin-1.5.0.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all