twly

Twly?

Twly (diucapkan "handuk-e") adalah alat analisis statis yang dapat membantu Anda menjaga kode Anda tetap kering (jangan ulangi sendiri) dengan memberi tahu Anda di mana Anda telah menyalin dan menempelkan seluruh file atau porsi. Jalankan Twly di direktori, dan Twly secara ajaib akan membuat laporan untuk Anda menunjukkan apa yang telah diulang dan di mana file. Twly adalah bahasa agnostik dan dapat digunakan pada dokumen teks apa pun.

Instalasi

npm install -g twly atau untuk memasukkan dalam beberapa proyek npm install twly --save-dev

Konfigurasi

Twly memiliki beberapa konfigurasi default, yang diterjemahkan ke dalam objek JSON konfigurasi berikut

  {
    "threshold": 95,
    "ignore": ["node_modules/**/*.*", "bower_components/**/*.*", ".git/**/*.*"],
    "minLines": 4,
    "minChars": 100
  }

Twly membaca file konfigurasi .trc . File ini harus berisi objek JSON. Misalnya, di bawah ini adalah contoh file .trc jika Anda ingin melakukan hal berikut:

• Abaikan file spesifik foo.txt dan bar.txt serta semua konten di direktori node_modules Anda
• Keluar dengan kode status 1 (kegagalan) jika di bawah 89,5 persen file unik
• Hanya pencocokan blok kode yang memiliki setidaknya 7 baris besar dengan minimal 200 karakter

  {
    "threshold": 89.5,
    "ignore": ["foo.txt", "bar.txt", "node_modules/**"],
    "minLines": 7,
    "minChars": 200
  }

Penggunaan

Anda dapat menggunakan Twly hanya dengan menjalankan perintah twly . Ini akan menganalisis semua file dan berulang -ulang ke subdirektori di direktori kerja Anda saat ini secara default. Anda juga dapat meneruskan pola Glob ... jika misalnya Anda menginginkan semua file JavaScript di direktori Anda saat ini dan semua subdirektori: twly '**/*.js' . Ini akan menganalisis semua file CSS di direktori kerja Anda saat ini twly '*.css' .

Untuk daftar argumen CLI yang tersedia jalankan perintah twly --help .

Lihat proyek node-glob untuk opsi tentang cara menentukan file.

Gambar Docker

Dockerfile disediakan. Itu bisa digunakan seperti itu:

 twly> docker build -t twly .
app> docker run --rm -t -v "$(pwd):/code" -w /code twly