sonar dotnet

Qualité et sécurité du code pour C # et VB.NET

Produit	Porte de qualité	Couverture
Analyseur
Plugin

Analyse statique des langages C # et VB.NET dans le serveur Sonarqube, sonarqube Cloud et SonarQube pour les produits de qualité et de sécurité IDE. Ces analyseurs Roslyn vous permettent de produire du code propre qui est sûr, fiable et maintenu en vous aidant à trouver et à corriger les bogues, les vulnérabilités et les odeurs de code dans votre base de code.

Caractéristiques

• 470+ règles C # et 210+ VB. Règles nettes
• Métriques (complexité cognitive, duplications, nombre de lignes, etc.)
• Importation de rapports de couverture de test à partir de la couverture du code Visual Studio, dotcover, opencover, couverture, altcover.
• Importation des résultats des analyseurs de Roslyn tiers
• Prise en charge des règles personnalisées

Ressources publiques utiles

• Page d'accueil du projet
• Suivi des problèmes
• C # Règles
• Règles VB.NET

Packages Nuget.org

• Sonaranalyzer.csharp
• Sonaranalyzer.VisualBasic

Intégration avec sonarqube

• Analyser les projets avec sonarscanner pour .NET
• Couverture de code d'importation
• Sonarqube et la couverture du code

Avez-vous une question ou des commentaires?

• Contactez-nous sur notre forum communautaire pour fournir des commentaires, demander de l'aide et demander de nouvelles règles ou fonctionnalités.
• Créez un problème GitHub si vous avez trouvé un bogue, faux positif ou faux négatif.

Commencer

• Construire, tester et déboguer l'analyseur .NET
• Construire, tester et déboguer le plugin Java
• Comment générer les fichiers de verrouillage Nuget
• Utilisation du script RSpec.PS1

Comment contribuer

Il existe de nombreuses façons de contribuer au projet sonar-dotnet . Lors de la contribution, veuillez respecter notre code de conduite.

Rejoignez les discussions

L'un des moyens les plus simples de contribuer est de partager vos commentaires avec nous (voir donner des commentaires) et également répondre aux questions de notre forum communautaire. Vous pouvez également surveiller l'activité sur ce référentiel (problèmes ouverts, ouverts PR) pour se familiariser avec ce que nous faisons.

Priser la demande (PR)

Si vous souhaitez résoudre un problème, veuillez d'abord lire les pages de démarrage et assurer que vous suivez notre style de codage.

Avant de soumettre le PR, assurez-vous que tous les tests passent (toutes les vérifications doivent être vertes).

• Nous vous suggérons de ne pas choisir les problèmes avec l'étiquette de la Area: CFG (ils sont difficiles, peuvent avoir de nombreux effets secondaires et sont moins susceptibles d'être acceptés) .
• Nous vous suggérons de ne pas implémenter de nouvelles règles, sauf si elles sont déjà spécifiées pour C # et / ou VB.NET sur notre référentiel de règles.

Remarque: Notre IC n'est pas automatiquement déclenché sur le PRS à partir de contributeurs externes. Un membre de notre équipe examinera le code et déclenchera le CI à la demande en ajoutant un commentaire sur le PR (voir Azure Pipelines Le commentaire déclenche des documents):

• /azp run Sonar.Net - Il exécutera le pipeline complet, y compris les tests de plugin et la promotion

Se joindre à nous

Si vous souhaitez travailler sur ce projet à temps plein, nous embauchons!

Règles personnalisées

Pour demander de nouvelles règles, contactez-nous sur notre forum communautaire.

Si vous avez une idée pour une règle mais que vous n'êtes pas sûr que tout le monde en a besoin, vous pouvez implémenter votre propre analyseur Roslyn.

• Vous pouvez commencer par ce tutoriel de Microsoft pour écrire un analyseur.
• Tous les problèmes basés sur Roslyn sont repris par le Sonarscanner pour .NET et poussés à Sonarqube en tant que problèmes externes.
• Consultez également le SDK de Sonarqube Roslyn pour intégrer votre analyseur Roslyn dans un plugin Sonarqube, si vous souhaitez gérer vos règles de Sonarqube.

Configuration des règles

Sonarqube pour IDE

Le moyen le plus simple est de configurer un profil de qualité dans Sonarqube.

Ouvrez la règle dans Sonarqube, faites défiler vers le bas et (dans le cas où la règle a des paramètres), vous pouvez configurer les paramètres de chaque profil de qualité dont la règle fait partie.

Utilisez sonarqube pour le mode connecté IDE pour se connecter au serveur ou au cloud SonarQube.

Nuget autonome

Les règles des packages NuGet autonomes peuvent être activées ou désactivées de la même manière que les autres analyseurs basés sur Roslyn, en utilisant les fichiers .globalconfig ou .editorconfig . Voir: https://learn.microsoft.com/en-us/visualstudio/code-quality/use-poslyn-analyzers?view=vs-2022#set-meverity-in-an-anditorconfig-file

Si les règles sont paramétrées, les valeurs des paramètres peuvent être modifiées à l'aide de fichiers supplémentaires SonarLint.xml .

La première étape consiste à créer un nouveau fichier, nommé SonarLint.xml , qui a la structure suivante:

<? 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 >

Ensuite, mettez à jour les projets pour inclure ce fichier supplémentaire:

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

Ressources internes

Configuration de la construction

• Référentiel d'images VM
• Référentiel d'approvisionnement
• Pipelines azure
• Configuration des pêches

Problèmes de sécurité

Si vous pensez que vous avez découvert une vulnérabilité de sécurité dans les produits de Sonar, veuillez consulter ce document

Licence

Copyright 2014-2024 Sonarsource.

Licencié sous la licence disponible sur la source sonar v1.0