Persisting Automatic NVM Version Switching in VS Code

Sean Hannity

2 min read

·

09-11-2024

18

0

Share

Managing multiple Node.js versions can be challenging, especially when working on different projects that require specific versions. Using Node Version Manager (NVM) in conjunction with Visual Studio Code (VS Code) can streamline this process. This guide will walk you through the steps to persistently switch Node.js versions automatically within VS Code based on your project requirements.

Understanding NVM

Node Version Manager (NVM) is a tool that allows you to install and manage multiple versions of Node.js on your machine. By setting a specific Node version for a project, you ensure that everyone working on the project uses the same version, reducing compatibility issues.

Setting Up NVM

Before proceeding, ensure that you have NVM installed on your system. You can follow the official NVM installation guide for your operating system. Once installed, you can install different versions of Node.js using the command:

nvm install <version>

Example:

To install Node.js version 14.17.0, run:

nvm install 14.17.0

Creating a .nvmrc File

To enable automatic switching of Node versions, create a .nvmrc file in your project’s root directory. This file should contain the version number of Node.js you want to use for that specific project.

Example:

14.17.0

Automatically Switch Node Version in VS Code

To ensure that VS Code automatically switches to the Node version specified in your .nvmrc file, you will need to use a combination of terminal settings and an extension.

Step 1: Use Integrated Terminal in VS Code

1. Open VS Code.
2. Go to File -> Preferences -> Settings or use the shortcut Ctrl + ,.
3. Search for "terminal integrated shell". Set the appropriate shell based on your OS (e.g., PowerShell, Command Prompt for Windows, or Terminal for macOS/Linux).

Step 2: Install the NVM Extension

To automate the loading of the specified Node version from your .nvmrc, consider installing the NVM for Windows or NVM extension depending on your platform.

1. Open the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window.
2. Search for "NVM" and install the extension that suits your operating system.

Step 3: Configure VS Code to Read .nvmrc

Now, you need to configure your terminal in VS Code to read the .nvmrc file and switch to the appropriate Node version automatically.

For Linux and macOS Users:

Add the following lines to your terminal profile (like .bashrc, .bash_profile, or .zshrc):

nvm use

This command will check for the .nvmrc file in the current directory when you open a new terminal session.

For Windows Users:

If you are using the NVM for Windows, open a Command Prompt or PowerShell window and run:

nvm use

You can also include this command in your profile script.

Conclusion

With the steps above, you should now have a setup that allows VS Code to automatically switch Node.js versions based on the .nvmrc file in your project. This will help ensure consistency across different development environments, making collaboration smoother.

By leveraging NVM and VS Code, you can effectively manage multiple Node.js projects without worrying about version mismatches.