sonar dotnet

คุณภาพรหัสและความปลอดภัยสำหรับ C# และ vb.net

ผลิตภัณฑ์	ประตูคุณภาพ	ความครอบคลุม
เครื่องวิเคราะห์
ปลั๊กอิน

การวิเคราะห์แบบคงที่ของภาษา C# และ VB.NET ในเซิร์ฟเวอร์ Sonarqube, Sonarqube Cloud และ Sonarqube สำหรับคุณภาพรหัสและผลิตภัณฑ์รักษาความปลอดภัย IDE เครื่องวิเคราะห์ Roslyn เหล่านี้ช่วยให้คุณสามารถสร้างรหัสที่สะอาดซึ่งปลอดภัยเชื่อถือได้และบำรุงรักษาได้โดยช่วยให้คุณค้นหาและแก้ไขข้อบกพร่องช่องโหว่และรหัสได้กลิ่นในรหัสของคุณ

คุณสมบัติ

• กฎ 470+ C# และกฎสุทธิ 210+ VB.
• ตัวชี้วัด (ความซับซ้อนทางปัญญาการทำซ้ำจำนวนบรรทัด ฯลฯ )
• การนำเข้ารายงานการครอบคลุมการทดสอบจาก Visual Studio Code ครอบคลุม dotcover, OpenCover, Coverlet, AltCover
• การนำเข้าผลลัพธ์ของตัววิเคราะห์ Roslyn ของบุคคลที่สาม
• สนับสนุนกฎที่กำหนดเอง

ทรัพยากรสาธารณะที่มีประโยชน์

• หน้าแรกของโครงการ
• การติดตามปัญหา
• C# กฎ
• กฎ vb.net

แพ็คเกจ nuget.org

• sonaranalyzer.csharp
• Sonaranalyzer.visualbasic

บูรณาการกับ Sonarqube

• วิเคราะห์โครงการด้วย sonarscanner สำหรับ. NET
• การนำเข้าครอบคลุมรหัส
• Sonarqube และรหัสครอบคลุม

คุณมีคำถามหรือข้อเสนอแนะหรือไม่?

• ติดต่อเราในฟอรัมชุมชนของเราเพื่อให้ข้อเสนอแนะขอความช่วยเหลือและขอกฎหรือคุณสมบัติใหม่
• สร้างปัญหา GitHub หากคุณพบข้อผิดพลาดเท็จบวกหรือเท็จลบ

เริ่มต้นใช้งาน

• การสร้างการทดสอบและการดีบักเครื่องวิเคราะห์. NET
• การสร้างการทดสอบและการดีบักปลั๊กอิน Java
• วิธีสร้างไฟล์ล็อค Nuget อีกครั้ง
• ใช้สคริปต์ rspec.ps1

วิธีการมีส่วนร่วม

มีหลายวิธีที่คุณสามารถมีส่วนร่วมในโครงการ sonar-dotnet เมื่อมีส่วนร่วมโปรดเคารพจรรยาบรรณของเรา

เข้าร่วมการอภิปราย

หนึ่งในวิธีที่ง่ายที่สุดในการมีส่วนร่วมคือการแบ่งปันความคิดเห็นของคุณกับเรา (ดูให้ข้อเสนอแนะ) และตอบคำถามจากฟอรัมชุมชนของเรา นอกจากนี้คุณยังสามารถตรวจสอบกิจกรรมในพื้นที่เก็บข้อมูลนี้ (เปิดปัญหาเปิด PRS) เพื่อทำความคุ้นเคยกับสิ่งที่เราทำมากขึ้น

คำขอดึง (PR)

หากคุณต้องการแก้ไขปัญหาโปรดอ่านหน้าเริ่มต้นก่อนและตรวจสอบให้แน่ใจว่าคุณทำตามสไตล์การเข้ารหัสของเรา

ก่อนที่จะส่ง PR ตรวจสอบให้แน่ใจว่าการทดสอบทั้งหมดผ่านไป (การตรวจสอบทั้งหมดต้องเป็นสีเขียว)

• เราขอแนะนำให้คุณไม่เลือกปัญหาเกี่ยวกับ Area: CFG (เป็นเรื่องยากสามารถมีผลข้างเคียงมากมายและมีโอกาสน้อยที่จะได้รับการยอมรับ)
• เราขอแนะนำให้คุณไม่ใช้กฎใหม่เว้นแต่ว่าพวกเขาจะระบุไว้แล้วสำหรับ C# และ/หรือ VB.NET ในที่เก็บกฎของเรา

หมายเหตุ: CI ของเราไม่ได้รับการกระตุ้นโดยอัตโนมัติจาก PRS จากผู้มีส่วนร่วมภายนอก สมาชิกของทีมงานของเราจะตรวจสอบรหัสและเรียก CI ตามความต้องการโดยการเพิ่มความคิดเห็นเกี่ยวกับ PR (ดู Azure Pipelines Comment Triggers Docs):

• /azp run Sonar.Net - มันจะเรียกใช้ไปป์ไลน์เต็มรูปแบบรวมถึงการทดสอบปลั๊กอินและโปรโมชั่น

เข้าร่วมกับเรา

หากคุณต้องการทำงานในโครงการนี้เต็มเวลาเรากำลังจ้าง!

กฎที่กำหนดเอง

หากต้องการขอกฎใหม่โปรดติดต่อเราในฟอรัมชุมชนของเรา

หากคุณมีความคิดสำหรับกฎ แต่คุณไม่แน่ใจว่าทุกคนต้องการมันคุณสามารถใช้ Roslyn Analyzer ของคุณเองได้

• คุณสามารถเริ่มต้นด้วยบทช่วยสอนนี้จาก Microsoft เพื่อเขียนเครื่องวิเคราะห์
• ปัญหาที่ใช้ Roslyn ทั้งหมดถูกเลือกโดย Sonarscanner สำหรับ. NET และผลักไปที่ Sonarqube เป็นปัญหาภายนอก
• ตรวจสอบ Sonarqube Roslyn SDK เพื่อฝังตัววิเคราะห์ Roslyn ของคุณในปลั๊กอิน Sonarqube หากคุณต้องการจัดการกฎของคุณจาก Sonarqube

การกำหนดค่ากฎ

Sonarqube สำหรับ ide

วิธีที่ง่ายที่สุดคือการกำหนดค่าโปรไฟล์คุณภาพใน Sonarqube

เปิดกฎใน Sonarqube เลื่อนลงและ (ในกรณีที่กฎมีพารามิเตอร์) คุณสามารถกำหนดค่าพารามิเตอร์สำหรับแต่ละโปรไฟล์คุณภาพกฎเป็นส่วนหนึ่งของ

ใช้ Sonarqube สำหรับโหมดเชื่อมต่อ IDE เพื่อเชื่อมต่อกับเซิร์ฟเวอร์ SonarQube หรือคลาวด์

Nuget แบบสแตนด์อโลน

กฎจากแพ็คเกจ NUGET แบบสแตนด์อโลนสามารถเปิดใช้งานหรือปิดใช้งานได้ในลักษณะเดียวกับเครื่องวิเคราะห์อื่น ๆ ตาม Roslyn โดยใช้ไฟล์ .globalconfig หรือ .editorconfig โปรดดู: https://learn.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022#set-rule-severity-in-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 Images
• การจัดเตรียมที่เก็บ
• Azure Pipelines
• การกำหนดค่า Peachee

ปัญหาด้านความปลอดภัย

หากคุณเชื่อว่าคุณได้ค้นพบช่องโหว่ด้านความปลอดภัยในผลิตภัณฑ์ของ Sonar โปรดตรวจสอบเอกสารนี้

ใบอนุญาต

ลิขสิทธิ์ 2014-2024 Sonarsource

ได้รับใบอนุญาตภายใต้ใบอนุญาตแหล่งที่มาของ Sonar