Awesome Open Source
Awesome Open Source

eslint-plugin-sonarjs npm version Build Status Quality Gate Coverage

SonarJS rules for ESLint to detect bugs and suspicious patterns in your code.

Rules

Bug Detection 🐛

Rules in this category aim to find places in code which have a high chance of being bugs, i.e. don't work as intended.

Code Smell Detection 🐷

Code Smells, or maintainability issues, are raised for places of code which might be costly to change in the future. These rules also help to keep the high code quality and readability. And finally some rules report issues on different suspicious code patters.

Prerequisites

  • Node.js (>=12.x).
  • ESLint 5.x, 6.x, 7.x or 8.x (peer dependency for the plugin).

Usage

  • If you don't have ESLint yet configured for your project, follow these instructions.
  • Install eslint-plugin-sonarjs using npm (or yarn) for you project or globally:
npm install eslint-plugin-sonarjs --save-dev # install for your project
npm install eslint-plugin-sonarjs -g         # or install globally
  • Add eslint-plugin-sonarjs to the plugins option of your .eslintrc:
{
  "plugins": ["sonarjs"]
}
  • Add plugin:sonarjs/recommended to the extends option to enable all recommended rules:
{
  "extends": ["plugin:sonarjs/recommended"]
}
  • or enable only some rules manually:
{
  "rules": {
    "sonarjs/cognitive-complexity": "error",
    "sonarjs/no-identical-expressions": "error"
    // etc.
  }
}
  • To enable all rules of this plugin, use @typescript-eslint/parser as a parser for ESLint (like we do) and set the parserOptions.project option. Thanks to it, type information is available, which is beneficial or even essential for some rules.

Available Configurations

This plugin provides only recommended configuration. Almost all rules are activated in this profile with a few exceptions (check disabled tag in the rules list). recommended configuration activates rules with error severity.

ESLint and Sonar

This plugin exposes to ESLint users a subset of JS/TS rules from Sonar-* products (aka SonarJS). We extracted the rules which are not available in ESLint core or other ESLint plugins to be beneficial for ESLint community.

If you are a SonarQube or SonarCloud user, to lint your code locally, we suggest to use SonarLint 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.

Contributing

You want to participate in the development of the project? Have a look at our contributing guide!

Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,060,209
Typescript (246,626
Linter (9,091
Boolean (8,337
Eslint (8,290
Static Analysis (1,341
Eslint Plugin (667
Code Analysis (568
Language Team (21