eslint plugin sonarjs

Dieses Repository hat sich bewegt!

Dieses Repository enthält eslint-plugin-sonarjs bis zu Version ^1.0.0 . Für Versionen >=2.0.0 gehen Sie bitte zum Repository des Sonarjs -Analysators. Die neuen Versionen von eslint-plugin-sonarjs stellen alle Sonarjs-Regeln für Eslint-Benutzer zur Verfügung, anstatt wie bei ^1.0.0 , die hier leben.

Es werden keine neuen Änderungen erwartet, die hier landen.

Eslint-Plugin-Sonarjs

Sonarjs Regeln für Eslint, um Entwicklern dabei zu helfen, sauberen Code zu erstellen, indem er Fehler und verdächtige Muster erfasst.

Regeln

Fehlererkennung?

Regeln in dieser Kategorie zielen darauf ab, Orte in Code zu finden, die eine hohe Chance haben, Fehler zu sein, dh nicht wie beabsichtigt.

• Alle Zweige in einer bedingten Struktur sollten nicht genau die gleiche Implementierung aufweisen ( no-all-duplicated-branches )
• Sammlungselemente sollten nicht bedingungslos ersetzt werden ( no-element-overwrite )
• Leere Kollektionen sollten nicht zugegriffen oder iteriert werden ( no-empty-collection )
• Funktionsaufrufe sollten keine zusätzlichen Argumente übergeben ( no-extra-arguments )
• Verwandte "if/else if" -Anweisungen dürfen nicht die gleiche Bedingung haben ( no-identical-conditions )
• Identische Ausdrücke sollten nicht auf beiden Seiten eines binären Operators ( no-identical-expressions ) verwendet werden
• Rückgabewerte aus Funktionen ohne Nebenwirkungen sollten nicht ignoriert werden ( no-ignored-return ) ( Nutzungstypen )
• Schleifen mit höchstens eine Iteration sollten neu gestaltet werden ( no-one-iteration-loop )
• Die Ausgabe von Funktionen, die nichts zurückgeben, sollte nicht verwendet werden ( no-use-of-empty-return-value )
• Nicht existierende Operatoren '=+', '=-' und '=!' Sollte nicht verwendet werden ( non-existent-operator ) (: Schraubenschlüssel: fixierbar )

Code -Geruchserkennung?

Code -Gerüche oder Probleme mit der Wartbarkeit werden für Codeorte aufgeworfen, die sich in Zukunft kostspielig ändern können. Diese Regeln tragen auch dazu bei, die hohe Codequalität und Lesbarkeit zu erhalten. Und schließlich melden einige Regeln Probleme zu verschiedenen verdächtigen Codemustern.

• Die kognitive Komplexität von Funktionen sollte nicht zu hoch sein ( cognitive-complexity )
• "Wenn ... sonst", sollten Konstrukte mit "else" -Anklauseln ( elseif-without-else ) enden ( deaktiviert )
• "Switch" -Anweisungen sollten nicht zu viele "Fall" Klauseln ( max-switch-cases ) haben
• Zusammenklappbar "Wenn" Aussagen verschmolzen werden ( no-collapsible-if )
• Sammlungsgrößen und Arraylängenvergleiche sollten sinnvoll sein ( no-collection-size-mischeck ) (: Schraubenschlüssel: Fixierbar , Verwendungstypen )
• String-Literale sollten nicht dupliziert werden ( no-duplicate-string )
• Zwei Zweige in einer bedingten Struktur sollten nicht genau die gleiche Implementierung aufweisen ( no-duplicated-branches )
• Boolesche Ausdrücke sollten nicht unentgeltlich sein ( no-gratuitous-expressions )
• Funktionen sollten keine identischen Implementierungen haben ( no-identical-functions )
• Boolesche Schecks sollten nicht umgekehrt sein ( no-inverted-boolean-check ) (: WNECHEN: FEELTE , BEHANDLIGT )
• "Switch" -Anweisungen sollten nicht verschachtelt sein ( no-nested-switch )
• Vorlagenliterale sollten nicht verschachtelt sein ( no-nested-template-literals )
• Boolesche Literale sollten nicht überflüssig sein ( no-redundant-boolean )
• Sprunganweisungen sollten nicht überflüssig sein ( no-redundant-jump ) (: wlarch: fixable )
• Bedingungen sollten in neuen Zeilen beginnen ( no-same-line-conditional ) (: WNECHEN: Fixierbar )
• "Switch" -Anweisungen sollten mindestens 3 "Fall" -Anklauseln ( no-small-switch ) haben.
• Inhalts- und Array-Inhalte sollten verwendet werden ( no-unused-collection )
• "Catch" -Klauseln sollten mehr als Rethrow ( no-useless-catch ) tun
• Lokale Variablen sollten nicht deklariert und dann sofort zurückgegeben oder geworfen werden ( prefer-immediate-return ) (: WNECHENCH: Fixierbar )
• Objektliterales Syntax sollte verwendet werden ( prefer-object-literal )
• Die Rückgabe von Booleschen Ausdrücken sollte nicht in eine "if-then-else" -Antage ( prefer-single-boolean-return ) eingewickelt werden (: WRECHEN: Fixierbar )
• Eine "während" -Sloop sollte anstelle einer "für" -Sloop verwendet werden ( prefer-while ) (: wrwch: fixable )

Voraussetzungen

• Node.js (> = 16.x).
• Eslint 8.x oder 9.x (Peer -Abhängigkeit für das Plugin).

Verwendung

• Wenn Sie für Ihr Projekt noch nicht konfiguriert sind, befolgen Sie diese Anweisungen.
• Installieren Sie eslint-plugin-sonarjs mit npm (oder yarn ) für Ihr Projekt oder global:

npm install eslint-plugin-sonarjs --save-dev # install for your project
npm install eslint-plugin-sonarjs -g         # or install globally

• Fügen Sie den Plugins Ihrer Eslint-Konfiguration eslint-plugin-sonarjs hinzu.

Für Eslint 9: Fügen Sie Ihre Option plugins zu Ihrem eslint.config.js hinzu und fügen Sie die empfohlene Konfiguration hinzu, um alle Regeln zu aktivieren:

 import sonarjs from "eslint-plugin-sonarjs";

[
  sonarjs.configs.recommended,
  {
    "plugins": {
      sonarjs,
    }
  }
]

Für Eslint 8: Fügen plugins Ihrer .eslintrc und plugin:sonarjs/recommended-legacy zur Option extends , um alle empfohlenen Regeln zu aktivieren:

{
  "plugins" : [ " sonarjs " ],
  "extends" : [ " plugin:sonarjs/recommended-legacy " ]
}

• oder nur einige Regeln manuell aktivieren:

{
  "rules" : {
    "sonarjs/cognitive-complexity" : " error " ,
    "sonarjs/no-identical-expressions" : " error "
    // etc.
  }
}

• Verwenden Sie @typescript-eslint/parser als Parser für Eslint (wie wir) und setzen Sie die Option Parseroptions.Project. Dank dessen sind Typinformationen verfügbar, was für einige Regeln vorteilhaft oder sogar unerlässlich ist.

Verfügbare Konfigurationen

Dieses Plugin bietet nur eine recommended Konfiguration. Fast alle Regeln werden in diesem Profil mit wenigen Ausnahmen aktiviert (überprüfen Sie das disabled Tag in der Liste der Regeln). Die recommended Konfiguration aktiviert Regeln mit error . Wir fügen eine Konfiguration recommended-legacy hinzu, die mit ESLINT V8 mit derselben Regelkonfiguration rückwärts kompatibel ist.

Eslint und Sonar

Dieses Plugin zeigt ESlint-Benutzer eine Untergruppe von JS/TS-Regeln aus Sonar-* -Produkten (auch bekannt als Sonarjs) aus. Wir haben die Regeln extrahiert, die in Eslint Core oder anderen Eslint -Plugins nicht verfügbar sind, um für die Eslint -Community von Vorteil zu sein.

Wenn Sie ein Sonarqube- oder Sonarcloud -Benutzer sind, um Ihren Code lokal abzugeben, empfehlen wir die Verwendung von SonarLint IDE -Erweiterung (verfügbar für VSCODE, JetBrains IDES und Eclipse). Sie können SonarLint mit Ihrem Sonarqube/Sonarcloud -Projekt verbinden, um die Konfiguration der Regeln, den Problemstatus usw. zu synchronisieren.

Beitragen

Möchten Sie an der Entwicklung des Projekts teilnehmen? Schauen Sie sich unseren beitragenden Leitfaden an!