Skip to content

Commit 50fb73c

Browse files
committed
Update eslint-plugin README
1 parent 1a1b7b2 commit 50fb73c

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

eslint-plugin/README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ An ESLint plugin which provides JavaScript rules of the ecoCode project.
77

88
> ⚠️ This plugin is in a very early stage and need improvements. Any contribution will be appreciated.
99
10-
📥 Usage
11-
--------
10+
🚀 Getting started
11+
------------------
1212

1313
### Installation
1414

@@ -44,17 +44,31 @@ Add `@ecocode` to the `plugins` section of your `.eslintrc`, followed by rules c
4444
}
4545
```
4646

47-
Rules
48-
-----
47+
🌿 Use with our SonarQube plugin
48+
--------------------------------
49+
50+
If you are already using ESLint results for your SonarQube analysis, there are no additional steps! Otherwise:
51+
52+
- Use **"-f json"** option of ESLint to export results in a JSON format.\
53+
_example in a script:_ `eslint . -f json -o report.json`
54+
- Add the path of the generated report to SonarQube property **"sonar.eslint.reportPaths"**.\
55+
_example in sonar-project.properties:_ `sonar.eslint.reportPaths=report.json`
56+
57+
Check [SonarQube documentation](https://docs.sonarqube.org/8.9/analyzing-source-code/importing-external-issues/importing-third-party-issues/)
58+
to have more information about the integration.
59+
60+
🔨 Rules
61+
--------
4962

5063
<!-- begin auto-generated rules list -->
5164

5265
⚠️ Configurations set to warn in.\
5366
✅ Set in the `recommended` configuration.
5467

55-
| Name | Description | ⚠️ |
68+
| Name | Description | ⚠️ |
5669
| :----------------------------------------------------------------------------- | :-------------------------------------------- | :- |
57-
| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md) | Disallow multiple access of same DOM element. ||
70+
| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md) | Disallow multiple access of same DOM
71+
element. | ✅ |
5872

5973
<!-- end auto-generated rules list -->
6074

0 commit comments

Comments
 (0)