feat: show list of packages containing each dependency version (#198)

bmish · web-flow · commit d23eab9ef1f6 · 2021-09-08T16:29:20.000-07:00
diff --git a/README.md b/README.md
@@ -43,20 +43,20 @@ If there are any dependency mismatches, the program will exit with failure and o
 
 ```pt
 Found 2 dependencies with mismatching versions across the workspace.
-╔════════╤════════╗
-║ eslint │ Usages ║
-╟────────┼────────╢
-║ ^7.0.0 │ 5      ║
-╟────────┼────────╢
-║ ^8.0.0 │ 1      ║
-╚════════╧════════╝
-╔═════════╤════════╗
-║ globby  │ Usages ║
-╟─────────┼────────╢
-║ ^7.1.1  │ 1      ║
-╟─────────┼────────╢
-║ ^11.0.0 │ 2      ║
-╚═════════╧════════╝
+╔════════╤════════╤═════════════════════════════╗
+║ eslint │ Usages │ Packages                    ║
+╟────────┼────────┼─────────────────────────────╢
+║ ^7.0.0 │ 5      │ foo, bar, baz, and 2 others ║
+╟────────┼────────┼─────────────────────────────╢
+║ ^8.0.0 │ 1      │ @some-scope/package-name    ║
+╚════════╧══════════════════════════════════════╝
+╔═════════╤════════╤════════════════════════════════════════╗
+║ globby  │ Usages │ Packages                               ║
+╟─────────┼────────┼────────────────────────────────────────╢
+║ ^7.1.1  │ 1      │ packages/my-favorite-package           ║
+╟─────────┼────────┼────────────────────────────────────────╢
+║ ^11.0.0 │ 2      │ packages/hello-world, packages/foo-bar ║
+╚═════════╧════════╧════════════════════════════════════════╝
 ```
 
 ## Options
diff --git a/lib/dependency-versions.ts b/lib/dependency-versions.ts
@@ -3,17 +3,18 @@ import type { PackageJson } from 'type-fest';
 import { getPackageJsonPaths } from './workspace.js';
 import semver from 'semver';
 import editJsonFile from 'edit-json-file';
+import { dirname, relative } from 'node:path';
 
 export type DependenciesToVersionsSeen = Map<
   string,
-  { title: string; version: string }[]
+  { packageName: string; version: string }[]
 >;
 
 export type MismatchingDependencyVersions = Array<{
   dependency: string;
   versions: {
     version: string;
-    count: number;
+    packages: string[];
   }[];
 }>;
 
@@ -24,12 +25,12 @@ export type MismatchingDependencyVersions = Array<{
  *
  * {
  *  'ember-cli': [
- *     { title: '@scope/package1/package.json', version: '~3.18.0' },
- *     { title: '@scope/package2/package.json', version: '~3.18.0' }
+ *     { packageName: '@scope/package1', version: '~3.18.0' },
+ *     { packageName: '@scope/package2', version: '~3.18.0' }
  *  ]
  *  'eslint': [
- *     { title: '@scope/package1/package.json', version: '^7.0.0' },
- *     { title: '@scope/package2/package.json', version: '^7.0.0' }
+ *     { packageName: '@scope/package1', version: '^7.0.0' },
+ *     { packageName: '@scope/package2', version: '^7.0.0' }
  *  ]
  * }
  */
@@ -38,7 +39,7 @@ export function calculateVersionsForEachDependency(
 ): DependenciesToVersionsSeen {
   const dependenciesToVersionsSeen: DependenciesToVersionsSeen = new Map<
     string,
-    { title: string; version: string }[]
+    { packageName: string; version: string }[]
   >();
   getPackageJsonPaths(root).forEach((packageJsonPath) =>
     recordDependencyVersionsForPackageJson(
@@ -60,7 +61,7 @@ function recordDependencyVersionsForPackageJson(
     return;
   }
 
-  const title = packageJsonPath.replace(`${root}/`, '');
+  const packageName = dirname(relative(root, packageJsonPath));
   const packageJson: PackageJson = JSON.parse(
     readFileSync(packageJsonPath, 'utf-8')
   );
@@ -72,7 +73,7 @@ function recordDependencyVersionsForPackageJson(
       recordDependencyVersion(
         dependenciesToVersionsSeen,
         dependency,
-        title,
+        packageName,
         dependencyVersion
       );
     }
@@ -85,7 +86,7 @@ function recordDependencyVersionsForPackageJson(
       recordDependencyVersion(
         dependenciesToVersionsSeen,
         dependency,
-        title,
+        packageName,
         dependencyVersion
       );
     }
@@ -95,7 +96,7 @@ function recordDependencyVersionsForPackageJson(
 function recordDependencyVersion(
   dependenciesToVersionsSeen: DependenciesToVersionsSeen,
   dependency: string,
-  title: string,
+  packageName: string,
   version: string
 ) {
   if (!dependenciesToVersionsSeen.has(dependency)) {
@@ -105,7 +106,7 @@ function recordDependencyVersion(
   /* istanbul ignore if */
   if (list) {
     // `list` should always exist at this point, this if statement is just to please TypeScript.
-    list.push({ title, version });
+    list.push({ packageName, version });
   }
 }
 
@@ -125,13 +126,18 @@ export function calculateMismatchingVersions(
       const uniqueVersions = [
         ...new Set(versionList.map((obj) => obj.version)),
       ].sort();
-      const uniqueVersionsWithCounts = uniqueVersions.map((uniqueVersion) => ({
-        version: uniqueVersion,
-        count: versionList.filter((obj) => obj.version === uniqueVersion)
-          .length,
-      }));
+
       if (uniqueVersions.length > 1) {
-        return { dependency, versions: uniqueVersionsWithCounts };
+        const uniqueVersionsWithInfo = uniqueVersions.map((uniqueVersion) => {
+          const matchingVersions = versionList.filter(
+            (obj) => obj.version === uniqueVersion
+          );
+          return {
+            version: uniqueVersion,
+            packages: matchingVersions.map((obj) => obj.packageName).sort(),
+          };
+        });
+        return { dependency, versions: uniqueVersionsWithInfo };
       }
 
       return undefined;
@@ -170,9 +176,7 @@ export function fixMismatchingVersions(
   // Return any mismatching versions that are still present after attempting fixes.
   return mismatchingVersions
     .map((mismatchingVersion) => {
-      const versions = mismatchingVersion.versions.map(
-        (versionAndCount) => versionAndCount.version
-      );
+      const versions = mismatchingVersion.versions.map((obj) => obj.version);
       let sortedVersions;
       try {
         sortedVersions = versions.sort(compareRanges);
diff --git a/lib/output.ts b/lib/output.ts
@@ -12,13 +12,22 @@ export function mismatchingVersionsToOutput(
 
   const tables = mismatchingDependencyVersions
     .map((obj) => {
-      const headers = [chalk.bold(obj.dependency), 'Usages'];
+      const headers = [chalk.bold(obj.dependency), 'Usages', 'Packages'];
       const rows = obj.versions
         .sort((a, b) => compareRanges(a.version, b.version))
-        .map((versionObj) => [
-          chalk.redBright(versionObj.version),
-          versionObj.count,
-        ]);
+        .map((versionObj) => {
+          const packages =
+            versionObj.packages.length > 3
+              ? `${versionObj.packages.slice(0, 3).join(', ')}, and ${
+                  versionObj.packages.length - 3
+                } other${versionObj.packages.length - 3 === 1 ? '' : 's'}`
+              : versionObj.packages.join(', ');
+          return [
+            chalk.redBright(versionObj.version),
+            versionObj.packages.length,
+            packages,
+          ];
+        });
       return table([headers, ...rows]);
     })
     .join('');
diff --git a/test/lib/dependency-versions.ts b/test/lib/dependency-versions.ts
@@ -17,6 +17,7 @@ import {
 import mockFs from 'mock-fs';
 import { readFileSync } from 'node:fs';
 import type { PackageJson } from 'type-fest';
+import { join } from 'node:path';
 
 describe('Utils | dependency-versions', function () {
   describe('#calculateMismatchingVersions', function () {
@@ -35,25 +36,28 @@ describe('Utils | dependency-versions', function () {
           dependency: 'baz',
           versions: [
             {
-              count: 1,
               version: '^7.8.9',
+              packages: [join('scope1', 'package1')],
             },
             {
-              count: 1,
               version: '^8.0.0',
+              packages: [join('scope1', 'package2')],
             },
           ],
         },
         {
           dependency: 'foo',
           versions: [
             {
-              count: 2,
               version: '1.2.0',
+              packages: [
+                join('scope1', 'package2'),
+                join('scope1', 'package3'),
+              ],
             },
             {
-              count: 1,
               version: '1.3.0',
+              packages: [join('scope1', 'package1')],
             },
           ],
         },
@@ -94,12 +98,12 @@ describe('Utils | dependency-versions', function () {
             dependency: 'baz',
             versions: [
               {
-                count: 1,
                 version: '^7.8.9',
+                packages: [join('scope1', 'package1')],
               },
               {
-                count: 1,
                 version: '^8.0.0',
+                packages: [join('scope1', 'package2')],
               },
             ],
           },
@@ -185,12 +189,12 @@ describe('Utils | dependency-versions', function () {
             dependency: 'bar',
             versions: [
               {
-                count: 1,
                 version: '^3.0.0',
+                packages: [join('scope1', 'package1')],
               },
               {
-                count: 1,
                 version: 'invalidVersion',
+                packages: [join('scope1', 'package2')],
               },
             ],
           },
diff --git a/test/lib/output.ts b/test/lib/output.ts
@@ -10,50 +10,71 @@ describe('Utils | output', function () {
           {
             dependency: 'foo',
             versions: [
-              { version: '1.2.3', count: 1 },
-              { version: '4.5.6', count: 2 },
+              { version: '1.2.3', packages: ['foo'] },
+              { version: '4.5.6', packages: ['bar', 'baz'] },
             ],
           },
           {
             dependency: 'bar',
             versions: [
-              { version: '2.0.0', count: 4 },
-              { version: '1.4.0', count: 3 },
+              {
+                version: '2.0.0',
+                packages: ['package1', 'package2', 'package3', 'package4'],
+              },
+              {
+                version: '1.4.0',
+                packages: [
+                  'package5',
+                  'package6',
+                  'package7',
+                  'package8',
+                  'package9',
+                ],
+              },
             ],
           },
           {
             dependency: 'baz',
             versions: [
-              { version: '^2.0.0', count: 1 },
-              { version: '~2.0.0', count: 1 },
-              { version: '^1.0.0', count: 1 },
+              {
+                version: '^2.0.0',
+                packages: ['package1'],
+              },
+              {
+                version: '~2.0.0',
+                packages: ['package2'],
+              },
+              {
+                version: '^1.0.0',
+                packages: ['package3'],
+              },
             ],
           },
         ]),
         `Found 3 dependencies with mismatching versions across the workspace.
-╔═══════╤════════╗
-║ \u001B[1mfoo\u001B[22m   │ Usages ║
-╟───────┼────────╢
-║ \u001B[91m1.2.3\u001B[39m │ 1      ║
-╟───────┼────────╢
-║ \u001B[91m4.5.6\u001B[39m │ 2      ║
-╚═══════╧════════╝
-╔═══════╤════════╗
-║ \u001B[1mbar\u001B[22m   │ Usages ║
-╟───────┼────────╢
-║ \u001B[91m1.4.0\u001B[39m │ 3      ║
-╟───────┼────────╢
-║ \u001B[91m2.0.0\u001B[39m │ 4      ║
-╚═══════╧════════╝
-╔════════╤════════╗
-║ \u001B[1mbaz\u001B[22m    │ Usages ║
-╟────────┼────────╢
-║ \u001B[91m^1.0.0\u001B[39m │ 1      ║
-╟────────┼────────╢
-║ \u001B[91m~2.0.0\u001B[39m │ 1      ║
-╟────────┼────────╢
-║ \u001B[91m^2.0.0\u001B[39m │ 1      ║
-╚════════╧════════╝
+╔═══════╤════════╤══════════╗
+║ \u001B[1mfoo\u001B[22m   │ Usages │ Packages ║
+╟───────┼────────┼──────────╢
+║ \u001B[91m1.2.3\u001B[39m │ 1      │ foo      ║
+╟───────┼────────┼──────────╢
+║ \u001B[91m4.5.6\u001B[39m │ 2      │ bar, baz ║
+╚═══════╧════════╧══════════╝
+╔═══════╤════════╤════════════════════════════════════════════╗
+║ \u001B[1mbar\u001B[22m   │ Usages │ Packages                                   ║
+╟───────┼────────┼────────────────────────────────────────────╢
+║ \u001B[91m1.4.0\u001B[39m │ 5      │ package5, package6, package7, and 2 others ║
+╟───────┼────────┼────────────────────────────────────────────╢
+║ \u001B[91m2.0.0\u001B[39m │ 4      │ package1, package2, package3, and 1 other  ║
+╚═══════╧════════╧════════════════════════════════════════════╝
+╔════════╤════════╤══════════╗
+║ \u001B[1mbaz\u001B[22m    │ Usages │ Packages ║
+╟────────┼────────┼──────────╢
+║ \u001B[91m^1.0.0\u001B[39m │ 1      │ package3 ║
+╟────────┼────────┼──────────╢
+║ \u001B[91m~2.0.0\u001B[39m │ 1      │ package2 ║
+╟────────┼────────┼──────────╢
+║ \u001B[91m^2.0.0\u001B[39m │ 1      │ package1 ║
+╚════════╧════════╧══════════╝
 `
       );
     });
