use package.json for node-version

Author: abraham

.github/workflows/copilot-setup-steps.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v7
         with:
-          node-version: 22
+          node-version-file: package.json
 
       - name: Install dependencies
         run: npm ci

.github/workflows/deploy-preview.yaml

@@ -7,7 +7,7 @@ jobs:
       - uses: actions/checkout@v7
       - uses: actions/setup-node@v7
         with:
-          node-version: 22
+          node-version-file: package.json
       - name: Create temp serviceAccount.json
         run: echo "{}" > serviceAccount.json
       - run: npm ci

.github/workflows/deploy.yaml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v7
       - uses: actions/setup-node@v7
         with:
-          node-version: 22
+          node-version-file: package.json
       - name: Create temp serviceAccount.json
         run: echo "{}" > serviceAccount.json
       - run: npm ci

.github/workflows/main.yaml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v7
         with:
-          node-version: 22
+          node-version-file: package.json
 
       - name: Setup Java (required by the Firestore emulator)
         if: matrix.script-name == 'test'

.nvmrc

@@ -7,5 +7,11 @@
     "packages/server/functions/package.json",
     "packages/web/package.json",
     "packages/storage/package.json"
-  ]
+  ],
+  "customTypes": {
+    "engines": {
+      "path": "engines",
+      "strategy": "versionsByName"
+    }
+  }
 }

.syncpackrc.json

@@ -28,7 +28,10 @@ const makeRepo = (): string => {
   const dir = mkdtempSync(join(tmpdir(), 'hoverboard-cli-'));
   dirsToClean.push(dir);
   mkdirSync(join(dir, '.git'));
-  writeFileSync(join(dir, '.nvmrc'), `${process.versions.node.split('.')[0]}\n`);
+  writeFileSync(
+    join(dir, 'package.json'),
+    JSON.stringify({ engines: { node: process.versions.node.split('.')[0] } }),
+  );
   process.env['HOME'] = dir; // isolate from the real firebase-tools configstore
   process.env['GCLOUD_PROJECT'] = 'demo-project';
   vi.spyOn(process, 'cwd').mockReturnValue(dir);
@@ -92,7 +95,7 @@ describe('runDeploy', () => {
 
   it('fails fast when doctor-style checks fail, without prompting', async () => {
     const repo = makeRepo();
-    writeFileSync(join(repo, '.nvmrc'), '1\n'); // no real Node major version is "1"
+    writeFileSync(join(repo, 'package.json'), JSON.stringify({ engines: { node: '1' } })); // no real Node major version is "1"
     vi.spyOn(console, 'log').mockImplementation(() => undefined);
 
     const result = await runDeploy();

packages/cli/src/commands/deploy.test.ts

@@ -26,10 +26,13 @@ const makeRepo = (): string => {
   return dir;
 };
 
+const writeEngines = (repo: string, node: string): void =>
+  writeFileSync(join(repo, 'package.json'), JSON.stringify({ engines: { node } }));
+
 describe('runDoctor', () => {
   it('returns true and prints a success summary when every check passes', async () => {
     const repo = makeRepo();
-    writeFileSync(join(repo, '.nvmrc'), `${process.versions.node.split('.')[0]}\n`);
+    writeEngines(repo, String(parseInt(process.versions.node, 10)));
     process.env['GCLOUD_PROJECT'] = 'demo-project';
     isBillingEnabledMock.mockResolvedValue(true);
     vi.spyOn(process, 'cwd').mockReturnValue(repo);
@@ -41,7 +44,7 @@ describe('runDoctor', () => {
 
   it('still passes, with a warning, when the project is not on the Blaze plan', async () => {
     const repo = makeRepo();
-    writeFileSync(join(repo, '.nvmrc'), `${process.versions.node.split('.')[0]}\n`);
+    writeEngines(repo, String(parseInt(process.versions.node, 10)));
     process.env['GCLOUD_PROJECT'] = 'demo-project';
     isBillingEnabledMock.mockResolvedValue(false);
     vi.spyOn(process, 'cwd').mockReturnValue(repo);
@@ -53,7 +56,7 @@ describe('runDoctor', () => {
 
   it('returns false and prints a failure summary when a check fails', async () => {
     const repo = makeRepo();
-    writeFileSync(join(repo, '.nvmrc'), '1\n'); // no real Node major version is "1"
+    writeEngines(repo, '1'); // no real Node major version is "1"
     delete process.env['GCLOUD_PROJECT'];
     vi.spyOn(process, 'cwd').mockReturnValue(repo);
     const logSpy = vi.spyOn(console, 'log').mockImplementation(() => undefined);

packages/cli/src/commands/doctor.test.ts

@@ -27,7 +27,10 @@ const makeRepo = (): string => {
   const dir = mkdtempSync(join(tmpdir(), 'hoverboard-cli-'));
   dirsToClean.push(dir);
   mkdirSync(join(dir, '.git'));
-  writeFileSync(join(dir, '.nvmrc'), `${process.versions.node.split('.')[0]}\n`);
+  writeFileSync(
+    join(dir, 'package.json'),
+    JSON.stringify({ engines: { node: process.versions.node.split('.')[0] } }),
+  );
   process.env['HOME'] = dir; // isolate from the real firebase-tools configstore
   vi.spyOn(process, 'cwd').mockReturnValue(dir);
   return dir;
@@ -70,7 +73,7 @@ describe('runSetup', () => {
 
   it('bails out before logging in when the Node.js version is wrong', async () => {
     const repo = makeRepo();
-    writeFileSync(join(repo, '.nvmrc'), '1\n'); // no real Node major version is "1"
+    writeFileSync(join(repo, 'package.json'), JSON.stringify({ engines: { node: '1' } })); // no real Node major version is "1"
     vi.spyOn(console, 'log').mockImplementation(() => undefined);
 
     const result = await runSetup();

packages/cli/src/commands/setup.test.ts

@@ -16,6 +16,9 @@ const makeTempDir = (): string => {
   return dir;
 };
 
+const writeEngines = (root: string, node: string): void =>
+  writeFileSync(join(root, 'package.json'), JSON.stringify({ engines: { node } }));
+
 describe('findRepoRoot', () => {
   it('finds the ancestor directory containing .git', () => {
     const root = makeTempDir();
@@ -35,46 +38,53 @@ describe('findRepoRoot', () => {
 });
 
 describe('requiredNodeMajorVersion', () => {
-  it('reads the major version from .nvmrc', () => {
+  it('reads the major version from engines.node in package.json', () => {
     const root = makeTempDir();
-    writeFileSync(join(root, '.nvmrc'), '22\n');
+    writeEngines(root, '22');
 
     expect(requiredNodeMajorVersion(root)).toBe(22);
   });
 
-  it('accepts a leading "v" in .nvmrc', () => {
+  it('accepts a range in engines.node', () => {
     const root = makeTempDir();
-    writeFileSync(join(root, '.nvmrc'), 'v18.20.4');
+    writeEngines(root, '>=18.20.4');
 
     expect(requiredNodeMajorVersion(root)).toBe(18);
   });
 
-  it('returns undefined when there is no .nvmrc', () => {
+  it('returns undefined when package.json has no engines.node', () => {
+    const root = makeTempDir();
+    writeFileSync(join(root, 'package.json'), '{}');
+
+    expect(requiredNodeMajorVersion(root)).toBeUndefined();
+  });
+
+  it('returns undefined when there is no package.json', () => {
     expect(requiredNodeMajorVersion(makeTempDir())).toBeUndefined();
   });
 });
 
 describe('checkNodeVersion', () => {
   const runningMajor = Number(process.versions.node.split('.')[0]);
 
-  it('passes when the running major version matches .nvmrc', () => {
+  it('passes when the running major version matches engines.node', () => {
     const root = makeTempDir();
-    writeFileSync(join(root, '.nvmrc'), `${runningMajor}\n`);
+    writeEngines(root, String(runningMajor));
 
     const result = checkNodeVersion(root);
 
     expect(result.ok).toBe(true);
     expect(result.message).toContain(String(runningMajor));
   });
 
-  it('fails when the running major version does not match .nvmrc', () => {
+  it('fails when the running major version does not match engines.node', () => {
     const root = makeTempDir();
-    writeFileSync(join(root, '.nvmrc'), `${runningMajor + 1}\n`);
+    writeEngines(root, String(runningMajor + 1));
 
     const result = checkNodeVersion(root);
 
     expect(result.ok).toBe(false);
-    expect(result.message).toContain('nvm use');
+    expect(result.message).toContain(`nvm install ${runningMajor + 1}`);
   });
 
   it('fails when the required version cannot be determined', () => {