@code-pushup/cli 0.48.0 → 0.50.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/README.md +20 -5
  2. package/index.js +1331 -1276
  3. package/package.json +7 -33
  4. package/src/lib/autorun/autorun-command.d.ts +1 -1
  5. package/src/lib/collect/collect-command.d.ts +1 -1
  6. package/src/lib/commands.d.ts +1 -1
  7. package/src/lib/compare/compare-command.d.ts +1 -2
  8. package/src/lib/history/history.model.d.ts +2 -2
  9. package/src/lib/history/history.options.d.ts +2 -2
  10. package/src/lib/history/utils.d.ts +2 -2
  11. package/src/lib/implementation/compare.model.d.ts +4 -2
  12. package/src/lib/implementation/compare.options.d.ts +1 -1
  13. package/src/lib/implementation/core-config.middleware.d.ts +8 -6
  14. package/src/lib/implementation/core-config.options.d.ts +2 -2
  15. package/src/lib/implementation/formatting.d.ts +11 -0
  16. package/src/lib/implementation/global.model.d.ts +2 -2
  17. package/src/lib/implementation/global.options.d.ts +2 -2
  18. package/src/lib/implementation/merge-diffs.model.d.ts +3 -0
  19. package/src/lib/implementation/merge-diffs.options.d.ts +3 -0
  20. package/src/lib/implementation/only-plugins.middleware.d.ts +1 -1
  21. package/src/lib/implementation/only-plugins.model.d.ts +2 -2
  22. package/src/lib/implementation/only-plugins.options.d.ts +3 -2
  23. package/src/lib/implementation/skip-plugins.middleware.d.ts +1 -1
  24. package/src/lib/implementation/skip-plugins.model.d.ts +2 -2
  25. package/src/lib/implementation/skip-plugins.options.d.ts +3 -2
  26. package/src/lib/merge-diffs/merge-diffs-command.d.ts +6 -0
  27. package/src/lib/middlewares.d.ts +1 -1
  28. package/src/lib/upload/upload-command.d.ts +1 -1
  29. package/src/lib/yargs-cli.d.ts +14 -1
package/README.md CHANGED
@@ -268,12 +268,13 @@ Usage:
268
268
  Description:
269
269
  Compare 2 reports and produce a report diff file.
270
270
 
271
- In addition to the [Common Command Options](#common-command-options), the following options are required:
271
+ In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `compare` command:
272
272
 
273
- | Option | Type | Description |
274
- | -------------- | -------- | ----------------------------- |
275
- | **`--before`** | `string` | Path to source `report.json`. |
276
- | **`--after`** | `string` | Path to target `report.json`. |
273
+ | Option | Required | Type | Description |
274
+ | -------------- | :------: | -------- | ----------------------------------- |
275
+ | **`--before`** | yes | `string` | Path to source `report.json`. |
276
+ | **`--after`** | yes | `string` | Path to target `report.json`. |
277
+ | **`--label`** | no | `string` | Label for diff (e.g. project name). |
277
278
 
278
279
  #### `print-config` command
279
280
 
@@ -284,3 +285,17 @@ Description:
284
285
  Print the resolved configuration.
285
286
 
286
287
  Refer to the [Common Command Options](#common-command-options) for the list of available options.
288
+
289
+ ### `merge-diffs` command
290
+
291
+ Usage:
292
+ `code-pushup merge-diffs --files PATH_1 PATH_2 ... [options]`
293
+
294
+ Description:
295
+ Combine multiple report diffs into a single `report-diff.md`.
296
+
297
+ In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `merge-diffs` command:
298
+
299
+ | Option | Required | Type | Description |
300
+ | ------------- | :------: | ---------- | --------------------------------- |
301
+ | **`--files`** | yes | `string[]` | List of `report-diff.json` paths. |