sonar dotnet

Kualitas dan Keamanan Kode untuk C# dan VB.NET

Produk	Gerbang Kualitas	Cakupan
Penganalisa
Plugin

Analisis statis bahasa C# dan VB.NET di server Sonarqube, cloud sonarqube dan sonarqube untuk kualitas kode dan produk keamanan. Penganalisa Roslyn ini memungkinkan Anda untuk menghasilkan kode bersih yang aman, dapat diandalkan, dan dapat dipelihara dengan membantu Anda menemukan dan memperbaiki bug, kerentanan, dan bau kode dalam basis kode Anda.

Fitur

• 470+ aturan C# dan 210+ VB. Aturan bersih
• Metrik (kompleksitas kognitif, duplikasi, jumlah garis, dll.)
• Impor laporan cakupan uji dari cakupan kode Visual Studio, Dotcover, OpenCover, Coverlet, Altcover.
• Impor hasil analisis Roslyn pihak ketiga
• Dukungan untuk Aturan Kustom

Sumber Daya Publik yang Berguna

• Beranda Proyek
• Pelacakan masalah
• Aturan C#
• Aturan vb.net

Paket Nuget.org

• Sonaranalyzer.csharp
• Sonaranalyzer.VisualBasic

Integrasi dengan sonarqube

• Menganalisis proyek dengan sonarscanner untuk .net
• Mengimpor Cakupan Kode
• Sonarquce dan liputan kode

Apakah Anda memiliki pertanyaan atau umpan balik?

• Hubungi kami di forum komunitas kami untuk memberikan umpan balik, meminta bantuan, dan meminta aturan atau fitur baru.
• Buat masalah GitHub jika Anda telah menemukan bug, false-positif atau false-negative.

Mulai

• Membangun, menguji dan men -debug. NET Analyzer
• Membangun, Menguji dan Men -Debugging Plugin Java
• Cara menghasilkan kembali file kunci nuget
• Menggunakan skrip rspec.ps1

Bagaimana berkontribusi

Ada banyak cara Anda dapat berkontribusi pada proyek sonar-dotnet . Saat berkontribusi, harap hormati kode perilaku kami.

Bergabunglah dengan diskusi

Salah satu cara termudah untuk berkontribusi adalah berbagi umpan balik Anda dengan kami (lihat berikan umpan balik) dan juga menjawab pertanyaan dari forum komunitas kami. Anda juga dapat memantau aktivitas pada repositori ini (masalah yang dibuka, PR yang dibuka) untuk lebih berkenalan dengan apa yang kami lakukan.

Tarik Permintaan (PR)

Jika Anda ingin memperbaiki masalah, silakan baca halaman Mulai terlebih dahulu dan pastikan Anda mengikuti gaya pengkodean kami.

Sebelum mengirimkan PR, pastikan semua tes lulus (semua cek harus hijau).

• Kami menyarankan Anda tidak memilih masalah dengan Area: CFG (mereka sulit, dapat memiliki banyak efek samping dan cenderung diterima) .
• Kami menyarankan Anda tidak menerapkan aturan baru kecuali mereka sudah ditentukan untuk C# dan/atau VB.NET pada repositori aturan kami.

Catatan: CI kami tidak dipicu secara otomatis pada PR dari kontributor eksternal. Seorang anggota tim kami akan meninjau kode dan memicu CI sesuai permintaan dengan menambahkan komentar pada PR (lihat Azure Pipelines Commentare memicu dokumen):

• /azp run Sonar.Net - Ini akan menjalankan pipa lengkap, termasuk tes dan promosi plugin

Bergabunglah dengan kami

Jika Anda ingin mengerjakan proyek ini penuh waktu, kami sedang merekrut!

Aturan khusus

Untuk meminta aturan baru, hubungi kami di forum komunitas kami.

Jika Anda memiliki ide untuk suatu peraturan tetapi Anda tidak yakin bahwa semua orang membutuhkannya, Anda dapat mengimplementasikan Roslyn Analyzer Anda sendiri.

• Anda dapat mulai dengan tutorial ini dari Microsoft untuk menulis penganalisa.
• Semua masalah yang berbasis di Roslyn diambil oleh SonarsCanner untuk .NET dan didorong ke Sonarqube sebagai masalah eksternal.
• Lihat juga Sonarqube Roslyn SDK untuk menyematkan Roslyn Analyzer Anda di plugin Sonarqube, jika Anda ingin mengelola aturan Anda dari Sonarqube.

Mengonfigurasi aturan

Sonarqube untuk IDE

Cara termudah adalah mengkonfigurasi profil kualitas di Sonarqube.

Buka aturan dalam sonarqube, gulir ke bawah, dan (jika aturan memiliki parameter), Anda dapat mengonfigurasi parameter untuk setiap profil kualitas aturan yang menjadi bagian dari.

Gunakan SonarQUBE untuk mode IDE Connected untuk terhubung ke server Sonarqube atau cloud.

Nuget mandiri

Aturan dari paket Nuget mandiri dapat diaktifkan atau dinonaktifkan dengan cara yang sama seperti analisis lain berdasarkan Roslyn, dengan menggunakan file .globalconfig atau .editorconfig . Lihat: https://learn.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022#set-rule-severity-in- editorconfig-file

Jika aturannya diparameterisasi, nilai parameter dapat diubah menggunakan file tambahan SonarLint.xml .

Langkah pertama adalah membuat file baru, bernama SonarLint.xml , yang memiliki struktur berikut:

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

Kemudian, perbarui proyek untuk memasukkan file tambahan ini:

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

Sumber Daya Internal

Bangun konfigurasi

• Repositori Gambar VM
• Penyediaan repositori
• Pipa Azure
• Konfigurasi Peachee

Masalah keamanan

Jika Anda yakin telah menemukan kerentanan keamanan dalam produk Sonar, silakan periksa dokumen ini

Lisensi

Hak Cipta 2014-2024 Sonarsource.

Lisensi di bawah Sonar Source-Available License v1.0