dependency cruiser

Kapal penjelajah ketergantungan

Validasi dan visualisasikan dependensi. Dengan aturan Anda. Javascript. Naskah. CoffeeScript. ES6, CommonJS, AMD.

Apa yang dilakukan ini?

Ini berjalan melalui dependensi dalam proyek JavaScript, naskah, livescript atau CoffeeScript dan ...

• ... memvalidasinya terhadap aturan (Anda sendiri)
• ... Laporan melanggar aturan
  • dalam teks (untuk build Anda)
  • dalam grafik (untuk bola mata Anda)

Sebagai efek samping, ia dapat menghasilkan grafik ketergantungan dalam berbagai format output termasuk visualisasi keren Anda dapat menempel di dinding untuk mengesankan nenek Anda.

Bagaimana cara menggunakannya?

Instal ...

npm install --save-dev dependency-cruiser
# or
yarn add -D dependency-cruiser
pnpm add -D dependency-cruiser

... dan menghasilkan konfigurasi

npx depcruise --init

Ini akan sedikit melihat-lihat di lingkungan Anda sedikit, mengajukan beberapa pertanyaan dan membuat file konfigurasi .dependency-cruiser.js yang selaras dengan proyek Anda ^{1 2} .

Tunjukkan barang untuk nenek Anda

Untuk membuat grafik dependensi di folder SRC Anda, Anda akan menjalankan kapal penjelajah dependensi dengan dot output dan menjalankan graphviz dot ³ pada hasilnya. Dalam satu liner:

npx depcruise src --include-only " ^src " --output-type dot | dot -T svg > dependency-graph.svg

Ketergantungan-Cruiser V12 dan Lebih Lama: Tambahkan-Opsi Config

Meskipun tidak perlu dari ketergantungan-kruiser V13 dan lebih baru, di V12 dan lebih tua Anda harus lulus opsi-konfigurasi untuk membuatnya menemukan file konfigurasi .dependency-cruiser.js:

npx depcruise src --include-only " ^src " --config --output-type dot | dot -T svg > dependency-graph.svg

• Anda dapat membaca lebih lanjut tentang apa yang dapat Anda lakukan dengan --include-only opsi baris perintah dan perintah lainnya dalam dokumentasi antarmuka baris perintah.
• Sampel dunia nyata berisi kapal pesiar ketergantungan dari beberapa proyek yang paling banyak digunakan di NPM.
• Jika nenek Anda lebih menyukai format seperti mermaid , json , csv , html atau teks biasa, kami juga telah dilindungi.

Validasi sesuatu

Menyatakan beberapa aturan

Ketika Anda berlari depcruise --init di atas, perintah tersebut juga menambahkan beberapa aturan ke .dependency-cruiser.js yang masuk akal di sebagian besar proyek, seperti mendeteksi ketergantungan melingkar , dependensi yang hilang dalam paket package.json, yatim , dan kode produksi yang mengandalkan dependensi dev atau opsional.

Mulailah menambahkan aturan Anda sendiri dengan mengubah file itu.

Aturan sampel:

{
  "forbidden" : [
    {
      "name" : " not-to-test " ,
      "comment" : " don't allow dependencies from outside the test folder to test " ,
      "severity" : " error " ,
      "from" : { "pathNot" : " ^test " },
      "to" : { "path" : " ^test " }
    }
  ]
}

• Untuk membaca lebih lanjut tentang aturan penulisan, periksa tutorial aturan penulisan atau referensi aturan

Melaporkannya

npx depcruise src

Ketergantungan-Cruiser V12 dan Lebih Lama: Tambahkan-Opsi Config

Meskipun tidak perlu dari ketergantungan-cruiser V13, di V12 dan lebih tua Anda harus lulus opsi-konfigurasi untuk membuatnya menemukan file konfigurasi .dependency-cruiser.js:

npx depcruise --config .dependency-cruiser.js src

Ini akan memvalidasi terhadap aturan Anda dan menunjukkan pelanggaran dalam format seperti Eslint:

Ada lebih banyak cara untuk melaporkan validasi; Dalam grafik (seperti yang ada di atas readme ini) atau dalam file html mandiri.

• Baca lebih lanjut tentang reporter ERR, DOT, CSV dan HTML dalam dokumentasi antarmuka baris perintah.
• Ketergantungan-Cruiser menggunakan dirinya sendiri untuk memeriksa dirinya sendiri dalam proses pembangunannya sendiri; Lihat skrip depcruise di package.json

Saya ingin tahu lebih banyak!

Anda telah datang ke tempat yang tepat :-):

• Penggunaan
  • Referensi baris perintah
  • Aturan menulis
  • Referensi Aturan
  • Referensi Opsi
  • FAQ
• Peretasan pada Ketergantungan-Cruiser
  • API
  • Format output
  • Menambahkan format output lainnya
  • Menambahkan dukungan untuk bahasa ALT-JS lainnya
• Hal -hal lain
  • Peta jalan
  • Kontak
  • Kasus Pertunjukan Dunia Nyata
  • Typescript, CoffeeScript dan Livescript Dukungan
  • Dukungan untuk .jsx, .tsx, .csx/ .cjsx, .vue dan .svelte
  • Dukungan alias/ modul webpack

Lisensi

Mit

Terima kasih

• Marijn Haverbeke dan orang lain yang berkolaborasi di Acorn - JavaScript Parser -Cruiser yang sangat baik digunakan untuk menyimpulkan dependensi.
• Katerina Limpitsouni dari Undraw untuk ollie dalam citra media sosial ketergantungan-kruiser.
• Semua anggota komunitas open source yang telah berbaik hati untuk mengangkat masalah, mengajukan pertanyaan dan mengajukan permintaan tarik untuk mendapatkan ketergantungan-cruiser menjadi alat yang lebih baik.

Bangun status

Dibuat dengan? di Belanda.

Catatan kaki

1. Kami menggunakan npx dalam contoh skrip untuk kenyamanan. Saat Anda menggunakan perintah dalam skrip di package.json tidak perlu untuk mengawali mereka dengan npx . ↩

2. Jika Anda tidak ingin menggunakan npx , tetapi sebaliknya pnpx (dari pnpm Package Manager) atau yarn - silakan merujuk ke dokumentasi alat itu. Khususnya pnpx memiliki semantik yang berbeda dari npx cukup signifikan dan Anda ingin menyadari sebelum menggunakannya. Sementara itu: npx harus bekerja bahkan ketika Anda menginstal ketergantungan dengan manajer paket yang berbeda dari npm . ↩

3. Ini mengasumsikan perintah graphviz dot tersedia - pada sebagian besar sistem Linux dan sebanding ini. Jika tidak, lihat halaman unduhan GraphViz untuk instruksi tentang cara mendapatkannya di mesin Anda. ↩