automutate

Otomatis

Menerapkan gelombang mutasi yang disediakan oleh alat lain, seperti linter atau codemods.

Ada banyak linter di luar sana dan sebagian besar termasuk cara --fix aturan kegagalan secara otomatis. Ini bagus tapi sulit dilakukan karena beberapa alasan:

• Mutasi yang tumpang tindih - Kemungkinan mutasi yang berlaku untuk set karakter yang tumpang tindih memerlukan logika untuk menangani penerapannya, kemudian menjalankan kembali serat, dan sebagainya.
• Duplikasi Verses Code Bloat - Sebagian besar linter memberikan kait untuk menerapkan perbaikan sendiri (yang dapat menghasilkan kode kembung) atau memiliki proyek eksternal (yang menduplikasi logika untuk menemukan aturan).

automutate mengusulkan agar Linters hanya mengusulkan cara memperbaiki aturan, melalui format JSON terstandarisasi.

Memiliki proyek sumber-agnostik standar untuk menerapkan mutasi membawa beberapa manfaat:

• Pengurangan overhead - Proyek tidak perlu lagi melakukan pekerjaan ini sendiri.
• Basis standar - waktu ramp -up untuk beralih antar proyek menggunakan automutate dikurangi dengan kode umum.

Secara umum, mendeteksi kegagalan aturan adalah masalah terpisah dari memperbaikinya . Linters perlu dijalankan dengan cepat melalui satu set file baca saja, seringkali selama proses yang dibangun, sementara fixer biasanya berjalan perlahan dan memodifikasi file berdasarkan permintaan pengguna.

Cara kerjanya

Algoritma automutate Utama dimulai di autoMutator.ts dan sebagian besar diterapkan di mutationsApplier.ts :

while mutationsWave = getMutationsWave ( ) :
    for ( file , fileMutations ) of groupMutationsByFile ( mutationsWave ) :
        for mutation of getNonOverlappingMutationsInReverse ( fileMutations ) :
            applyMutation ( file , mutation )

1. getMutationsWave panggilan ke alat eksternal, seperti linter, untuk menerima gelombang mutasi yang disarankan.
2. groupMutationsByFile mengatur mutasi yang disarankan dengan file.
3. getNonOverlappingMutationsInReverse menghilangkan mutasi yang tumpang tindih yang akan saling bertentangan, dan mengurutkan sisanya dalam urutan terbalik sehingga mutasi kemudian tidak mengganggu posisi karakter mutasi sebelumnya.
4. applyMutation memodifikasi file pada disk menggunakan mutasi yang tersisa.

Mutasi

Mutasi tunggal berisi pengidentifikasi type yang unik, berbagai posisi karakter untuk diterapkan ke, dan secara opsional logika lainnya.

Manipulasi teks dasar berikut disediakan di luar kotak:

• multiple - wadah untuk beberapa mutasi. Ini menunjukkan untuk automutate bahwa ini harus diterapkan sekaligus atau tidak sama sekali, yang menjamin konsistensi dengan deteksi tumpang tindih mutasi bawaan.
• text-delete - Menghapus berbagai karakter.
• text-insert - menyisipkan string pada suatu titik.
• text-replace - Mengganti karakter yang cocok dengan string atau ekspresi reguler dalam rentang.
• text-swap - Menukar berbagai karakter dengan string baru.

Misalnya:

{
  "ugly-file.txt" : [
    {
      "range" : {
        "begin" : 7 ,
        "end" : 14
      },
      "type" : " text-delete "
    },
    {
      "insertion" : " inconceivable! " ,
      "range" : {
        "begin" : 21
      },
      "type" : " text-insert "
    }
  ]
}

Utilitas khusus linter dapat menentukan mutasi mereka sendiri. Misalnya, linter bahasa dapat menentukan mutasi node-rename daripada menggunakan mutasi multiple yang mengandung mutasi text-swap .

Lihat mutator untuk lebih lanjut tentang mutator khusus.

Proyek Onboarding

Lihat Onboarding.

automutate membutuhkan nodejs> = 14.