1 min read

REQUIRE_NODE_VERSION_FILE

Requires that workspaces have a valid Node.js version file (`.node-version` or `.nvmrc`) file defined.
Table of Contents

Conformance is available on Enterprise plans

This rule is available from version 1.2.0.

Using a Node.js version file (.node-version or .nvmrc) ensures that all developers and tooling (e.g., CI systems) use the same version of Node.js. This practice helps to avoid inconsistencies between environments and can even prevent bugs from being shipped to production.

As another benefit, committing a Node.js version file improves developer experience, as many Node.js version management tools can automatically detect and use the version defined in the file. This includes GitHub Actions, and popular Node.js version managers such as fnm and nvm.

This rule also validates to ensure that the version in the file is defined in a way that is compatible with common tooling.

By default, this rule is disabled. To enable it, refer to customizing Conformance.

If you hit this issue, you can resolve it by adding a Node.js version file at the root of your workspace.

The example .node-version file below requires that Node.js 20.9 is used in the workspace, allowing for any patch version (i.e. 20.9.1). The level of strictness can be adjusted based on your teams needs.

.node-version
v20.9
Last updated on May 27, 2024