Skip to content

Commit

Permalink
improve wording on README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vdiez committed Nov 28, 2024
1 parent 7859912 commit 87fa9e6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/jsts/src/rules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ We include a `recommended-legacy` configuration to be backward compatible with E

## ESLint and Sonar

This plugin exposes to ESLint users all original JS/TS rules from Sonar-\* products (aka [SonarJS](https://github.com/SonarSource/SonarJS)). We extracted the rules to be beneficial for the ESLint community.
This plugin exposes to ESLint users all original JS/TS rules from Sonar products (aka [SonarJS](https://github.com/SonarSource/SonarJS)). We extracted the rules to be beneficial for the ESLint community.

SonarJS contains more rules from other ESLint plugins (listed [here](#sonarjs-additional-rules)). We recommend enabling those rules if you are looking for similar results to SonarQube using ESLint.
This ESLint plugin does not contain all the rules from the SonarQube JS/TS analyzer. Aside of the rules available here, SonarQube uses rules from other ESLint plugins ([some](#eslint-rules) used as they are, [some others](#improved-eslint-rules) have been modified). We recommend installing those ESLint plugins and enabling those rules if you are looking for similar results to SonarQube using ESLint.

If you are a [SonarQube](https://www.sonarqube.org) or [SonarCloud](https://sonarcloud.io) user, to lint your code locally, we suggest using [SonarLint](https://www.sonarlint.org) IDE extension (available for VSCode, JetBrains IDEs and Eclipse). You can connect SonarLint to your SonarQube/SonarCloud project to synchronize rules configuration, issue statuses, etc.

Expand Down Expand Up @@ -480,7 +480,7 @@ The following rules are used directly, without modifying the original behavior:

## Improved ESLint rules

The following rules are used in SonarJS, but their behavior is modified, so your experience using them in your ESLint configuration may differ from the results you may get using SonarQube:
Also not available in this ESLint plugin, but used in SonarJS, this list of rules have been modified, so your experience using them in your ESLint configuration may differ from the results you may get using SonarQube:

<!--- start decorated rules -->

Expand Down

0 comments on commit 87fa9e6

Please sign in to comment.