feat: when packages are filter due to engine not matching, we need to…

… print it out, just like we do in peer checks #1422
raineorshine · Jun 8, 2024 · 0db3169 · 0db3169
1 parent 0ee6c96
commit 0db3169
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 9 deletions.
diff --git a/src/lib/getIgnoredUpgradesDueToPeerDeps.ts b/src/lib/getIgnoredUpgradesDueToPeerDeps.ts
@@ -1,5 +1,5 @@
 import { satisfies } from 'semver'
-import { IgnoredUpgradeDueToPeer } from '../types/IgnoredUpgradeDueToPeer'
+import { IgnoredUpgradeDueToPeerDeps } from '../types/IgnoredUpgradeDueToPeerDeps'
 import { Index } from '../types/IndexType'
 import { Options } from '../types/Options'
 import { Version } from '../types/Version'
@@ -41,7 +41,7 @@ export async function getIgnoredUpgradesDueToPeerDeps(
             ),
         },
       }),
-      {} as Index<IgnoredUpgradeDueToPeer>,
+      {} as Index<IgnoredUpgradeDueToPeerDeps>,
     )
 }
 

diff --git a/src/lib/logging.ts b/src/lib/logging.ts
@@ -3,7 +3,7 @@
  */
 import Table from 'cli-table3'
 import { IgnoredUpgradeDueToEnginesNode } from '../types/IgnoredUpgradeDueToEnginesNode'
-import { IgnoredUpgradeDueToPeer } from '../types/IgnoredUpgradeDueToPeer'
+import { IgnoredUpgradeDueToPeerDeps } from '../types/IgnoredUpgradeDueToPeerDeps'
 import { Index } from '../types/IndexType'
 import { Options } from '../types/Options'
 import { VersionResult } from '../types/VersionResult'
@@ -369,7 +369,7 @@ export async function printUpgrades(
 }
 
 /** Print updates that were ignored due to incompatible peer dependencies. */
-export function printIgnoredUpdatesDueToPeers(options: Options, ignoredUpdates: Index<IgnoredUpgradeDueToPeer>) {
+export function printIgnoredUpdatesDueToPeerDeps(options: Options, ignoredUpdates: Index<IgnoredUpgradeDueToPeerDeps>) {
   print(options, `\nIgnored incompatible updates (peer dependencies):\n`)
   const table = renderDependencyTable(
     Object.entries(ignoredUpdates).map(([pkgName, { from, to, reason }]) => {

diff --git a/src/lib/runLocal.ts b/src/lib/runLocal.ts
@@ -18,7 +18,7 @@ import keyValueBy from './keyValueBy'
 import {
   print,
   printIgnoredUpdatesDueToEnginesNode,
-  printIgnoredUpdatesDueToPeers,
+  printIgnoredUpdatesDueToPeerDeps,
   printJson,
   printSorted,
   printUpgrades,
@@ -262,10 +262,10 @@ async function runLocal(
         options,
       )
       if (Object.keys(ignoredUpdates).length > 0) {
-        printIgnoredUpdatesDueToPeers(options, ignoredUpdates)
+        printIgnoredUpdatesDueToPeerDeps(options, ignoredUpdates)
       }
     }
-    if (options.enginesNode && options.nodeEngineVersion) {
+    if (options.enginesNode) {
       const ignoredUpdates = await getIgnoredUpgradesDueToEnginesNode(current, upgraded, options)
       if (Object.keys(ignoredUpdates).length > 0) {
         printIgnoredUpdatesDueToEnginesNode(options, ignoredUpdates)

diff --git a/src/types/IgnoredUpgradeDueToPeer.ts → src/types/IgnoredUpgradeDueToPeerDeps.ts b/src/types/IgnoredUpgradeDueToPeer.ts → src/types/IgnoredUpgradeDueToPeerDeps.ts
@@ -2,7 +2,7 @@ import { Index } from './IndexType'
 import { Version } from './Version'
 
 /** An object that represents an upgrade that was ignored due to peer dependencies, along with the reason. */
-export interface IgnoredUpgradeDueToPeer {
+export interface IgnoredUpgradeDueToPeerDeps {
   from: Version
   to: Version
   reason: Index<string>

diff --git a/test/getEnginesNodeFromRegistry.test.ts b/test/getEnginesNodeFromRegistry.test.ts
@@ -0,0 +1,38 @@
+import { chalkInit } from '../src/lib/chalk'
+import getEnginesNodeFromRegistry from '../src/lib/getEnginesNodeFromRegistry'
+import chaiSetup from './helpers/chaiSetup'
+
+chaiSetup()
+
+describe('getEnginesNodeFromRegistry', function () {
+  it('single package', async () => {
+    await chalkInit()
+    const data = await getEnginesNodeFromRegistry({ del: '2.0.0' }, {})
+    data.should.deep.equal({
+      del: '>=0.10.0',
+    })
+  })
+
+  it('single package empty', async () => {
+    await chalkInit()
+    const data = await getEnginesNodeFromRegistry({ 'ncu-test-return-version': '1.0' }, {})
+    data.should.deep.equal({ 'ncu-test-return-version': undefined })
+  })
+
+  it('multiple packages', async () => {
+    await chalkInit()
+    const data = await getEnginesNodeFromRegistry(
+      {
+        'ncu-test-return-version': '1.0.0',
+        'ncu-test-peer': '1.0.0',
+        del: '2.0.0',
+      },
+      {},
+    )
+    data.should.deep.equal({
+      'ncu-test-return-version': undefined,
+      'ncu-test-peer': undefined,
+      del: '>=0.10.0',
+    })
+  })
+})
diff --git a/test/getIgnoredUpgradesDueToEnginesNode.test.ts b/test/getIgnoredUpgradesDueToEnginesNode.test.ts
@@ -0,0 +1,32 @@
+import getIgnoredUpgradesDueToEnginesNode from '../src/lib/getIgnoredUpgradesDueToEnginesNode'
+import chaiSetup from './helpers/chaiSetup'
+
+chaiSetup()
+
+describe('getIgnoredUpgradesDueToEnginesNode', function () {
+  it('ncu-test-peer-update', async () => {
+    const data = await getIgnoredUpgradesDueToEnginesNode(
+      {
+        'ncu-test-return-version': '1.0.0',
+        'ncu-test-peer': '1.0.0',
+        del: '2.2.2',
+      },
+      {
+        'ncu-test-return-version': '2.0.0',
+        'ncu-test-peer': '1.1.0',
+        del: '2.2.2',
+      },
+      {
+        enginesNode: true,
+        nodeEngineVersion: `^0.10.0`,
+      },
+    )
+    data.should.deep.equal({
+      del: {
+        enginesNode: '>=14.16',
+        from: '2.2.2',
+        to: '7.1.0',
+      },
+    })
+  })
+})
diff --git a/test/getIgnoredUpgrades.test.ts → test/getIgnoredUpgradesDueToPeerDeps.test.ts b/test/getIgnoredUpgrades.test.ts → test/getIgnoredUpgradesDueToPeerDeps.test.ts
@@ -3,7 +3,7 @@ import chaiSetup from './helpers/chaiSetup'
 
 chaiSetup()
 
-describe('getIgnoredUpgrades', function () {
+describe('getIgnoredUpgradesDueToPeerDeps', function () {
   it('ncu-test-peer-update', async () => {
     const data = await getIgnoredUpgradesDueToPeerDeps(
       {