An ESLint plugin which provides JavaScript and TypeScript rules of the ecoCode project.

👉 See ecoCode-linter README to have more information.

⚠️ This plugin is in a very early stage and need improvements. Any contribution will be appreciated.

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.

Add @ecocode recommended configuration to extends section of your .eslintrc:

{
  "extends": ["plugin:@ecocode/recommended"]
}

Add @ecocode to the plugins section of your .eslintrc, followed by rules configuration:

{
  "plugins": ["@ecocode"],
  "rules": {
    "@ecocode/no-multiple-access-dom-element": "error"
  }
}

If you are already using ESLint results for your SonarQube analysis, there are no additional steps! Otherwise:

• Use "-f json" option of ESLint to export results in a JSON format.
  example in a script: eslint . -f json -o report.json
• Add the path of the generated report to SonarQube property "sonar.eslint.reportPaths".
  example in sonar-project.properties: sonar.eslint.reportPaths=report.json

Check SonarQube documentation to have more information about the integration.

⚠️ Configurations set to warn in.
✅ Set in the recommended configuration.

You can follow changelog on GitHub Releases page.