installed-check-core/lib/check-versions.js

Checks that all dependencies in your package.json have supported versions installed

import { checkVersionRangeCollection } from './check-version-range.js';

/**
 * @param {import('./lookup-types.d.ts').PackageJsonLike} pkg
 * @param {string} key
 * @param {import('./lookup-types.d.ts').InstalledDependencies} installed
 * @param {import('./check-version-range.js').VersionRangesOptions} options
 * @returns {import('./perform-installed-check.js').PerformInstalledCheckResult}
 */
export function checkVersions (pkg, key, installed, options) {
  /** @type {string[]} */
  const errors = [];
  /** @type {string[]} */
  const warnings = [];
  /** @type {string[]} */
  const suggestions = [];
  /** @type {import('./fix.js').Fix[]} */
  const fixes = [];

  const rangesResult = checkVersionRangeCollection(pkg, key, installed, options);

  for (const [name, rangeResult] of Object.entries(rangesResult)) {
    for (const result of [rangeResult, ...rangeResult.packageNotes]) {
      if (result.note) {
        (result.valid === false ? errors : warnings).push(('name' in result ? `${result.name}: ` : '') + result.note);
      }
    }

    const {
      childKey,
      suggested,
      topKey,
      valid,
    } = rangeResult;

    if (!valid) {
      suggestions.push((
        suggested
          ? `Combined "${name}" needs to be narrower: ${suggested}`
          : `Incompatible combined "${name}" requirements.`
      ));
    }

    if (suggested) {
      fixes.push({
        childKey,
        suggested,
        topKey,
      });
    }
  }

  return {
    errors: [...new Set(errors)],
    warnings: [...new Set(warnings)],
    suggestions,
    fixes,
  };
}