eslint plugin sonarjs

Ce référentiel a bougé!

Ce référentiel contient eslint-plugin-sonarjs jusqu'à la version ^1.0.0 . Pour les versions >=2.0.0 veuillez accéder au référentiel de l'analyseur Sonarjs. Les nouvelles versions d' eslint-plugin-sonarjs mettent toutes les règles de SonarJS disponibles pour les utilisateurs d'Eslint, au lieu d'un sous-ensemble comme il l'était avec ^1.0.0 vivant ici.

Aucun nouveau changement ne devrait atterrir ici.

Eslint-Plugin-sonarjs

Sonarjs règle Eslint pour aider les développeurs à produire du code propre en détectant des bogues et des modèles suspects.

Règles

Détection de bogues?

Les règles de cette catégorie visent à trouver des endroits dans le code qui ont de grandes chances d'être des bogues, c'est-à-dire ne fonctionnent pas comme prévu.

• Toutes les branches d'une structure conditionnelle ne devraient pas avoir exactement la même implémentation ( no-all-duplicated-branches )
• Les éléments de collecte ne doivent pas être remplacés inconditionnellement ( no-element-overwrite )
• Les collections vides ne doivent pas être accessibles ou itérées ( no-empty-collection )
• Les appels de fonction ne doivent pas passer des arguments supplémentaires ( no-extra-arguments )
• Les déclarations liées à "If / else If" ne devraient pas avoir la même condition ( no-identical-conditions )
• Les expressions identiques ne doivent pas être utilisées des deux côtés d'un opérateur binaire ( no-identical-expressions ))
• Les valeurs de retour des fonctions sans effets secondaires ne doivent pas être ignorées ( no-ignored-return ) ( usages )
• Les boucles avec au plus une itération doit être refactorisée ( no-one-iteration-loop )
• La sortie des fonctions qui ne renvoie rien ne doit pas être utilisée ( no-use-of-empty-return-value )
• Opérateurs inexistants '= +', '= -' et '=!' ne doit pas être utilisé ( non-existent-operator ) (: clé: réparable )

Détection de l'odeur du code?

Les odeurs de code, ou les problèmes de maintenabilité, sont soulevées pour des lieux de code qui pourraient être coûteux à changer à l'avenir. Ces règles contribuent également à maintenir la qualité élevée du code et la lisibilité. Et enfin, certaines règles rapportent des problèmes sur différents modèles de code suspects.

• La complexité cognitive des fonctions ne devrait pas être trop élevée ( cognitive-complexity )
• "Si ... else if" Les constructions devraient se terminer avec des clauses "else" ( elseif-without-else ) ( désactivé )
• Les déclarations "Switch" ne devraient pas avoir trop de clauses "cas" ( max-switch-cases )
• Les instructions «si» pliables doivent être fusionnées ( no-collapsible-if )
• Les tailles de collecte et les comparaisons de longueur de tableau devraient avoir un sens ( no-collection-size-mischeck ) (: Wrench: Réglable , Using-Types )
• Les littéraux de chaîne ne doivent pas être dupliqués ( no-duplicate-string )
• Deux branches d'une structure conditionnelle ne devraient pas avoir exactement la même implémentation ( no-duplicated-branches )
• Les expressions booléennes ne devraient pas être gratuites ( no-gratuitous-expressions )
• Les fonctions ne devraient pas avoir d'implémentations identiques ( no-identical-functions )
• Les chèques booléens ne doivent pas être inversés ( no-inverted-boolean-check ) (: clé: réparable , handicapée )
• Les déclarations "Switch" ne doivent pas être imbriquées ( no-nested-switch )
• Les littéraux des modèles ne doivent pas être imbriqués ( no-nested-template-literals )
• Les littéraux booléens ne devraient pas être redondants ( no-redundant-boolean )
• Les déclarations de saut ne doivent pas être redondantes ( no-redundant-jump ) (: Céreuse: réparable )
• Les conditions doivent démarrer sur de nouvelles lignes ( no-same-line-conditional clin
• Les déclarations "Switch" devraient avoir au moins 3 "cas" Clauses ( no-small-switch )
• La collecte et le contenu de no-unused-collection table
• Les clauses "Catch" devraient faire plus que Rethrow ( no-useless-catch )
• Les variables locales ne doivent pas être déclarées puis immédiatement retournées ou jetées ( prefer-immediate-return ) (: Wrench: Fixable )
• La syntaxe littérale d'objet doit être utilisée ( prefer-object-literal )
• Le retour des expressions booléennes ne doit pas être enveloppé dans une déclaration "if-then-else" ( prefer-single-boolean-return ) (: Wrench: Fixable )
• Une boucle "while" doit être utilisée à la place d'une boucle "pour" ( prefer-while ) (: Wrench: Réglable )

Condition préalable

• Node.js (> = 16.x).
• Eslint 8.x ou 9.x (dépendance des pairs pour le plugin).

Usage

• Si vous n'avez pas encore Eslint pour votre projet, suivez ces instructions.
• Installez eslint-plugin-sonarjs à l'aide de npm (ou yarn ) pour votre projet ou dans le monde:

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

• Ajoutez eslint-plugin-sonarjs aux plugins de votre configuration Eslint.

Pour Eslint 9: Ajoutez une option plugins à votre eslint.config.js et incluez la configuration recommandée pour activer toutes les règles:

 import sonarjs from "eslint-plugin-sonarjs";

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

Pour Eslint 8: Ajoutez une option plugins à votre .eslintrc et plugin:sonarjs/recommended-legacy à l'option extends pour activer toutes les règles recommandées:

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

• ou n'atteignez que certaines règles manuellement:

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

• Pour permettre à chacune des règles de fonctionner pleinement, utilisez @typescript-eslint/parser comme analyseur pour Eslint (comme nous le faisons) et définissez l'option parseroptions.project. Grâce à cela, des informations de type sont disponibles, ce qui est bénéfique ou même essentiel pour certaines règles.

Configurations disponibles

Ce plugin ne fournit qu'une configuration recommended . Presque toutes les règles sont activées dans ce profil à quelques exceptions près (consultez la balise disabled dans la liste des règles). La configuration recommended active les règles avec la gravité error . Nous incluons une configuration recommended-legacy pour être en arrière compatible avec Eslint V8, avec la même configuration de règle.

Eslint et sonar

Ce plugin expose aux utilisateurs Eslint un sous-ensemble de règles JS / TS à partir de produits Sonar- * (aka Sonarjs). Nous avons extrait les règles qui ne sont pas disponibles dans Eslint Core ou d'autres plugins Eslint sont bénéfiques pour la communauté Eslint.

Si vous êtes un utilisateur Sonarqube ou SonarCloud, pour pelucher votre code localement, nous vous suggérons d'utiliser l'extension de sonarlint IDE (disponible pour VScode, JetBrains IDE et Eclipse). Vous pouvez connecter sonarlint à votre projet Sonarqube / SonarCloud pour synchroniser la configuration des règles, les statuts de problème, etc.

Contributif

Voulez-vous participer au développement du projet? Jetez un œil à notre guide de contribution!