@code-pushup/cli 0.70.0 → 0.72.0

package/README.md

@@ -279,7 +279,7 @@ Refer to the [Common Command Options](#common-command-options) for the list of a
 | **`--from`**             | `string`  | n/a     | Hash to start in history                                         |
 | **`--to`**               | `string`  | n/a     | Hash to end in history                                           |
 
-### `compare` command
+#### `compare` command
 
 Usage:
 `code-pushup compare --before SOURCE_PATH --after TARGET_PATH [options]`
@@ -289,11 +289,15 @@ Compare 2 reports and produce a report diff file.
 
 In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `compare` command:
 
-| 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). |
+| Option         | Type     | Default                                | Description                         |
+| -------------- | -------- | -------------------------------------- | ----------------------------------- |
+| **`--before`** | `string` | `.code-pushup/report-before.json` [^1] | Path to source `report.json`.       |
+| **`--after`**  | `string` | `.code-pushup/report-after.json` [^1]  | Path to target `report.json`.       |
+| **`--label`**  | `string` | n/a [^2]                               | Label for diff (e.g. project name). |
+
+[^1]: Uses `persist` config to determine report paths, so default file paths are actually `${persist.outputDir}/${persist.filename}-before.json` and `${persist.outputDir}/${persist.filename}-after.json`.
+
+[^2]: Uses `label` from input `report.json` files is they both have the same value.
 
 #### `print-config` command
 
@@ -309,7 +313,7 @@ In addition to the [Common Command Options](#common-command-options), the follow
 | -------------- | :------: | -------- | -------------------------------------------------------- |
 | **`--output`** |    no    | `string` | Path to output file to print config (default is stdout). |
 
-### `merge-diffs` command
+#### `merge-diffs` command
 
 Usage:
 `code-pushup merge-diffs --files PATH_1 PATH_2 ... [options]`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.70.0",
+  "version": "0.72.0",
   "license": "MIT",
   "description": "A CLI to run all kinds of code quality measurements to align your team with company goals",
   "homepage": "https://code-pushup.dev",
@@ -45,9 +45,9 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@code-pushup/models": "0.70.0",
-    "@code-pushup/core": "0.70.0",
-    "@code-pushup/utils": "0.70.0",
+    "@code-pushup/models": "0.72.0",
+    "@code-pushup/core": "0.72.0",
+    "@code-pushup/utils": "0.72.0",
     "yargs": "^17.7.2",
     "ansis": "^3.3.0",
     "simple-git": "^3.20.0"

package/src/lib/compare/compare-command.d.ts

@@ -1,6 +1,7 @@
+import { type CompareOptions } from '@code-pushup/core';
 export declare function yargsCompareCommandObject(): {
     command: string;
     describe: string;
-    builder: Record<keyof import("@code-pushup/utils").Diff<string> | "label", import("yargs").Options>;
+    builder: Record<keyof CompareOptions, import("yargs").Options>;
     handler: (args: unknown) => Promise<void>;
 };

package/src/lib/compare/compare-command.js

@@ -14,7 +14,7 @@ export function yargsCompareCommandObject() {
             ui().logger.info(gray(`Run ${command}...`));
             const options = args;
             const { before, after, label, persist, upload } = options;
-            const outputPaths = await compareReportFiles({ before, after }, persist, upload, label);
+            const outputPaths = await compareReportFiles({ persist, upload }, { before, after, label });
             ui().logger.info(`Reports diff written to ${outputPaths
                 .map(path => bold(path))
                 .join(' and ')}`);

package/src/lib/compare/compare-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare-command.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/compare/compare-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC;AAErF,MAAM,UAAU,yBAAyB;IACvC,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,+CAA+C;QACzD,OAAO,EAAE,6BAA6B,EAAE;QACxC,OAAO,EAAE,KAAK,EAAE,IAAa,EAAE,EAAE;YAC/B,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAChC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,KAAK,CAAC,CAAC,CAAC;YAE5C,MAAM,OAAO,GAAG,IAGf,CAAC;YAEF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;YAE1D,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAC1C,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,OAAO,EACP,MAAM,EACN,KAAK,CACN,CAAC;YAEF,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CACd,2BAA2B,WAAW;iBACnC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACvB,IAAI,CAAC,OAAO,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC;KACsB,CAAC;AAC5B,CAAC"}
+{"version":3,"file":"compare-command.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/compare/compare-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAuB,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC;AAErF,MAAM,UAAU,yBAAyB;IACvC,MAAM,OAAO,GAAG,SAAS,CAAC;IAC1B,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,+CAA+C;QACzD,OAAO,EAAE,6BAA6B,EAAE;QACxC,OAAO,EAAE,KAAK,EAAE,IAAa,EAAE,EAAE;YAC/B,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAChC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,OAAO,KAAK,CAAC,CAAC,CAAC;YAE5C,MAAM,OAAO,GAAG,IAGf,CAAC;YAEF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;YAE1D,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAC1C,EAAE,OAAO,EAAE,MAAM,EAAE,EACnB,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CACzB,CAAC;YAEF,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CACd,2BAA2B,WAAW;iBACnC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACvB,IAAI,CAAC,OAAO,CAAC,EAAE,CACnB,CAAC;QACJ,CAAC;KACsB,CAAC;AAC5B,CAAC"}

package/src/lib/implementation/compare.options.d.ts

@@ -1,3 +1,3 @@
 import type { Options } from 'yargs';
-import type { CompareOptions } from './compare.model.js';
+import type { CompareOptions } from '@code-pushup/core';
 export declare function yargsCompareOptionsDefinition(): Record<keyof CompareOptions, Options>;

package/src/lib/implementation/compare.options.js

@@ -3,12 +3,10 @@ export function yargsCompareOptionsDefinition() {
         before: {
             describe: 'Path to source report.json',
             type: 'string',
-            demandOption: true,
         },
         after: {
             describe: 'Path to target report.json',
             type: 'string',
-            demandOption: true,
         },
         label: {
             describe: 'Label for diff (e.g. project name)',

package/src/lib/implementation/compare.options.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare.options.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/implementation/compare.options.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,6BAA6B;IAI3C,OAAO;QACL,MAAM,EAAE;YACN,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,IAAI;SACnB;QACD,KAAK,EAAE;YACL,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,IAAI;SACnB;QACD,KAAK,EAAE;YACL,QAAQ,EAAE,oCAAoC;YAC9C,IAAI,EAAE,QAAQ;SACf;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"compare.options.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/implementation/compare.options.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,6BAA6B;IAI3C,OAAO;QACL,MAAM,EAAE;YACN,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,QAAQ,EAAE,oCAAoC;YAC9C,IAAI,EAAE,QAAQ;SACf;KACF,CAAC;AACJ,CAAC"}

package/src/lib/implementation/compare.model.d.ts

@@ -1,4 +0,0 @@
-import type { Diff } from '@code-pushup/utils';
-export type CompareOptions = Diff<string> & {
-    label?: string;
-};

package/src/lib/implementation/compare.model.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=compare.model.js.map

package/src/lib/implementation/compare.model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"compare.model.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/implementation/compare.model.ts"],"names":[],"mappings":""}