eslint plugin sonarjs Download - eslint plugin sonarjs Sumber Code Unduh

eslint plugin sonarjs

Kategori lainnya

1.0.4

Unduh

Repositori ini telah pindah!

Repositori ini berisi eslint-plugin-sonarjs hingga Versi ^1.0.0 . Untuk versi >=2.0.0 silakan pergi ke repositori penganalisa Sonarjs. Versi baru eslint-plugin-sonarjs membuat semua aturan Sonarjs tersedia untuk pengguna Eslint, bukan subset seperti dengan ^1.0.0 yang tinggal di sini.

Tidak ada perubahan baru yang diharapkan mendarat di sini.

Eslint-plugin-sonarjs

Aturan Sonarjs untuk Eslint untuk membantu pengembang menghasilkan kode bersih dengan mendeteksi bug dan pola yang mencurigakan.

Aturan

Deteksi Bug?

Aturan dalam kategori ini bertujuan untuk menemukan tempat dalam kode yang memiliki peluang tinggi menjadi bug, yaitu tidak berfungsi sebagaimana dimaksud.

Semua cabang dalam struktur bersyarat seharusnya tidak memiliki implementasi yang persis sama ( no-all-duplicated-branches )
Elemen pengumpulan tidak boleh diganti tanpa syarat ( no-element-overwrite )
Koleksi kosong tidak boleh diakses atau diulangi ( no-empty-collection )
Panggilan fungsi tidak boleh memberikan argumen tambahan ( no-extra-arguments )
Pernyataan "jika/lain jika" tidak memiliki kondisi yang sama ( no-identical-conditions )
Ekspresi yang identik tidak boleh digunakan di kedua sisi operator biner ( no-identical-expressions )
Nilai pengembalian dari fungsi tanpa efek samping tidak boleh diabaikan ( no-ignored-return ) ( tipe penggunaan )
Loop dengan paling banyak satu iterasi harus direfaktor ( no-one-iteration-loop )
Output fungsi yang tidak mengembalikan apa pun tidak boleh digunakan ( no-use-of-empty-return-value )
Operator yang tidak ada '=+', '=-' dan '=!' tidak boleh digunakan ( non-existent-operator ) (: kunci pas: dapat diperbaiki )

Deteksi Bau Kode?

Bau kode, atau masalah pemeliharaan, diangkat untuk tempat -tempat kode yang mungkin mahal untuk berubah di masa depan. Aturan -aturan ini juga membantu menjaga kualitas dan keterbacaan kode tinggi. Dan akhirnya, beberapa aturan melaporkan masalah tentang pola kode mencurigakan yang berbeda.

Kompleksitas fungsi kognitif tidak boleh terlalu tinggi ( cognitive-complexity )
"Jika ... lain jika" konstruksi harus diakhiri dengan klausa "else" ( elseif-without-else ) ( dinonaktifkan )
Pernyataan "Switch" tidak boleh memiliki terlalu banyak klausa "case" ( max-switch-cases )
Pernyataan "jika" yang dapat dilipat harus digabungkan ( no-collapsible-if )
Ukuran pengumpulan dan perbandingan panjang array harus masuk akal ( no-collection-size-mischeck ) (: kunci pas: dapat diperbaiki , jenis penggunaan )
Literal string tidak boleh digandakan ( no-duplicate-string )
Dua cabang dalam struktur bersyarat seharusnya tidak memiliki implementasi yang persis sama ( no-duplicated-branches )
Ekspresi Boolean tidak boleh serampangan ( no-gratuitous-expressions )
Fungsi seharusnya tidak memiliki implementasi yang identik ( no-identical-functions )
Pemeriksaan boolean tidak boleh dibalik ( no-inverted-boolean-check ) (: kunci pas: dapat diperbaiki , dinonaktifkan )
Pernyataan "Switch" tidak boleh bersarang ( no-nested-switch )
Template Literals tidak boleh bersarang ( no-nested-template-literals )
Literal boolean seharusnya tidak berlebihan ( no-redundant-boolean )
Pernyataan lompat tidak boleh berlebihan ( no-redundant-jump ) (: kunci pas: dapat diperbaiki )
Kondisional harus dimulai pada baris baru ( no-same-line-conditional ) (: kunci pas: dapat diperbaiki )
Pernyataan "Switch" harus memiliki setidaknya 3 "case" klausa ( no-small-switch )
Koleksi dan konten array harus digunakan ( no-unused-collection )
Klausa "Catch" harus melakukan lebih dari sekadar rethrow ( no-useless-catch )
Variabel lokal tidak boleh dinyatakan dan kemudian segera dikembalikan atau dilemparkan ( prefer-immediate-return ) (: kunci pas: dapat diperbaiki )
Sintaks literal objek harus digunakan ( prefer-object-literal )
Kembalinya ekspresi boolean tidak boleh dibungkus menjadi pernyataan "if-then-else" ( prefer-single-boolean-return ) (: kunci pas: dapat diperbaiki )
Loop "while" harus digunakan sebagai pengganti loop "untuk" ( prefer-while ) (: kunci pas: dapat diperbaiki )

Prasyarat

Node.js (> = 16.x).
Eslint 8.x atau 9.x (ketergantungan teman untuk plugin).

Penggunaan

Jika Anda belum memiliki Eslint yang dikonfigurasi untuk proyek Anda, ikuti instruksi ini.
Instal eslint-plugin-sonarjs menggunakan npm (atau yarn ) untuk proyek Anda atau secara global:

npm install eslint-plugin-sonarjs --save-dev # install for your project
npm install eslint-plugin-sonarjs -g         # or install globally

Tambahkan eslint-plugin-sonarjs ke plugin Eslint Config Anda.

Untuk Eslint 9: Tambahkan opsi plugins ke eslint.config.js Anda dan sertakan konfigurasi yang disarankan untuk mengaktifkan semua aturan:

 import sonarjs from "eslint-plugin-sonarjs";

[
  sonarjs.configs.recommended,
  {
    "plugins": {
      sonarjs,
    }
  }
]

Untuk Eslint 8: Tambahkan opsi plugins ke .eslintrc dan plugin:sonarjs/recommended-legacy ke opsi extends untuk mengaktifkan semua aturan yang disarankan:

{
  "plugins" : [ " sonarjs " ],
  "extends" : [ " plugin:sonarjs/recommended-legacy " ]
}

atau hanya mengaktifkan beberapa aturan secara manual:

{
  "rules" : {
    "sonarjs/cognitive-complexity" : " error " ,
    "sonarjs/no-identical-expressions" : " error "
    // etc.
  }
}

Untuk memungkinkan masing-masing aturan melakukan sepenuhnya, gunakan @typescript-eslint/parser sebagai parser untuk Eslint (seperti yang kita lakukan) dan atur opsi ParserOptions.Project. Terima kasih, ketik informasi tersedia, yang bermanfaat atau bahkan penting untuk beberapa aturan.

Konfigurasi yang tersedia

Plugin ini hanya menyediakan konfigurasi recommended . Hampir semua aturan diaktifkan di profil ini dengan beberapa pengecualian (periksa tag disabled dalam daftar aturan). Konfigurasi recommended mengaktifkan aturan dengan keparahan error . Kami menyertakan konfigurasi recommended-legacy untuk kompatibel ke belakang dengan Eslint V8, dengan konfigurasi aturan yang sama ..

Eslint dan Sonar

Plugin ini memaparkan kepada pengguna Eslint, subset dari aturan JS/TS dari produk Sonar-* (alias Sonarjs). Kami mengekstraksi aturan yang tidak tersedia di Eslint Core atau plugin Eslint lainnya untuk bermanfaat bagi komunitas Eslint.

Jika Anda adalah pengguna Sonarqube atau SonarCloud, untuk meletakkan kode Anda secara lokal, kami sarankan menggunakan ekstensi IDE Sonarlint (tersedia untuk VScode, IDE JetBrains dan Eclipse). Anda dapat menghubungkan Sonarlint ke proyek Sonarqube/SonarCloud Anda untuk menyinkronkan konfigurasi aturan, status masalah, dll.