Mengonfigurasi nvmrc

Pengenalan

Saat mengembangkan beberapa proyek, setiap proyek mungkin memerlukan versi Node.js yang berbeda. Dalam kasus seperti ini, kita perlu menentukan versi Node.js untuk setiap proyek dengan menjalankan perintah nvm install dan nvm use di terminal untuk menginstal dan beralih versi.

Namun, menjalankan perintah secara manual di terminal setiap kali menjadi merepotkan, terutama seiring bertambahnya jumlah proyek. Mudah lupa untuk beralih versi atau beralih ke versi yang salah, yang dapat menyebabkan proyek gagal dimulai atau mengalami kesalahan saat runtime.

Di sinilah kita memerlukan metode untuk mengelola versi Node.js dan secara otomatis beralih di antara mereka, dan di sinilah .nvmrc berperan.

Apa itu .nvmrc?

Dari penjelasan di atas, Anda dapat memahami bahwa file .nvmrc digunakan untuk mengelola versi Node.js untuk proyek kita. File ini sangat sederhana: hanya berisi teks yang mewakili versi Node.js yang dapat dikenali oleh nvm, seperti v18.12.0.

Bagaimana cara menggunakan file .nvmrc?

Anda dapat membuat file .nvmrc dengan konten yang merupakan nomor versi Node.js atau teks lain yang dapat dipahami oleh nvm. Untuk detailnya, Anda dapat mengetik nvm --help di terminal.

Dengan file .nvmrc, ketika Anda menjalankan perintah seperti nvm use, nvm install, nvm exec, nvm run, dan nvm which di terminal tanpa menentukan versi, versi yang ditentukan dalam file .nvmrc akan digunakan.

Membuat file .nvmrc

Sebagai contoh, di direktori saat ini, untuk membuat nvm menentukan rilis terbaru dari versi 18.12, versi LTS terbaru, atau versi Node.js terbaru, Anda dapat menggunakan perintah echo untuk membuat file .nvmrc:

$ echo "18.12" > .nvmrc
# Tetapkan ke versi LTS terbaru
$ echo "lts/*" > .nvmrc
# Tetapkan ke versi terbaru
$ echo "node" > .nvmrc

Perintah seperti nvm use akan menelusuri struktur direktori ke atas dari direktori saat ini mencari file .nvmrc. Ini berarti bahwa menjalankan perintah seperti nvm use di subdirektori mana pun dari direktori dengan file .nvmrc masih akan menggunakan file .nvmrc tersebut.

File .nvmrc harus berisi <version> yang sesuai dengan yang tercantum di nvm --help, diikuti oleh baris baru. Spasi trailing tidak diizinkan, dan baris baru trailing diperlukan.

Seperti yang ditunjukkan pada gambar di bawah, tidak ada spasi setelah v14.21.3, hanya jeda baris.

Integrasi mendalam dengan terminal shell

Anda dapat menggunakan avn untuk berintegrasi secara mendalam dengan shell Anda dan secara otomatis memanggil nvm saat mengubah direktori.

Jika Anda lebih suka solusi ringan, Anda dapat menggunakan metode di bawah ini.

Beralih otomatis versi Node.js di terminal zsh berdasarkan file .nvmrc

Setelah menambahkan kode berikut ke $HOME/.zshrc Anda, nvm use akan secara otomatis dipanggil setiap kali Anda memasuki direktori yang berisi file .nvmrc. String dalam file .nvmrc memberi tahu nvm versi Node.js mana yang akan digunakan.

# Buka direktori home dan edit file .zshrc
$ cd
$ vi .zshrc

Ini adalah kode yang perlu ditulis ke .zshrc:

# Salin segmen kode ini ke file .zshrc
# tempatkan ini setelah inisialisasi nvm!
autoload -U add-zsh-hook
load-nvmrc() {
  local nvmrc_path="$(nvm_find_nvmrc)"

  if [ -n "$nvmrc_path" ]; then
    local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")

    if [ "$nvmrc_node_version" = "N/A" ]; then
      nvm install
    elif [ "$nvmrc_node_version" != "$(nvm version)" ]; then
      nvm use
    fi
  elif [ -n "$(PWD=$OLDPWD nvm_find_nvmrc)" ] && [ "$(nvm version)" != "$(nvm version default)" ]; then
    echo "Reverting to nvm default version"
    nvm use default
  fi
}
add-zsh-hook chpwd load-nvmrc
load-nvmrc

Setelah mengedit file .zshrc, jalankan source .zshrc untuk membuat perintah berlaku:

$ source ~/.zshrc

Di proyek dengan file .nvmrc, ketika Anda membuka terminal terintegrasi di vscode, Anda akan menemukan bahwa nvm use secara otomatis dieksekusi, dengan output yang sesuai di baris perintah.