feat: add option to ignore future releases

Author: jenseng

index.d.ts

@@ -2,7 +2,8 @@ interface Options {
   now?: Date;
   cache?: Map<any, any>;
   mirror?: string;
-  latestOfMajorOnly?: Boolean
+  latestOfMajorOnly?: Boolean;
+  ignoreFutureReleases?: Boolean;
 }
 
 interface VersionInfo {

index.js

@@ -8,9 +8,10 @@ module.exports = async function (alias = 'lts_active', opts = {}) {
   const cache = opts.cache || _cache
   const mirror = opts.mirror || 'https://nodejs.org/dist/'
   const latestOfMajorOnly = opts.latestOfMajorOnly || false
+  const ignoreFutureReleases = opts.ignoreFutureReleases || false
 
   const a = Array.isArray(alias) ? alias : [alias]
-  const versions = await getLatestVersionsByCodename(now, cache, mirror)
+  const versions = await getLatestVersionsByCodename(now, cache, mirror, ignoreFutureReleases)
 
   // Reduce to an object
   let m = a.reduce((m, a) => {
@@ -70,7 +71,7 @@ function getVersions (cache, mirror) {
   }).json()
 }
 
-async function getLatestVersionsByCodename (now, cache, mirror) {
+async function getLatestVersionsByCodename (now, cache, mirror, ignoreFutureReleases) {
   const schedule = await getSchedule(cache)
   const versions = await getVersions(cache, mirror)
 
@@ -112,6 +113,11 @@ async function getLatestVersionsByCodename (now, cache, mirror) {
       }
     }
 
+    // This version is from future; completely ignore it (i.e. we may have specified a `now` from the past)
+    if (ignoreFutureReleases && now < v.releaseDate) {
+      return obj
+    }
+
     // All versions get added to all
     obj.all.push(v)
 

test/index.js

@@ -177,4 +177,20 @@ suite('nv', () => {
     assert.strictEqual(versions[0].major, 0)
     assert.strictEqual(versions[0].isLts, false)
   })
+
+  test('ignoreFutureReleases=false', async () => {
+    const versions = await nv('v8', { now, ignoreFutureReleases: false })
+    assert.strictEqual(versions.length, 1)
+    assert.strictEqual(versions[0].major, 8)
+    assert.strictEqual(versions[0].minor, 17)
+    assert.strictEqual(versions[0].patch, 0)
+  })
+
+  test('ignoreFutureReleases=true', async () => {
+    const versions = await nv('v8', { now, ignoreFutureReleases: true })
+    assert.strictEqual(versions.length, 1)
+    assert.strictEqual(versions[0].major, 8)
+    assert.strictEqual(versions[0].minor, 16)
+    assert.strictEqual(versions[0].patch, 1)
+  })
 })