API Lua Neovim

Neovim menyertakan lingkungan LuaJIT, sehingga Lua menjadi bahasa skrip bawaan di samping Vimscript. Pembuat plugin memilih Lua karena kecepatannya, struktur datanya yang nyata, dan sistem modulnya yang rapi.

Tabel global vim adalah gerbang menuju semuanya: keadaan editor, API, opsi, dan fungsi pembantu dari pustaka standar. Menguasainya merupakan landasan pengembangan plugin modern.

vim.api menyediakan API jarak jauh tingkat rendah: setiap fungsi yang diawali dengan nvim_. Ini adalah panggilan yang sama seperti yang digunakan klien eksternal melalui RPC, tetapi karena berjalan di dalam proses, panggilan tersebut berlangsung seketika.

Fungsi seperti nvim_get_current_buf, nvim_buf_set_lines, dan nvim_command memberikan kendali yang presisi. Fungsi-fungsi ini stabil, terdokumentasi dengan baik, dan menjadi tulang punggung plugin yang serius.

vim.fn menjembatani fungsi bawaan Vimscript. Apa pun yang dapat dipanggil di Vimscript, seperti expand() atau fnamemodify(), dapat diakses sebagai vim.fn.expand(...).

Hal ini sangat berguna ketika belum tersedia API bawaan. Argumen dan nilai kembalian secara otomatis dikonversi antara tipe Lua dan Vimscript.

Opsi diatur melalui metatabel. vim.o menargetkan opsi global, vim.bo opsi khusus buffer, dan vim.wo opsi khusus jendela.

Penetapannya semudah menulis sebuah bidang. Cara ini menggantikan pemanggilan nvim_set_option yang panjang dan lebih mudah dibaca dalam kode konfigurasi.

vim.g membaca dan menulis variabel global Vim. Plugin biasanya menyediakan pengalih konfigurasi di sini, seperti vim.g.myplugin_enabled.

Membaca variabel yang belum diatur akan mengembalikan nil, jadi lindungi pembacaan dengan nilai bawaan. Varian khusus buffer dan jendela tersedia sebagai vim.b dan vim.w.

Gunakan vim.notify untuk menampilkan pesan kepada pengguna. Fungsi ini menerima string pesan dan tingkat log opsional dari vim.log.levels.

Pengelola plugin seperti noice atau notify dapat mengambil alih pesan ini untuk menyediakan UI yang lebih baik. Untuk keluaran yang ditujukan kepada pengguna, utamakan vim.notify daripada print mentah.

Beberapa pemanggilan API tidak diizinkan dalam konteks peristiwa cepat, misalnya di dalam callback tertentu. vim.schedule menunda sebuah fungsi hingga putaran utama, tempat seluruh API aman digunakan.

Hal ini mencegah kesalahan menakutkan "E5560" saat buffer diubah dari konteks asinkron atau perintah otomatis.

nvim_create_autocmd mendaftarkan penangan peristiwa. Kelompokkan perintah tersebut dengan nvim_create_augroup dan atur clear = true untuk menghindari duplikasi saat dimuat ulang.

Callback menerima tabel peristiwa dengan bidang seperti buf dan match, sehingga penangan Anda mendapatkan konteks yang presisi.

Neovim menyediakan pustaka standar yang lengkap. vim.tbl_extend, vim.tbl_keys, dan vim.split mencakup operasi umum pada tabel dan string.

vim.tbl_deep_extend('force', defaults, opts) adalah cara standar untuk menggabungkan konfigurasi pengguna di atas nilai bawaan plugin.

vim.inspect menserialisasi nilai Lua apa pun menjadi string yang mudah dibaca, termasuk tabel bertingkat. Inilah cara tercepat untuk memahami bentuk nilai kembalian API.

Gunakan bersama :lua print(vim.inspect(...)) atau :lua= expr di Neovim versi terbaru untuk melakukan pemeriksaan cepat selama pengembangan.

Utamakan vim.api untuk operasi yang stabil dan terstruktur. Gunakan vim.fn atau vim.cmd sebagai pilihan cadangan jika tidak ada fungsi bawaan.

vim.cmd menjalankan perintah ex sebagai string dan berguna untuk kebutuhan sekali pakai seperti vim.cmd('highlight ...'), tetapi hasilnya lebih sulit diperiksa daripada pemanggilan API bertipe.

Uji pemahaman Anda tentang API Lua Neovim.

Sekarang Anda mengetahui lapisan inti: vim.api untuk API asli bertipe, vim.fn untuk fungsi Vimscript, dan vim.cmd untuk perintah ex.

Opsi mengalir melalui vim.o/bo/wo, variabel melalui vim.g/b/w, dan pembantu seperti vim.tbl_deep_extend, vim.notify, serta vim.schedule melengkapi perangkat kerja pembuat plugin.