sonar dotnet

Qualidade e segurança do código para C# e VB.NET

Produto	Portão de qualidade	Cobertura
Analisador
Plugin

Análise estática de idiomas C# e VB.NET no servidor Sonarqube, Sonarqube Cloud e Sonarqube para obter produtos de qualidade e segurança do código IDE. Esses analisadores de Roslyn permitem produzir código limpo que seja seguro, confiável e sustentável, ajudando você a encontrar e corrigir bugs, vulnerabilidades e cheiros de código na sua base de código.

Características

• 470+ Regras C# e 210+ VB. Regras líquidas
• Métricas (complexidade cognitiva, duplicações, número de linhas, etc.)
• Importação de relatórios de cobertura de teste da cobertura do código do Visual Studio, Dotcover, OpeNcover, Coverlet, AltCover.
• Importação de resultados de analisadores de Roslyn de terceiros
• Suporte para regras personalizadas

Recursos públicos úteis

• Página inicial do projeto
• Rastreamento de problemas
• C# regras
• Regras VB.NET

Pacotes nuget.org

• Sonaranalyzer.csharp
• Sonaranalyzer.visualbasic

Integração com Sonarqube

• Analisar projetos com o SonarScanner para .NET
• Importando cobertura de código
• Sonarqube e a cobertura do código

Você tem uma pergunta ou feedback?

• Entre em contato conosco em nosso fórum da comunidade para fornecer feedback, pedir ajuda e solicitar novas regras ou recursos.
• Crie um problema do GitHub se você encontrou um bug, falso-positivo ou falso-negativo.

Comece

• Construção, teste e depuração do analisador .NET
• Construção, teste e depuração do plugin java
• Como re-generar arquivos de bloqueio de Nuget
• Usando o script RSPEC.PS1

Como contribuir

Existem muitas maneiras de contribuir com o projeto sonar-dotnet . Ao contribuir, respeite nosso código de conduta.

Junte -se às discussões

Uma das maneiras mais fáceis de contribuir é compartilhar seu feedback conosco (consulte Dê feedback) e também responder perguntas do nosso fórum da comunidade. Você também pode monitorar a atividade neste repositório (questões abertas, abertas para os PRs) para se familiarizar com o que fazemos.

Solicitação de tração (PR)

Se você deseja corrigir um problema, leia as páginas de início primeiro e certifique -se de seguir nosso estilo de codificação.

Antes de enviar o PR, verifique se todos os testes estão passando (todos os cheques devem ser verdes).

• Sugerimos que você não escolha problemas com a Area: CFG (eles são difíceis, podem ter muitos efeitos colaterais e têm menos probabilidade de ser aceito) .
• Sugerimos que você não implemente novas regras, a menos que elas já estejam especificadas para C# e/ou vb.net em nosso repositório de regras.

Nota: Nosso IC não é acionado automaticamente nos PRs de colaboradores externos. Um membro da nossa equipe analisará o código e acionará o CI sob demanda, adicionando um comentário sobre o PR (consulte o comentário do Azure Pipelines desencadeia documentos):

• /azp run Sonar.Net - Ele executará o pipeline completo, incluindo testes de plug -in e promoção

Junte-se a nós

Se você gostaria de trabalhar neste projeto em tempo integral, estamos contratando!

Regras personalizadas

Para solicitar novas regras, entre em contato conosco em nosso fórum da comunidade.

Se você tem uma ideia para uma regra, mas não tem certeza de que todos precisam, pode implementar seu próprio analisador de Roslyn.

• Você pode começar com este tutorial da Microsoft para escrever um analisador.
• Todos os problemas baseados em Roslyn são escolhidos pelo SonarScanner para .NET e pressionados a Sonarqube como questões externas.
• Confira também Sonarqube Roslyn SDK para incorporar seu analisador de Roslyn em um plug -in Sonarqube, se você quiser gerenciar suas regras da Sonarqube.

Configurando regras

Sonarqube para IDE

A maneira mais fácil é configurar um perfil de qualidade em Sonarqube.

Abra a regra em Sonarqube, role para baixo e (caso a regra tenha parâmetros), você pode configurar os parâmetros para cada perfil de qualidade da qual a regra faz parte.

Use Sonarqube para o modo conectado IDE para conectar -se ao servidor ou nuvem SONARQUBE.

Nuget independente

As regras dos pacotes autônomos Nuget podem ser ativadas ou desativadas da mesma maneira que os outros analisadores com base em Roslyn, usando os arquivos .globalconfig ou .editorconfig . Veja: https://learn.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022#set-rule-severity-in-an-editorconfig-FIL

Se as regras forem parametrizadas, os valores dos parâmetros poderão ser alterados usando arquivos adicionais SonarLint.xml .

O primeiro passo é criar um novo arquivo, chamado SonarLint.xml , que possui a seguinte estrutura:

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

Em seguida, atualize os projetos para incluir este arquivo adicional:

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

Recursos internos

Construir configuração

• Repositório de imagens VM
• Repositório de provisionamento
• Oleodutos do Azure
• Configuração de Peachee

Questões de segurança

Se você acredita que descobriu uma vulnerabilidade de segurança nos produtos do sonar, verifique este documento

Licença

Copyright 2014-2024 SONARSource.

Licenciado sob a licença de fonte de fonte de sonar v1.0