Plugin Eslint yang kuat dengan aturan untuk membantu Anda mencapai proyek yang dapat diskalakan, konsisten, dan terstruktur dengan baik.
Buat kerangka kerja Anda sendiri! Tentukan struktur folder Anda, komposisi file, konvensi penamaan lanjutan, dan buat modul independen.
Bawa proyek Anda ke tingkat berikutnya dan hemat waktu dengan mengotomatisasi tinjauan prinsip -prinsip utama proyek yang sehat!
? Informasi umum
? Taman Bermain untuk Aturan Struktur Eslint-Plugin-Project.
Periksa rilis terbaru dan tetap diperbarui dengan fitur dan perubahan baru.
Menjadi bagian dari komunitas! Tinggalkan dan bagikan tautan dengan teman -teman Anda.
Jika Anda memiliki pertanyaan atau memerlukan bantuan untuk membuat konfigurasi yang memenuhi kebutuhan Anda, bantuan.
Jika Anda telah menemukan bug atau kesalahan dalam dokumentasi, laporkan masalah.
Jika Anda memiliki ide untuk fitur baru atau peningkatan yang sudah ada, ide.
Jika Anda tertarik untuk membahas struktur proyek di berbagai kerangka kerja atau ingin memilih ide yang diusulkan, diskusi.
Dokumentasi
Struktur proyek/folder-struktur
Struktur proyek/modul independen
Proyek-Struktur/Komposisi File
Struktur Proyek -Struktur/Folder
Menegakkan aturan tentang struktur folder untuk menjaga proyek Anda konsisten, tertib, dan dipikirkan dengan baik.
Fitur:
Validasi struktur folder. File/folder apa pun di luar struktur akan dianggap sebagai kesalahan.
File/nama folder validasi regex dengan fitur -fitur seperti wildcard * dan memperlakukan . sebagai karakter, bersama dengan kenyamanan lainnya.
Bangun dalam kasus validasi.
Mewarisi nama folder. File/folder mewarisi nama folder di mana ia berada. Opsi untuk menambahkan awalan/sufiks Anda sendiri atau mengubah kasing.
Menegakkan keberadaan file/folder saat file/folder tertentu ada. Misalnya, jika ./src/Component.tsx ada, lalu ./src/Component.test.tsx dan ./src/stories/Component.stories.tsx juga harus ada.
Aturan yang dapat digunakan kembali untuk struktur folder.
Opsi untuk membuat file konfigurasi terpisah dengan dukungan TypeScript.
Memaksa struktur bersarang/datar untuk folder yang diberikan.
Dukungan untuk semua ekstensi file.
Rekursi folder. Anda dapat berulang kali menyatukan struktur folder dan menetapkan batas pada kedalaman bersarang. Ada juga opsi untuk mengubah aturan di tingkat akhir, seperti meratakan struktur folder.
Lebih sedikit pengulangan dan pesan kesalahan yang tepat, bahkan untuk folder yang sangat bersarang (rekursi), dengan mewakili struktur folder sebagai pohon.
Memeriksa panjang jalur dan memberi tahu kapan batasnya terlampaui.
Struktur proyek/modul independen
Prinsip utama dari proyek yang sehat adalah untuk mencegah penciptaan pohon ketergantungan besar -besaran, di mana menghilangkan atau mengedit satu fitur memicu reaksi berantai yang berdampak pada seluruh proyek.
Buat modul tempat Anda mengontrol apa yang dapat diimpor ke dalamnya. Hilangkan dependensi yang tidak perlu antara folder atau file untuk membangun fungsionalitas yang benar -benar independen.
Fitur:
Membuat modul di mana Anda mengontrol apa yang dapat diimpor (misalnya tipe, fungsi, komponen dari satu fungsionalitas tidak dapat diimpor ke fungsionalitas lain).
Kemampuan untuk membuat aturan yang sangat rinci, bahkan untuk struktur folder bersarang. Baik itu modul besar, sub-modul, atau satu file, tidak ada batasan.
Dukungan untuk semua jenis impor, termasuk require() , import() , jest.mock() , dan jest.requireActual() , serta ExportAllDeclaration dan ExportNamedDeclaration .
Menonaktifkan Impor Eksternal (Node_Modules) untuk modul yang diberikan (opsi untuk menambahkan pengecualian).
Dukungan impor non-relatif/relatif.
Resolver impor bawaan, jadi Anda tidak perlu memasang plugin tambahan. Ini juga termasuk konfigurasi bawaan untuk ekstensi file paling populer, jadi Anda tidak perlu mengkonfigurasi apa pun secara manual.
Pola impor yang dapat digunakan kembali.
Dukungan untuk Alias Path. Plugin akan secara otomatis mendeteksi tsconfig.json Anda dan menggunakan pengaturan Anda. Ada juga opsi untuk memasukkannya secara manual.
Opsi untuk membuat file konfigurasi terpisah dengan dukungan TypeScript.
Komposisi Proyek -Struktur/File
Tuliskan file ideal Anda!
Memiliki kontrol penuh atas pesanan dan jumlah pemilih.
Tentukan konvensi penamaan lanjutan dan melarang penggunaan pemilih tertentu dalam file yang diberikan.
Fitur:
Validasi komposisi file.
Selektor yang Didukung: class , function , Fungsi arrowFunction , type , interface , enum , variable , variableExpression , propertyDefinition .
Mewarisi nama file sebagai nama pemilih. Opsi untuk menambahkan awalan/sufiks Anda sendiri, mengubah kasing, atau menghapus bagian nama file.
Melarang penggunaan selektor yang diberikan dalam file yang diberikan. Misalnya, file **/*.consts.ts hanya dapat berisi variabel, **/*.types.ts file hanya dapat berisi antarmuka dan tipe.
Tentukan urutan di mana pemilih Anda akan muncul dalam file yang diberikan. Dukungan untuk --fix untuk secara otomatis memperbaiki pesanan.
Aturan untuk pemilih yang diekspor, pemilih di root file dan sarang/semua pemilih dalam file. Mereka dapat digunakan bersama dalam kombinasi.
Menegakkan maksimum satu komponen utama/fungsi/kelas per file.
Kemampuan untuk menetapkan batas spesifik pada terjadinya pemilih tertentu di akar file yang diberikan.
Nama Pemilih Validasi Regex.
Bangun dalam kasus validasi.
Aturan yang berbeda untuk file yang berbeda.
Opsi untuk membuat file konfigurasi terpisah dengan dukungan TypeScript.
Sponsor
Terima kasih banyak untuk semua sponsor atas dukungan Anda! Anda memberi saya kekuatan dan motivasi untuk terus berjalan!
Terima kasih, saya dapat membantu orang lain membuat proyek ideal mereka!
