feat(cli): add optional label option to compare command

code-pushup · Aug 19, 2024 · b3494d6 · b3494d6
1 parent d15f876
commit b3494d6
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 7 deletions.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -268,12 +268,13 @@ Usage:
 Description:
 Compare 2 reports and produce a report diff file.
 
-In addition to the [Common Command Options](#common-command-options), the following options are required:
+In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `compare` command:
 
-| Option         | Type     | Description                   |
-| -------------- | -------- | ----------------------------- |
-| **`--before`** | `string` | Path to source `report.json`. |
-| **`--after`**  | `string` | Path to target `report.json`. |
+| Option         | Required | Type     | Description                         |
+| -------------- | :------: | -------- | ----------------------------------- |
+| **`--before`** |   yes    | `string` | Path to source `report.json`.       |
+| **`--after`**  |   yes    | `string` | Path to target `report.json`.       |
+| **`--label`**  |    no    | `string` | Label for diff (e.g. project name). |
 
 #### `print-config` command
 

diff --git a/packages/cli/src/lib/compare/compare-command.ts b/packages/cli/src/lib/compare/compare-command.ts
@@ -22,12 +22,13 @@ export function yargsCompareCommandObject() {
         upload?: UploadConfig;
       };
 
-      const { before, after, persist, upload } = options;
+      const { before, after, label, persist, upload } = options;
 
       const outputPaths = await compareReportFiles(
         { before, after },
         persist,
         upload,
+        label,
       );
 
       ui().logger.info(

diff --git a/packages/cli/src/lib/compare/compare-command.unit.test.ts b/packages/cli/src/lib/compare/compare-command.unit.test.ts
@@ -44,6 +44,28 @@ describe('compare-command', () => {
         format: DEFAULT_PERSIST_FORMAT,
       },
       expect.any(Object),
+      undefined,
+    );
+  });
+
+  it('should forward label from command line', async () => {
+    await yargsCli(
+      [
+        'compare',
+        '--before=source-report.json',
+        '--after=target-report.json',
+        '--label=core',
+      ],
+      { ...DEFAULT_CLI_CONFIGURATION, commands: [yargsCompareCommandObject()] },
+    ).parseAsync();
+
+    expect(compareReportFiles).toHaveBeenCalledWith<
+      Parameters<typeof compareReportFiles>
+    >(
+      { before: 'source-report.json', after: 'target-report.json' },
+      expect.any(Object),
+      expect.any(Object),
+      'core',
     );
   });
 

diff --git a/packages/cli/src/lib/implementation/compare.model.ts b/packages/cli/src/lib/implementation/compare.model.ts
@@ -1,3 +1,3 @@
 import { Diff } from '@code-pushup/utils';
 
-export type CompareOptions = Diff<string>;
+export type CompareOptions = Diff<string> & { label?: string };
diff --git a/packages/cli/src/lib/implementation/compare.options.ts b/packages/cli/src/lib/implementation/compare.options.ts
@@ -16,5 +16,9 @@ export function yargsCompareOptionsDefinition(): Record<
       type: 'string',
       demandOption: true,
     },
+    label: {
+      describe: 'Label for diff (e.g. project name)',
+      type: 'string',
+    },
   };
 }