Support .nvmrc

.github/workflows/version-file-workflow.yml

@@ -0,0 +1,33 @@
+
+
+name: version-file-test
+
+
+on:
+
+  push:
+    branches: [ add-node-version-file-support ]
+    paths-ignore:
+      - '**.md'  
+  pull_request:
+     paths-ignore:
+      - '**.md'  
+
+
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node test
+        uses: ./
+        with:
+          node-version-file: '.nvmrc'
+      - run: npm ci
+      - run: npm run build

.nvmrc

@@ -0,0 +1 @@
+lts/*

README.md

@@ -1,5 +1,4 @@
 # setup-node
-
 <p align="left">
   <a href="https://github.com/actions/setup-node/actions?query=workflow%3Abuild-test"><img alt="build-test status" src="https://github.com/actions/setup-node/workflows/build-test/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aversions"><img alt="versions status" src="https://github.com/actions/setup-node/workflows/versions/badge.svg"></a> <a href="https://github.com/actions/setup-node/actions?query=workflow%3Aproxy"><img alt="proxy status" src="https://github.com/actions/setup-node/workflows/proxy/badge.svg"></a> 
 </p>
@@ -72,6 +71,21 @@ steps:
 - run: npm test
 ```
 
+**Node version file:**
+
+The `node-version-file` input allows you to use a file within your repository which contains the version of node your project uses for example `.nvmrc`. If both the `node-version` and the `node-version-file` inputs are provided the `node-version` input is used.
+> The node version file is read from the project root
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: actions/setup-node@v2
+  with:
+    node-version-file: '.nvmrc'
+- run: npm install
+- run: npm test
+```
+
 ## Matrix Testing:
 ```yaml
 jobs:

__tests__/installer.test.ts

@@ -6,11 +6,12 @@ import cp from 'child_process';
 import osm = require('os');
 import path from 'path';
 import * as main from '../src/main';
-import * as im from '../src/installer';
 import * as auth from '../src/authutil';
-
 let nodeTestManifest = require('./data/versions-manifest.json');
 let nodeTestDist = require('./data/node-dist-index.json');
+import * as nv from '../src/installer';
+
+
 
 describe('setup-node', () => {
   let inputs = {} as any;
@@ -31,9 +32,11 @@ describe('setup-node', () => {
   let dbgSpy: jest.SpyInstance;
   let whichSpy: jest.SpyInstance;
   let existsSpy: jest.SpyInstance;
+  let readFileSyncSpy: jest.SpyInstance;
   let mkdirpSpy: jest.SpyInstance;
   let execSpy: jest.SpyInstance;
   let authSpy: jest.SpyInstance;
+  let parseNodeVersionSpy: jest.SpyInstance;
 
   beforeEach(() => {
     // @actions/core
@@ -57,11 +60,13 @@ describe('setup-node', () => {
     exSpy = jest.spyOn(tc, 'extractTar');
     cacheSpy = jest.spyOn(tc, 'cacheDir');
     getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo');
-    getDistSpy = jest.spyOn(im, 'getVersionsFromDist');
+    getDistSpy = jest.spyOn(nv, 'getVersionsFromDist');
+    parseNodeVersionSpy = jest.spyOn(nv, 'parseNodeVersionFile');
 
     // io
     whichSpy = jest.spyOn(io, 'which');
     existsSpy = jest.spyOn(fs, 'existsSync');
+    readFileSyncSpy = jest.spyOn(fs, 'readFileSync');
     mkdirpSpy = jest.spyOn(io, 'mkdirP');
 
     // disable authentication portion for installer tests
@@ -72,7 +77,7 @@ describe('setup-node', () => {
     getManifestSpy.mockImplementation(
       () => <tc.IToolRelease[]>nodeTestManifest
     );
-    getDistSpy.mockImplementation(() => <im.INodeVersion>nodeTestDist);
+    getDistSpy.mockImplementation(() => <nv.INodeVersion>nodeTestDist);
 
     // writes
     cnSpy = jest.spyOn(process.stdout, 'write');
@@ -117,7 +122,7 @@ describe('setup-node', () => {
   });
 
   it('can mock dist versions', async () => {
-    let versions: im.INodeVersion[] = await im.getVersionsFromDist();
+    let versions: nv.INodeVersion[] = await nv.getVersionsFromDist();
     expect(versions).toBeDefined();
     expect(versions?.length).toBe(23);
   });
@@ -549,12 +554,57 @@ describe('setup-node', () => {
     });
   });
 
+  describe('node-version-file flag', () => {
+    it('Not used if node-version is provided', async () => {
+      // Arrange
+      inputs['node-version'] = '12';
+
+      // Act
+      await main.run();
+
+      // Assert
+      expect(readFileSyncSpy).toHaveBeenCalledTimes(0);
+    });
+
+    it('Not used if node-version-file not provided', async () => {
+      // Act
+      await main.run();
+
+      // Assert
+      expect(readFileSyncSpy).toHaveBeenCalledTimes(0);
+    });
+
+    it('Reads node-version-file if provided', async () => {
+      // Arrange
+      const versionSpec = 'v12';
+      const versionFile = '.nvmrc';
+      const expectedVersionSpec = '12';
+
+      inputs['node-version-file'] = versionFile;
+
+      readFileSyncSpy.mockImplementation(() => versionSpec);
+      parseNodeVersionSpy.mockImplementation(() => expectedVersionSpec);
+
+      // Act
+      await main.run();
+
+      // Assert
+      expect(readFileSyncSpy).toHaveBeenCalledTimes(1);
+      expect(readFileSyncSpy).toHaveBeenCalledWith(
+        path.join(__dirname, '..', versionFile),
+        'utf8'
+      );
+      expect(parseNodeVersionSpy).toHaveBeenCalledWith(versionSpec);
+      expect(logSpy).toHaveBeenCalledWith(
+        `Resolved ${versionFile} as ${expectedVersionSpec}`);
+     });
   describe('LTS version', () => {
     beforeEach(() => {
       os.platform = 'linux';
       os.arch = 'x64';
       inputs.stable = 'true';
     });
+
 
     it('find latest LTS version and resolve it from local cache (lts/erbium)', async () => {
       // arrange
@@ -767,3 +817,89 @@ describe('setup-node', () => {
     });
   });
 });
+
+describe('node-version-file', () => {
+  let getVersionsFromDist: jest.SpyInstance;
+
+  beforeEach(() => {
+    // @actions/core
+    console.log('::stop-commands::stoptoken'); // Disable executing of runner commands when running tests in actions
+
+    getVersionsFromDist = jest.spyOn(nv, 'getVersionsFromDist');
+
+    // gets
+    getVersionsFromDist.mockImplementation(() => <nv.INodeVersion>nodeTestDist);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    //jest.restoreAllMocks();
+  });
+
+  afterAll(async () => {
+    console.log('::stoptoken::'); // Re-enable executing of runner commands when running tests in actions
+  }, 100000);
+
+  //--------------------------------------------------
+  // Manifest find tests
+  //--------------------------------------------------
+  describe('parseNodeVersionFile', () => {
+    it('without `v` prefix', async () => {
+      // Arrange
+      const versionSpec = '12';
+
+      // Act
+      const result = await nv.parseNodeVersionFile(versionSpec);
+
+      // Assert
+      expect(result).toBe(versionSpec);
+    });
+
+    it('lts/*', async () => {
+      // Arrange
+      const versionSpec = 'lts/*';
+
+      // Act
+      const result = await nv.parseNodeVersionFile(versionSpec);
+
+      // Assert
+      expect(result).toMatch(/^\d+\.\d+\.\d+$/);
+    });
+
+    it('lts/erbium', async () => {
+      // Arrange
+      const versionSpec = 'lts/*';
+
+      // Act
+      const result = await nv.parseNodeVersionFile(versionSpec);
+
+      // Assert
+      expect(result).toMatch(/\d\.\d\.\d/);
+    });
+
+    it('partial syntax like 12', async () => {
+      // Arrange
+      const versionSpec = '12';
+
+      // Act
+      const result = await nv.parseNodeVersionFile(versionSpec);
+
+      // Assert
+      expect(result).toBe(versionSpec);
+    });
+
+    it('partial syntax like 12.16', async () => {
+      // Arrange
+      const versionSpec = '12.16';
+
+      // Act
+      const result = await nv.parseNodeVersionFile(versionSpec);
+
+      // Assert
+      expect(result).toBe(versionSpec);
+    });
+  });
+});
+
+});

action.yml

@@ -7,6 +7,8 @@ inputs:
     default: 'false'
   node-version:
     description: 'Version Spec of the version to use.  Examples: 12.x, 10.15.1, >=10.15.0'
+  node-version-file:
+    description: 'File containing the version Spec of the version to use.  Examples: .nvmrc'
   architecture:
     description: 'Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default.'
   check-latest: