sonar dotnet

Calidad y seguridad del código para C# y VB.NET

Producto	Puerta de calidad	Cobertura
Analizador
Complemento

Análisis estático de lenguajes C# y VB.NET en servidor Sonarqube, Sonarqube Cloud y Sonarqube para productos de seguridad y calidad del código IDE. Estos analizadores de Roslyn le permiten producir un código limpio que sea seguro, confiable y mantenible al ayudarlo a encontrar y corregir errores, vulnerabilidades y olores de código en su base de código.

Características

• 470+ reglas de C# y 210+ VB. Reglas netas
• Métricas (complejidad cognitiva, duplicaciones, número de líneas, etc.)
• Importación de informes de cobertura de prueba de la cobertura del código de Visual Studio, DotCover, OpenCover, COPTTTLET, Altcover.
• Importación de resultados de analizadores de Roslyn de terceros
• Soporte para reglas personalizadas

Recursos públicos útiles

• Página de inicio del proyecto
• Seguimiento de emisión
• Reglas de C#
• Reglas VB.NET

Paquetes nuget.org

• Sonaranalyzer.csharp
• Sonaranalyzer.

Integración con Sonarqube

• Analizar proyectos con sonarscanner para .net
• Importación de la cobertura del código
• Sonarqube y la cobertura del código

¿Tiene alguna pregunta o comentarios?

• Contáctenos en nuestro foro de la comunidad para proporcionar comentarios, solicitar ayuda y solicitar nuevas reglas o características.
• Cree un problema de GitHub si ha encontrado un error, falso positivo o falso negativo.

Empezar

• Construir, probar y depurar el analizador .net
• Construir, probar y depurar el complemento Java
• Cómo reinterpretar archivos de bloqueo Nuget
• Usando el script rspec.ps1

Cómo contribuir

Hay muchas maneras en que puede contribuir al proyecto sonar-dotnet . Al contribuir, respete nuestro código de conducta.

Únete a las discusiones

Una de las formas más fáciles de contribuir es compartir sus comentarios con nosotros (ver Give Del Comentarios) y también responder preguntas de nuestro foro de la comunidad. También puede monitorear la actividad en este repositorio (problemas abiertos, PRS abiertos) para familiarizarse más con lo que hacemos.

Solicitud de extracción (PR)

Si desea solucionar un problema, lea primero las páginas de inicio y asegúrese de seguir nuestro estilo de codificación.

Antes de enviar el PR, asegúrese de que todas las pruebas pasen (todas las verificaciones deben ser verdes).

• Le sugerimos que no elija problemas con el Area: CFG (son difíciles, pueden tener muchos efectos secundarios y es menos probable que sean aceptados) .
• Sugerimos que no implementa nuevas reglas a menos que ya estén especificadas para C# y/o VB.NET en nuestro repositorio de reglas.

Nota: Nuestro CI no se activa automáticamente en el PRS de los contribuyentes externos. Un miembro de nuestro equipo revisará el código y activará el CI a pedido agregando un comentario sobre el PR (ver documentos de comentario de Azure Pipelines Agaguros):

• /azp run Sonar.Net : ejecutará la tubería completa, incluidas las pruebas de complemento y la promoción

Unirse a nosotros

Si desea trabajar en este proyecto a tiempo completo, ¡estamos contratando!

Reglas personalizadas

Para solicitar nuevas reglas, contáctenos en nuestro foro de la comunidad.

Si tiene una idea para una regla, pero no está seguro de que todos la necesiten, puede implementar su propio analizador de Roslyn.

• Puede comenzar con este tutorial de Microsoft para escribir un analizador.
• Todos los problemas basados ​​en Roslyn son recogidos por Sonarscanner para .NET y presionados a Sonarqube como problemas externos.
• También consulte Sonarqube Roslyn SDK para incrustar su analizador de Roslyn en un complemento Sonarqube, si desea administrar sus reglas de Sonarqube.

Configuración de reglas

Sonarqube para ide

La forma más fácil es configurar un perfil de calidad en Sonarqube.

Abra la regla en Sonarqube, desplácese hacia abajo y (en caso de que la regla tenga parámetros), puede configurar los parámetros para cada perfil de calidad de los que es parte.

Use el modo Sonarqube para IDE Connected para conectarse al servidor o nube Sonarqube.

Nuget independiente

Las reglas de los paquetes NUGET independientes se pueden habilitar o deshabilitar de la misma manera que los otros analizadores basados ​​en Roslyn, utilizando los archivos .globalconfig o .editorconfig . Ver: https://learn.microsoft.com/en-us/visualstudio/code-Qaity/use-roslyn-analyzers?view=vs-2022#set-rule-severity-in-an-editorconfig-file

Si las reglas se parametrizan, los valores de los parámetros se pueden cambiar usando archivos adicionales SonarLint.xml .

El primer paso es crear un nuevo archivo, llamado SonarLint.xml , que tiene la siguiente estructura:

<? xml version = " 1.0 " encoding = " utf-8 " ?>
< AnalysisInput xmlns : xsd = " http://www.w3.org/2001/XMLSchema " xmlns : xsi = " http://www.w3.org/2001/XMLSchema-instance " >
  < Settings >
    < Setting >
      < Key >sonar.cs.analyzeGeneratedCode</ Key >
      < Value >false</ Value >
    </ Setting >
  </ Settings >
  < Rules >
    < Rule >
      < Key >S107</ Key >
      < Parameters >
        < Parameter >
          < Key >max</ Key >
          < Value >2</ Value >
        </ Parameter >
      </ Parameters >
    </ Rule >
  </ Rules >
</ AnalysisInput >

Luego, actualice los proyectos para incluir este archivo adicional:

< ItemGroup >
  < AdditionalFiles Include = " SonarLint.xml " />
</ ItemGroup >

Recursos internos

Configuración de compilación

• Repositorio de imágenes de VM
• Repositorio de aprovisionamiento
• Tuberías azules
• Configuración de Peachee

Problemas de seguridad

Si cree que ha descubierto una vulnerabilidad de seguridad en los productos de Sonar, consulte este documento

Licencia

Copyright 2014-2024 Sonarsource.

Licencia bajo la licencia disponible de la fuente V1.0