feat(debug): Added a --debug cli flag

This option prints each package.json that is parsed, and the peer deps found in each one

Author: christopherthielen

src/checkPeerDependencies.ts

@@ -2,12 +2,13 @@
 import * as semver from 'semver';
 
 import { exec } from 'shelljs';
+import { CliOptions } from './cli';
 import { getCommandLines } from './packageManager';
 import { Dependency, gatherPeerDependencies, getInstalledVersion } from './packageUtils';
 import { findPossibleResolutions } from './solution';
 
-function getAllNestedPeerDependencies() {
-  const gatheredDependencies = gatherPeerDependencies(".");
+function getAllNestedPeerDependencies(options: CliOptions) {
+  const gatheredDependencies = gatherPeerDependencies(".", options);
 
   const allNestedPeerDependencies: Dependency[] = gatheredDependencies.map(dep => {
     const installedVersion = getInstalledVersion(dep);
@@ -22,8 +23,8 @@ function getAllNestedPeerDependencies() {
 
 let recursiveCount = 0;
 
-export function checkPeerDependencies(packageManager: string, installMissingPeerDependencies: boolean) {
-  const allNestedPeerDependencies = getAllNestedPeerDependencies();
+export function checkPeerDependencies(packageManager: string, options: CliOptions) {
+  const allNestedPeerDependencies = getAllNestedPeerDependencies(options);
 
   allNestedPeerDependencies.forEach(dep => {
     if (dep.semverSatisfies) {
@@ -66,7 +67,7 @@ export function checkPeerDependencies(packageManager: string, installMissingPeer
   }
 
   const commandLines = getCommandLines(packageManager, installs, upgrades);
-  if (installMissingPeerDependencies && commandLines.length > 0) {
+  if (options.install && commandLines.length > 0) {
     console.log('Installing peerDependencies...');
     console.log();
     commandLines.forEach(command => {
@@ -75,7 +76,7 @@ export function checkPeerDependencies(packageManager: string, installMissingPeer
       console.log();
     });
 
-    const newUnsatisfiedDeps = getAllNestedPeerDependencies()
+    const newUnsatisfiedDeps = getAllNestedPeerDependencies(options)
         .filter(dep => !dep.semverSatisfies)
         .filter(dep => !nosolution.some(x => isSameDep(x.problem, dep)));
 
@@ -86,7 +87,7 @@ export function checkPeerDependencies(packageManager: string, installMissingPeer
     if (newUnsatisfiedDeps.length > 0) {
       console.log(`Found ${newUnsatisfiedDeps.length} new unmet peerDependencies...`);
       if (++recursiveCount < 5) {
-        return checkPeerDependencies(packageManager, installMissingPeerDependencies);
+        return checkPeerDependencies(packageManager, options);
       } else {
         console.error('Recursion limit reached (5)');
         process.exit(5)

src/cli.ts

@@ -18,6 +18,10 @@ const options: CliOptions = yarrrrgs
       boolean: true,
       description: `Use npm package manager`,
     })
+    .option('debug', {
+      boolean: true,
+      description: 'Print debugging information'
+    })
     .option('install', {
       boolean: true,
       description: 'Install missing or incorrect peerDependencies'
@@ -32,6 +36,7 @@ const options: CliOptions = yarrrrgs
 export interface CliOptions {
     help: boolean;
     yarn: boolean;
+    debug: boolean;
     npm: boolean;
     install: boolean;
 }
@@ -41,4 +46,4 @@ if (options.help) {
 }
 
 const packageManager = getPackageManager(options.yarn, options.npm);
-checkPeerDependencies(packageManager, options.install);
+checkPeerDependencies(packageManager, options);

src/packageUtils.ts

@@ -1,6 +1,7 @@
 import * as fs from 'fs';
 import * as path from "path";
 import * as resolve from 'resolve';
+import { CliOptions } from './cli';
 import { readJson } from './readJson';
 
 interface PackageJson {
@@ -37,20 +38,27 @@ interface PackageDependencies {
 
 type DependencyWalkVisitor = (packagePath: string, packageJson: PackageJson, packageDependencies: PackageDependencies) => void;
 
-export function gatherPeerDependencies(packagePath): Dependency[] {
+export function gatherPeerDependencies(packagePath, options: CliOptions): Dependency[] {
   let peerDeps = [];
-
-  walkPackageDependencyTree(packagePath, (path, json, deps) => {
-    peerDeps = peerDeps.concat(deps.peerDependencies)
-  }, []);
+  const visitor: DependencyWalkVisitor = (path, json, deps) => {
+    peerDeps = peerDeps.concat(deps.peerDependencies);
+  };
+  walkPackageDependencyTree(packagePath, visitor, [], options);
 
   // Eliminate duplicates
+  const isSame = (dep: Dependency, dep2: Dependency) => {
+    return dep.name === dep2.name
+        && dep.version === dep2.version
+        && dep.depender === dep2.depender
+        && dep.dependerVersion === dep2.dependerVersion;
+  };
+
   return peerDeps.reduce((acc: Dependency[], dep: Dependency) => {
-    return acc.some(dep2 => dep.name === dep2.name && dep.version === dep2.version) ? acc : acc.concat(dep);
+    return acc.some(dep2 => isSame(dep, dep2)) ? acc : acc.concat(dep);
   }, [] as Dependency[])
 }
 
-export function walkPackageDependencyTree(packagePath: string, visitor: DependencyWalkVisitor, visitedPaths: string[]) {
+export function walkPackageDependencyTree(packagePath: string, visitor: DependencyWalkVisitor, visitedPaths: string[], options: CliOptions) {
   if (visitedPaths.includes(packagePath)) {
     return;
   }
@@ -65,6 +73,10 @@ export function walkPackageDependencyTree(packagePath: string, visitor: Dependen
   const packageJson = readJson(packageJsonPath) as PackageJson;
   const packageDependencies = getPackageDependencies(packagePath, packageJson);
 
+  if (options.debug) {
+    console.log(packageJsonPath);
+    packageDependencies.peerDependencies.forEach(dep => console.log(dep))
+  }
   visitor(packagePath, packageJson, packageDependencies);
 
   function walkDependency(dependency) {
@@ -76,7 +88,7 @@ export function walkPackageDependencyTree(packagePath: string, visitor: Dependen
     if (!dependencyPath) {
       throw new Error(`Unable to resolve package ${dependency.name} from ${packagePath}`)
     }
-    walkPackageDependencyTree(dependencyPath, visitor, visitedPaths);
+    walkPackageDependencyTree(dependencyPath, visitor, visitedPaths, options);
   }
 
   packageDependencies.dependencies.forEach(walkDependency);
@@ -121,6 +133,7 @@ export function resolvePackageDir(basedir: string, packageName: string) {
     // As long as we have a packagePath, it's fine
   }
 
+  // noinspection JSUnusedAssignment
   return packagePath;
 }