Merge pull request #12 from barrymichaeldoyle/cli-dependency-progress-counter

Add package progress counters during CLI dependency checks

Author: barrymichaeldoyle

packages/cli/CHANGELOG.md

@@ -1,5 +1,11 @@
 # patch-pulse
 
+## 4.1.1
+
+### Patch Changes
+
+- Show package-level progress counts during CLI dependency checks.
+
 ## 4.1.0
 
 ### Minor Changes

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patch-pulse",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Check for outdated npm dependencies",
   "type": "module",
   "bin": {

packages/cli/src/cli.ts

@@ -217,15 +217,19 @@ export async function runCli({
 
           const sectionLabel = dependencyTypeLabels[key];
 
-          projectSpinner?.start(`Checking ${sectionLabel.toLowerCase()}...`);
-
           try {
             const dependencyMap = Object.fromEntries(
               value.map((dependency) => [
                 dependency.packageName,
                 dependency.source.resolvedVersion,
               ]),
             );
+            const totalDependencies = value.length;
+
+            projectSpinner?.start(
+              `Checking ${sectionLabel.toLowerCase()}... (0/${totalDependencies})`,
+            );
+
             const sourceMap = new Map(
               value.map((dependency) => [
                 dependency.packageName,
@@ -236,7 +240,14 @@ export async function runCli({
               dependencyMap,
               sectionLabel,
               config,
-              { silent: !streamInline },
+              {
+                onProgress: ({ completedCount, totalCount }) => {
+                  projectSpinner?.updateMessage(
+                    `Checking ${sectionLabel.toLowerCase()}... (${completedCount}/${totalCount})`,
+                  );
+                },
+                silent: !streamInline,
+              },
             );
 
             projectSpinner?.stop();

packages/cli/src/core/dependency-checker.ts

@@ -15,18 +15,20 @@ export async function checkDependencyVersions(
   category: string,
   config?: PatchPulseConfig,
   options: {
+    onProgress?: (args: { completedCount: number; totalCount: number }) => void;
     silent?: boolean;
   } = {},
 ): Promise<DependencyInfo[]> {
-  const { silent = false } = options;
+  const { onProgress, silent = false } = options;
 
   if (!dependencies || Object.keys(dependencies).length === 0) {
     return [];
   }
 
   const packageNames = Object.keys(dependencies);
   const progress = silent ? null : new ProgressSpinner();
-  progress?.start(`Checking ${packageNames.length} packages...`);
+  const totalCount = packageNames.length;
+  progress?.start(`Checking ${totalCount} packages...`);
 
   const skippedResults: DependencyInfo[] = [];
   const dependenciesToCheck = Object.fromEntries(
@@ -50,6 +52,19 @@ export async function checkDependencyVersions(
   );
 
   let checkedResults: DependencyInfo[] = [];
+  const reportProgress = (completedCount: number): void => {
+    const overallCompletedCount = completedCount + skippedResults.length;
+
+    progress?.updateMessage(
+      `Checking ${totalCount} packages... (${overallCompletedCount}/${totalCount})`,
+    );
+    onProgress?.({
+      completedCount: overallCompletedCount,
+      totalCount,
+    });
+  };
+
+  reportProgress(0);
 
   try {
     checkedResults =
@@ -70,10 +85,8 @@ export async function checkDependencyVersions(
                 );
               }
             },
-            onResolved: ({ completedCount, totalCount }) => {
-              progress?.updateMessage(
-                `Checking ${packageNames.length} packages... (${completedCount + skippedResults.length}/${totalCount + skippedResults.length})`,
-              );
+            onResolved: ({ completedCount }) => {
+              reportProgress(completedCount);
             },
             userAgent: 'patch-pulse-cli',
           })) as DependencyInfo[]);

packages/cli/src/core/tests/dependency-checker.test.ts

@@ -62,4 +62,55 @@ describe('checkDependencyVersions', () => {
 
     expect(process.stdout.write).toHaveBeenCalledWith('\r\x1B[2K');
   });
+
+  it('reports progress counts including skipped packages', async () => {
+    vi.mocked(checkNpmDependencyStatuses).mockImplementation(
+      async (_dependencies, options) => {
+        options?.onResolved?.({
+          completedCount: 1,
+          result: {
+            packageName: 'react',
+            currentVersion: '18.2.0',
+            latestVersion: '19.2.0',
+            isOutdated: true,
+            status: 'update-available',
+            updateType: 'major',
+          },
+          totalCount: 1,
+        });
+
+        return [
+          {
+            packageName: 'react',
+            currentVersion: '18.2.0',
+            latestVersion: '19.2.0',
+            isOutdated: true,
+            status: 'update-available',
+            updateType: 'major',
+          },
+        ];
+      },
+    );
+
+    const onProgress = vi.fn();
+
+    await checkDependencyVersions(
+      {
+        react: '18.2.0',
+        '@types/node': 'latest',
+      },
+      'Dependencies',
+      { skip: ['@types/node'] },
+      { onProgress, silent: true },
+    );
+
+    expect(onProgress).toHaveBeenNthCalledWith(1, {
+      completedCount: 1,
+      totalCount: 2,
+    });
+    expect(onProgress).toHaveBeenNthCalledWith(2, {
+      completedCount: 2,
+      totalCount: 2,
+    });
+  });
 });

packages/cli/src/gen/version.gen.ts

@@ -1,2 +1,2 @@
 // Auto-generated file - do not edit manually
-export const VERSION = '4.1.0';
+export const VERSION = '4.1.1';