gritql

Taman bermain | Tutorial | dokumen

---

GritQL adalah bahasa kueri deklaratif untuk mencari dan memodifikasi kode sumber.

• Mulailah dengan sederhana tanpa mempelajari detail AST: cuplikan kode apa pun adalah kueri GritQL yang valid
• ⚡️ Gunakan Rust dan optimasi kueri untuk meningkatkan hingga 10 juta+ repositori baris
• ? Gunakan sistem modul bawaan Grit untuk menggunakan kembali 200+ pola standar atau bagikan pola Anda sendiri
• ♻️ Setelah mempelajari GritQL, Anda dapat menggunakannya untuk menulis ulang bahasa target apa pun: JavaScript/TypeScript, Python, JSON, Java, Terraform, Solidity, CSS, Markdown, YAML, Rust, Go, atau SQL
• ? GritQL memudahkan penyertaan aturan perbaikan otomatis untuk remediasi yang lebih cepat

Memulai

Baca dokumentasi, tutorial interaktif, atau jalankan grit --help .

Instalasi

Instal Grit CLI:

 curl -fsSL https://docs.grit.io/install | bash

Penggunaan

Cari semua panggilan console.log Anda dengan meletakkan pola yang diinginkan di backticks:

 grit apply '`console.log($_)`'

Ganti console.log dengan winston.log , gunakan => untuk membuat penulisan ulang:

 grit apply '`console.log($msg)` => `winston.log($msg)`'

Simpan pola ke file grit.yaml dan kecualikan kasus uji dalam klausa Where:

 cat << 'EOF' > .grit/grit.yaml
patterns:
  - name: use_winston
    level: error
    body: |
      `console.log($msg)` => `winston.log($msg)` where {
        $msg <: not within or { `it($_, $_)`, `test($_, $_)`, `describe($_, $_)` }
      }
EOF
grit apply use_winston

Jalankan grit check untuk menerapkan pola Anda sebagai lint khusus.

 grit check

Contoh

Hapus semua panggilan console.log , kecuali panggilan tersebut berada di dalam blok coba-tangkap

 `console.log($log)` => . where {
  $log <: not within `try { $_ } catch { $_ }`
}

Ganti pemanggilan metode dengan pemanggilan metode baru

 `$instance.oldMethod($args)` => `$instance.newMethod($args)` where {
  $program <: contains `$instance = new TargetClass($_)`
}

Lebih banyak contoh

Banyak contoh lainnya dapat ditemukan di perpustakaan standar GritQL.

Pola dapat digabungkan untuk membuat kueri yang kompleks, termasuk pemfaktoran ulang yang besar.

Mengapa GritQL?

GritQL berasal dari pengalaman kami melakukan refactor dan migrasi skala besar.

Biasanya, migrasi dimulai dengan upaya eksplorasi untuk mengetahui cakupan masalahnya—seringkali menggunakan penelusuran grep sederhana. Ini mudah untuk dimulai, namun sebagian besar migrasi akhirnya mengumpulkan persyaratan tambahan seperti memastikan paket yang tepat diimpor dan mengecualikan kasus yang tidak memiliki jalur migrasi yang layak.

Pada akhirnya, setiap migrasi kompleks akan menjadi program codemod lengkap yang ditulis dengan alat seperti jscodeshift. Hal ini mempunyai permasalahan tersendiri:

• Sebagian besar pekerjaan eksplorasi harus ditinggalkan saat Anda mengetahui cara merepresentasikan penelusuran regex asli Anda sebagai AST.
• Membaca/menulis codemod memerlukan penerjemahan mental dari nama AST kembali ke seperti apa kode sumber sebenarnya.
• Sebagian besar kerangka kerja tidak dapat disusun, jadi Anda terjebak dalam menyalin pola bolak-balik.
• Performa sering kali hanya menjadi renungan, jadi iterasi pada codemod berukuran besar bisa sangat lambat.
• Kerangka kerja Codemod bersifat khusus untuk satu bahasa, jadi jika Anda beralih ke beberapa bahasa—atau mencoba memigrasikan API bersama—Anda harus mempelajari kerangka kerja yang berbeda.

GritQL adalah upaya kami untuk mengembangkan jalan tengah yang kuat:

• Analisis eksplorasinya mudah: cukup letakkan cuplikan kode di backticks dan gunakan $metavariables untuk lubang yang ingin Anda wakili.
• Tambahkan kompleksitas secara bertahap dengan memperkenalkan kondisi samping dengan klausa Where.
• Gunakan kembali pola bernama untuk menghindari pembuatan ulang kueri, dan gunakan pola bersama dari pustaka standar kami untuk tugas umum seperti memastikan modul diimpor.
• Ditulis dalam Rust untuk performa maksimal: tulis ulang jutaan baris kode dalam hitungan detik.

Ucapan Terima Kasih

GritQL menggunakan tree-sitter untuk semua parser bahasa dan mendapat banyak manfaat dari ekosistem Rust.

GritQL dirilis di bawah lisensi MIT.

Berkontribusi

Kontribusi dipersilahkan. Untuk memulai, lihat pedoman berkontribusi .

Anda juga dapat bergabung dengan kami di Discord .