sonar dotnet

C# 및 vb.net의 코드 품질 및 보안

제품	품질 게이트	적용 범위
분석기
플러그인

IDE 코드 품질 및 보안 제품을위한 Sonarqube Server, Sonarqube Cloud 및 Sonarqube의 C# 및 vb.net 언어의 정적 분석. 이 Roslyn 분석기를 사용하면 코드베이스에서 버그, 취약점 및 코드 냄새를 찾아서 수정하여 안전하고 신뢰할 수 있으며 유지 관리 가능한 클린 코드를 생성 할 수 있습니다.

특징

• 470+ C# 규칙 및 210+ VB. 순 규칙
• 메트릭 (인지 적 복잡성, 복제, 줄 수 등)
• Visual Studio Code Coverage, DotCover, OpenCover, Coverlet, AltCover에서 테스트 범위 보고서 가져 오기.
• 타사 Roslyn 분석기 결과의 수입
• 맞춤 규칙 지원

유용한 공공 자원

• 프로젝트 홈페이지
• 문제 추적
• C# 규칙
• vb.net 규칙

nuget.org 패키지

• Sonaranalyzer.csharp
• Sonaranalyzer. Visualbasic

Sonarqube와의 통합

• .NET 용 Sonarscanner와 프로젝트를 분석하십시오
• 코드 적용 범위 가져 오기
• Sonarqube 및 Code Coverage

질문이나 피드백이 있습니까?

• 피드백을 제공하고 도움을 요청하고 새로운 규칙이나 기능을 요청하려면 커뮤니티 포럼에 문의하십시오.
• 버그, 거짓 양성 또는 거짓 음성을 찾은 경우 github 문제를 만듭니다.

시작하세요

• .NET 분석기 구축, 테스트 및 디버깅
• Java 플러그인 구축, 테스트 및 디버깅
• Nuget 잠금 파일을 재생하는 방법
• rspec.ps1 스크립트 사용

기여하는 방법

sonar-dotnet 프로젝트에 기여할 수있는 방법에는 여러 가지가 있습니다. 기고 할 때는 행동 강령을 존중하십시오.

토론에 참여하십시오

기여하는 가장 쉬운 방법 중 하나는 귀하의 피드백을 당사와 공유하고 (피드백 제공) 커뮤니티 포럼의 질문에 대한 답변입니다. 또한이 저장소의 활동 (열린 문제, 열기 PR)의 활동을 모니터링하여 우리가하는 일에 대해 더 잘 알게 될 수 있습니다.

풀 요청 (PR)

문제를 해결하려면 먼저 시작 페이지를 읽고 코딩 스타일을 따르십시오.

PR을 제출하기 전에 모든 테스트가 통과되는지 확인하십시오 (모든 수표는 녹색이어야 함).

• Area: CFG 라벨 (어려운 부작용이 많고 부작용이 많고 허용 될 가능성이 적음) .
• 규칙 저장소에서 C# 및/또는 vb.net에 이미 지정되지 않은 경우 새로운 규칙을 구현하지 않는 것이 좋습니다.

참고 : 우리의 CI는 외부 기여자의 PRS에서 자동으로 트리거되지 않습니다. 우리 팀원은 PR에 대한 의견을 추가하여 코드를 검토하고 CI를 트리거합니다 (Azure Pipelines Comment Triggers Docs 참조).

• /azp run Sonar.Net 플러그인 테스트 및 프로모션을 포함하여 전체 파이프 라인을 실행합니다.

우리와 함께하십시오

이 프로젝트에서 풀 타임으로 일하고 싶다면 우리는 고용하고 있습니다!

맞춤 규칙

새로운 규칙을 요청하려면 커뮤니티 포럼에서 문의하십시오.

규칙에 대한 아이디어가 있지만 모든 사람이 필요로하는지 확신하지 못하면 Roslyn 분석기를 구현할 수 있습니다.

• Microsoft 의이 자습서부터 시작하여 분석기를 작성할 수 있습니다.
• 모든 Roslyn 기반 문제는 .NET에 대한 Sonarscanner에 의해 수거되어 외부 문제로 Sonarqube로 밀려납니다.
• Sonarqube에서 규칙을 관리하려면 Sonarqube Roslyn SDK를 확인하여 Sonarqube 플러그인에 Roslyn 분석기를 포함시킵니다.

규칙 구성

IDE를위한 Sonarqube

가장 쉬운 방법은 Sonarqube에서 품질 프로파일을 구성하는 것입니다.

Sonarqube에서 규칙을 열고 아래로 스크롤하며 (규칙에 매개 변수가있는 경우) 규칙이 일부인 각 품질 프로파일에 대한 매개 변수를 구성 할 수 있습니다.

Sonarqube 서버 또는 클라우드에 연결하려면 IDE 연결 모드에 Sonarqube를 사용하십시오.

독립형 너겟

독립형 Nuget 패키지의 규칙은 .globalconfig 또는 .editorconfig 파일을 사용하여 Roslyn을 기반으로 다른 분석기와 동일한 방식으로 활성화 또는 비활성화 할 수 있습니다. 참조 : https://learn.microsoft.com/en-us/visualstudio/code-quality/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 >

내부 자원

구성을 빌드하십시오

• VM 이미지 저장소
• 프로비저닝 저장소
• Azure 파이프 라인
• 복숭아 구성

보안 문제

Sonar의 제품에서 보안 취약성을 발견했다고 생각되면이 문서를 확인하십시오.

특허

저작권 2014-2024 Sonarsource.

Sonar 소스를 이용할 수있는 라이센스 v1.0에 따라 라이센스