feat(cli): add hints to commands (#443)

code-pushup · Jan 30, 2024 · 854cf4b · 854cf4b
1 parent a4f5834
commit 854cf4b
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/src/lib/autorun/autorun-command.ts b/packages/cli/src/lib/autorun/autorun-command.ts
@@ -38,7 +38,16 @@ export function yargsAutorunCommandObject() {
       if (options.upload) {
         await upload(options);
       } else {
-        console.warn('Upload skipped because configuration is not set.'); // @TODO log verbose
+        console.warn('Upload skipped because configuration is not set.');
+        console.info(
+          [
+            '💡 Integrate the portal:',
+            '- npx code-pushup upload - Run upload to upload the created report to the server',
+            '  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command',
+            '- Portal Integration - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration',
+            '- Upload Command - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration',
+          ].join('\n'),
+        );
       }
     },
   } satisfies CommandModule;

diff --git a/packages/cli/src/lib/collect/collect-command.ts b/packages/cli/src/lib/collect/collect-command.ts
@@ -18,6 +18,21 @@ export function yargsCollectCommandObject(): CommandModule {
       console.info(chalk.bold(CLI_NAME));
       console.info(chalk.gray(`Run ${command}...`));
       await collectAndPersistReports(options);
+      const { upload = {} } = args as unknown as Record<
+        'upload',
+        object | undefined
+      >;
+      if (Object.keys(upload).length === 0) {
+        console.info(
+          [
+            '💡 Visualize your reports:',
+            '- npx code-pushup upload - Run upload to upload the created report to the server',
+            '  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command',
+            '- npx code-pushup autorun - Run collect & upload',
+            '  https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command',
+          ].join('\n'),
+        );
+      }
     },
   } satisfies CommandModule;
 }
diff --git a/packages/cli/src/lib/upload/upload-command.ts b/packages/cli/src/lib/upload/upload-command.ts
@@ -14,6 +14,15 @@ export function yargsUploadCommandObject() {
 
       const options = args as unknown as UploadOptions;
       if (!options.upload) {
+        console.info(
+          [
+            '💡 Integrate the portal:',
+            '- npx code-pushup upload - Run upload to upload the created report to the server',
+            '  https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command',
+            '- Portal Integration - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration',
+            '- Upload Command - https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#portal-integration',
+          ].join('\n'),
+        );
         throw new Error('Upload configuration not set');
       }
       await upload(options);