Skip to content

Commit

Permalink
feat: when packages are filter due to engine not matching, we need to…
Browse files Browse the repository at this point in the history
… print it out, just like we do in peer checks #1422
  • Loading branch information
rbnayax committed Jun 15, 2024
1 parent d127cbd commit 8730143
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions src/lib/getEnginesNodeFromRegistry.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ProgressBar from 'progress'
import { Index } from '../types/IndexType'
import { Options } from '../types/Options'
import { Version } from '../types/Version'
import { VersionSpec } from '../types/VersionSpec'
import getPackageManager from './getPackageManager'

/**
Expand All @@ -11,7 +11,7 @@ import getPackageManager from './getPackageManager'
* @param [options={}] Options.
* @returns Promised {packageName: engines.node} collection
*/
async function getEnginesNodeFromRegistry(packageMap: Index<Version>, options: Options) {
async function getEnginesNodeFromRegistry(packageMap: Index<VersionSpec>, options: Options) {
const packageManager = getPackageManager(options, options.packageManager)
if (!packageManager.getEngines) return {}

Expand All @@ -29,7 +29,7 @@ async function getEnginesNodeFromRegistry(packageMap: Index<Version>, options: O
}
const accum = await accumPromise
return { ...accum, [pkg]: enginesNode }
}, Promise.resolve<Index<Version | undefined>>({}))
}, Promise.resolve<Index<VersionSpec | undefined>>({}))
}

export default getEnginesNodeFromRegistry
2 changes: 1 addition & 1 deletion src/lib/getIgnoredUpgradesDueToEnginesNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import getEnginesNodeFromRegistry from './getEnginesNodeFromRegistry'
import upgradePackageDefinitions from './upgradePackageDefinitions'

/** Checks if package.json min node version satisfies given package engine.node spec */
const satisfiesNodeEngine = (enginesNode: Maybe<Version>, optionsEnginesNodeMinVersion: string) =>
const satisfiesNodeEngine = (enginesNode: Maybe<VersionSpec>, optionsEnginesNodeMinVersion: Version) =>
!enginesNode || satisfies(optionsEnginesNodeMinVersion, enginesNode)

/** Get all upgrades that are ignored due to incompatible engines.node. */
Expand Down
2 changes: 1 addition & 1 deletion src/package-managers/npm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,7 @@ export const getEngines = async (
version: Version,
options: Options = {},
npmConfigLocal?: NpmConfig,
): Promise<Index<Version | undefined>> => {
): Promise<Index<VersionSpec | undefined>> => {
const result = await fetchPartialPackument(
packageName,
[`engines`],
Expand Down
3 changes: 2 additions & 1 deletion src/types/IgnoredUpgradeDueToEnginesNode.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { Version } from './Version'
import { VersionSpec } from './VersionSpec'

/** An object that represents an upgrade that was ignored due to mismatch of engines.node */
export interface IgnoredUpgradeDueToEnginesNode {
from: Version
to: Version
enginesNode: Version
enginesNode: VersionSpec
}

0 comments on commit 8730143

Please sign in to comment.