sonar dotnet

Качество кода и безопасность для C# и VB.net

Продукт	Качественные ворота	Покрытие
Анализатор
Плагин

Статический анализ языков C# и VB.NET на сервере Sonarqube, Sonarqube Cloud и Sonarqube для качества кода IDE и продуктов безопасности. Эти анализаторы Roslyn позволяют вам производить чистый код, который является безопасным, надежным и подлежащим обслуживанию, помогая вам найти и исправить ошибки, уязвимости и запахи кода в вашей кодовой базе.

Функции

• 470+ C# Правила и 210+ VB. Чистые правила
• Метрики (когнитивная сложность, дубликации, количество линий и т. Д.)
• Импорт отчетов о покрытии тестового покрытия из покрытия кода Visual Studio, DotCover, OpenCover, Coverlet, AltCover.
• Импорт сторонних анализаторов Рослин
• Поддержка пользовательских правил

Полезные государственные ресурсы

• Домашняя страница проекта
• Отслеживание выпуска
• C# правила
• VB.NET Правила

Nuget.org Пакеты

• Sonaranalyzer.csharp
• Sonaranalyzer.visualBasic

Интеграция с Sonarqube

• Анализировать проекты с SonarsCanner для .NET
• Импорт покрытия кода
• Sonarqube и покрытие кода

У вас есть вопрос или обратная связь?

• Свяжитесь с нами на нашем форуме сообщества, чтобы предоставить обратную связь, попросить о помощи и запросить новые правила или функции.
• Создайте проблему GitHub, если вы нашли ошибку, ложную позитивную или негативную.

Начните

• Создание, тестирование и отладка .NET Analyzer
• Строительство, тестирование и отладка плагина Java
• Как переиграть файлы блокировки Nuget
• Использование сценария rspec.ps1

Как внести свой вклад

Есть много способов внести свой вклад в проект sonar-dotnet . При вклад, пожалуйста, уважайте наш кодекс поведения.

Присоединяйтесь к дискуссиям

Один из самых простых способов внести свой вклад - поделиться с нами своими отзывами (см. Отзыв), а также ответить на вопросы нашего форума сообщества. Вы также можете отслеживать деятельность в этом репозитории (открытые проблемы, открытые PRS), чтобы быть более знакомым с тем, что мы делаем.

Запрос на вытягивание (PR)

Если вы хотите решить проблему, сначала прочитайте страницы для начала работы и убедитесь, что вы следуете нашему стилю кодирования.

Перед отправкой PR убедитесь, что все тесты проходят (все чеки должны быть зелеными).

• Мы предлагаем вам не выбирать проблемы с Area: CFG (они сложны, могут иметь много побочных эффектов и с меньшей вероятностью будут приняты) .
• Мы предлагаем вам не реализовать новые правила, если они уже не указаны для C# и/или VB.NET в нашем репозитории правил.

Примечание. Наш CI не запускается автоматически на PRS от внешних участников. Член нашей команды рассмотрит код и запустит CI по требованию, добавив комментарий к PR (см. Azure Pipelines Triggers Triggers Docs):

• /azp run Sonar.Net - он запустит полный трубопровод, включая тесты плагина и продвижение по службе

Присоединяйтесь к нам

Если вы хотите поработать над этим проектом на полный рабочий день, мы нанимаем!

Пользовательские правила

Чтобы запросить новые правила, свяжитесь с нами на нашем форуме сообщества.

Если у вас есть идея для правила, но вы не уверены, что каждому это нужно, вы можете реализовать свой собственный анализатор Roslyn.

• Вы можете начать с этого урока от Microsoft, чтобы написать анализатор.
• Все проблемы, основанные на Рослине, поднимаются SonarsCanner для .NET и выдвигаются в Sonarqube в качестве внешних проблем.
• Также ознакомьтесь с Sonarqube Roslyn SDK, чтобы встроить свой Analyzer Roslyn в плагин Sonarqube, если вы хотите управлять своими правилами от Sonarqube.

Настройка правил

Sonarqube для IDE

Самый простой способ - настройка профиля качества в Sonarqube.

Откройте правило в Sonarqube, прокрутите вниз и (в случае, если правило имеет параметры), вы можете настроить параметры для каждого профиля качества, частью которого является правило.

Используйте Sonarqube для подключенного режима IDE, чтобы подключиться к серверу Sonarqube или Cloud.

Автономный Nuget

Правила из автономных пакетов Nuget могут быть включены или отключены так же, как и другие анализаторы, основанные на Рослине, с помощью файлов .globalconfig или .editorconfig . См.: Https://learn.microsoft.com/en-us/visualstudio/code-tability/use-roslyn-analyzers?view=vs-2022#set-rule-severity-in-an-editorconfig-file

Если правила параметризованы, значения параметров могут быть изменены с помощью дополнительных файлов SonarLint.xml .

Первый шаг - создать новый файл с именем SonarLint.xml , который имеет следующую структуру:

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

Затем обновите проекты, чтобы включить этот дополнительный файл:

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

Внутренние ресурсы

Построить конфигурацию

• Репозиторий изображений виртуальных машин
• Предоставление репозитория
• Лазурные трубопроводы
• Конфигурация персики

Проблемы безопасности

Если вы считаете, что обнаружили уязвимость безопасности в продуктах Sonar, пожалуйста, проверьте этот документ

Лицензия

Copyright 2014-2024 Sonarsource.

Лицензировано в соответствии с исходной лицензией Sonar-источника v1.0