eslint plugin sonarjs

¡Este repositorio se ha movido!

Este repositorio contiene eslint-plugin-sonarjs hasta la versión ^1.0.0 . Para versiones >=2.0.0 vaya al repositorio del analizador SONARJS. Las nuevas versiones de eslint-plugin-sonarjs hacen que todas las reglas de Sonarjs estén disponibles para los usuarios de Eslint, en lugar de un subconjunto como estaba con ^1.0.0 viviendo aquí.

No se espera que nuevos cambios aterricen aquí.

Eslint-Plugin-Sonarjs

SONARJS Reglas para Eslint para ayudar a los desarrolladores a producir código limpio al detectar errores y patrones sospechosos.

Normas

¿Detección de errores?

Las reglas en esta categoría tienen como objetivo encontrar lugares en código que tengan una alta probabilidad de ser errores, es decir, no funcionan según lo previsto.

• Todas las ramas en una estructura condicional no deben tener exactamente la misma implementación ( no-all-duplicated-branches )
• Los elementos de recolección no deben ser reemplazados incondicionalmente ( no-element-overwrite )
• No se deben acceder ni iterarse las colecciones vacías ( no-empty-collection )
• Las llamadas de la función no deben aprobar argumentos adicionales ( no-extra-arguments )
• Las declaraciones relacionadas "if/else si" no deberían tener la misma condición ( no-identical-conditions )
• Las expresiones idénticas no deben usarse en ambos lados de un operador binario ( no-identical-expressions )
• Los valores de retorno de las funciones sin efectos secundarios no deben ignorarse ( no-ignored-return ) ( usos tipos )
• Los bucles con como máximo una iteración deben refactorizarse ( no-one-iteration-loop )
• El resultado de las funciones que no devuelve nada no debe usarse ( no-use-of-empty-return-value )
• Operadores inexistentes '=+', '=-' y '=!' no debe usarse ( non-existent-operator ) (: llave de llave: fijable )

¿Detección de olor a código?

Los olores de código, o problemas de mantenimiento, se plantean para lugares de código que podrían ser costosos de cambiar en el futuro. Estas reglas también ayudan a mantener la alta calidad y legibilidad del código. Y finalmente, algunas reglas informan cuestiones sobre diferentes patrones de código sospechoso.

• La complejidad cognitiva de las funciones no debe ser demasiado alta ( cognitive-complexity )
• "Si ... más si" las construcciones deberían terminar con las cláusulas "más" ( elseif-without-else ) ( deshabilitado )
• Las declaraciones de "cambiar" no deberían tener demasiadas cláusulas de "caso" ( max-switch-cases )
• Las declaraciones "si" plegables deben fusionarse ( no-collapsible-if )
• Los tamaños de colección y las comparaciones de longitud de matriz deberían tener sentido ( no-collection-size-mischeck ) (: Wrench: fijable , tipos de usos )
• Los literales de cadena no deben duplicarse ( no-duplicate-string )
• Dos ramas en una estructura condicional no deben tener exactamente la misma implementación ( no-duplicated-branches )
• Las expresiones booleanas no deben ser gratuitas ( no-gratuitous-expressions )
• Las funciones no deben tener implementaciones idénticas ( no-identical-functions )
• Los cheques booleanos no deben invertirse ( no-inverted-boolean-check ) (: llave: fijable , deshabilitado )
• Las declaraciones de "cambiar" no deben estar anidadas ( no-nested-switch )
• Los literales de la plantilla no deben estar anidados ( no-nested-template-literals )
• Los literales booleanos no deben ser redundantes ( no-redundant-boolean )
• Las declaraciones de salto no deben ser redundantes ( no-redundant-jump ) (: llave: fijable )
• Los condicionales deben comenzar en nuevas líneas ( no-same-line-conditional ) (: Wrench: Fixable )
• Las declaraciones de "cambiar" deben tener al menos 3 cláusulas de "caso" ( no-small-switch
• Se deben utilizar el contenido de la colección y la matriz ( no-unused-collection )
• Las cláusulas "capturar" deberían hacer más que Rethrow ( no-useless-catch )
• Las variables locales no deben declararse y luego devolver o arrojar inmediatamente ( prefer-immediate-return ) (: llave de llave: fijable )
• Se debe utilizar la sintaxis literal de los objetos ( prefer-object-literal )
• El retorno de las expresiones booleanas no debe envolverse en una declaración "if-then-else" ( prefer-single-boolean-return ) (: llave: fijable )
• Se debe usar un bucle "while" en lugar de un bucle "para" ( prefer-while ) (: llave: fijable )

Requisitos previos

• Node.js (> = 16.x).
• Eslint 8.x o 9.x (dependencia de pares para el complemento).

Uso

• Si aún no tiene ESLint configurado para su proyecto, siga estas instrucciones.
• Instale eslint-plugin-sonarjs usando npm (o yarn ) para su proyecto o a nivel mundial:

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

• Agregue eslint-plugin-sonarjs a los complementos de su configuración de Eslint.

Para Eslint 9: Agregue la opción plugins a su eslint.config.js e incluya la configuración recomendada para habilitar todas las reglas:

 import sonarjs from "eslint-plugin-sonarjs";

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

Para Eslint 8: Agregue la opción plugins a su .eslintrc y plugin:sonarjs/recommended-legacy a la opción extends para habilitar todas las reglas recomendadas:

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

• o habilitar solo algunas reglas manualmente:

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

• Para permitir que cada una de las reglas se desempeñe completamente, use @typescript-eslint/parser como analizador para Eslint (como lo hacemos) y establezca la opción parseroptions.project. Gracias a él, la información de tipo está disponible, que es beneficiosa o incluso esencial para algunas reglas.

Configuraciones disponibles

Este complemento proporciona solo una configuración recommended . Casi todas las reglas se activan en este perfil con algunas excepciones (verifique la etiqueta disabled en la lista de reglas). La configuración recommended activa reglas con gravedad error . Incluimos una configuración recommended-legacy para ser compatible con Backward con Eslint V8, con la misma configuración de reglas.

Eslint y sonar

Este complemento expone a los usuarios de Eslint un subconjunto de reglas JS/TS de productos sonar-* (también conocido como Sonarjs). Extrajimos las reglas que no están disponibles en el núcleo de Eslint u otros complementos de Eslint para ser beneficiosos para la comunidad de Eslint.

Si usted es un usuario de Sonarqube o Sonarcloud, para vincular su código localmente, sugerimos usar la extensión IDE de Sonarlint (disponible para VScode, JetBrains IDES y Eclipse). Puede conectar Sonarlint a su proyecto Sonarqube/Sonarcloud para sincronizar la configuración de reglas, estados de emisión, etc.

Que contribuye

¿Quieres participar en el desarrollo del proyecto? ¡Echa un vistazo a nuestra guía contribuyente!