@code-pushup/cli 0.62.0 → 0.64.0

package/README.md

@@ -303,7 +303,11 @@ Usage:
 Description:
 Print the resolved configuration.
 
-Refer to the [Common Command Options](#common-command-options) for the list of available options.
+In addition to the [Common Command Options](#common-command-options), the following options are recognized by the `print-config` command:
+
+| Option         | Required | Type     | Description                                              |
+| -------------- | :------: | -------- | -------------------------------------------------------- |
+| **`--output`** |    no    | `string` | Path to output file to print config (default is stdout). |
 
 ### `merge-diffs` command
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.62.0",
+  "version": "0.64.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",
@@ -42,9 +42,9 @@
     "code-pushup": "./src/index.js"
   },
   "dependencies": {
-    "@code-pushup/models": "0.62.0",
-    "@code-pushup/core": "0.62.0",
-    "@code-pushup/utils": "0.62.0",
+    "@code-pushup/models": "0.64.0",
+    "@code-pushup/core": "0.64.0",
+    "@code-pushup/utils": "0.64.0",
     "yargs": "^17.7.2",
     "ansis": "^3.3.0",
     "simple-git": "^3.20.0"

package/src/lib/commands.js

@@ -3,7 +3,7 @@ import { yargsCollectCommandObject } from './collect/collect-command.js';
 import { yargsCompareCommandObject } from './compare/compare-command.js';
 import { yargsHistoryCommandObject } from './history/history-command.js';
 import { yargsMergeDiffsCommandObject } from './merge-diffs/merge-diffs-command.js';
-import { yargsConfigCommandObject } from './print-config/print-config-command.js';
+import { yargsPrintConfigCommandObject } from './print-config/print-config-command.js';
 import { yargsUploadCommandObject } from './upload/upload-command.js';
 export const commands = [
     {
@@ -15,7 +15,7 @@ export const commands = [
     yargsUploadCommandObject(),
     yargsHistoryCommandObject(),
     yargsCompareCommandObject(),
-    yargsConfigCommandObject(),
+    yargsPrintConfigCommandObject(),
     yargsMergeDiffsCommandObject(),
 ];
 //# sourceMappingURL=commands.js.map

package/src/lib/commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../../packages/cli/src/lib/commands.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,MAAM,CAAC,MAAM,QAAQ,GAAoB;IACvC;QACE,GAAG,yBAAyB,EAAE;QAC9B,OAAO,EAAE,GAAG;KACb;IACD,yBAAyB,EAAE;IAC3B,yBAAyB,EAAE;IAC3B,wBAAwB,EAAE;IAC1B,yBAAyB,EAAE;IAC3B,yBAAyB,EAAE;IAC3B,wBAAwB,EAAE;IAC1B,4BAA4B,EAAE;CAC/B,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../../packages/cli/src/lib/commands.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,MAAM,CAAC,MAAM,QAAQ,GAAoB;IACvC;QACE,GAAG,yBAAyB,EAAE;QAC9B,OAAO,EAAE,GAAG;KACb;IACD,yBAAyB,EAAE;IAC3B,yBAAyB,EAAE;IAC3B,wBAAwB,EAAE;IAC1B,yBAAyB,EAAE;IAC3B,yBAAyB,EAAE;IAC3B,6BAA6B,EAAE;IAC/B,4BAA4B,EAAE;CAC/B,CAAC"}

package/src/lib/implementation/print-config.model.d.ts

@@ -0,0 +1,3 @@
+export type PrintConfigOptions = {
+    output?: string;
+};

package/src/lib/implementation/print-config.model.js

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

package/src/lib/implementation/print-config.model.js.map

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

package/src/lib/implementation/print-config.options.d.ts

@@ -0,0 +1,3 @@
+import type { Options } from 'yargs';
+import type { PrintConfigOptions } from './print-config.model.js';
+export declare function yargsPrintConfigOptionsDefinition(): Record<keyof PrintConfigOptions, Options>;

package/src/lib/implementation/print-config.options.js

@@ -0,0 +1,9 @@
+export function yargsPrintConfigOptionsDefinition() {
+    return {
+        output: {
+            describe: 'Output file path to use instead of stdout',
+            type: 'string',
+        },
+    };
+}
+//# sourceMappingURL=print-config.options.js.map

package/src/lib/implementation/print-config.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-config.options.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/implementation/print-config.options.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,iCAAiC;IAI/C,OAAO;QACL,MAAM,EAAE;YACN,QAAQ,EAAE,2CAA2C;YACrD,IAAI,EAAE,QAAQ;SACf;KACF,CAAC;AACJ,CAAC"}

package/src/lib/print-config/print-config-command.d.ts

@@ -1,5 +1,6 @@
-export declare function yargsConfigCommandObject(): {
+export declare function yargsPrintConfigCommandObject(): {
     command: string;
     describe: string;
-    handler: (yargsArgs: import("yargs").ArgumentsCamelCase<{}>) => void;
+    builder: Record<"output", import("yargs").Options>;
+    handler: (yargsArgs: import("yargs").ArgumentsCamelCase<{}>) => Promise<void>;
 };

package/src/lib/print-config/print-config-command.js

@@ -1,16 +1,29 @@
+import { bold } from 'ansis';
+import { mkdir, writeFile } from 'node:fs/promises';
+import path from 'node:path';
 import { ui } from '@code-pushup/utils';
 import { filterKebabCaseKeys } from '../implementation/global.utils.js';
-export function yargsConfigCommandObject() {
+import { yargsPrintConfigOptionsDefinition } from '../implementation/print-config.options.js';
+export function yargsPrintConfigCommandObject() {
     const command = 'print-config';
     return {
         command,
         describe: 'Print config',
-        handler: yargsArgs => {
-            const { _, $0, ...args } = yargsArgs;
+        builder: yargsPrintConfigOptionsDefinition(),
+        handler: async (yargsArgs) => {
             // it is important to filter out kebab case keys
             // because yargs duplicates options in camel case and kebab case
-            const cleanArgs = filterKebabCaseKeys(args);
-            ui().logger.log(JSON.stringify(cleanArgs, null, 2));
+            const { _, $0, ...args } = filterKebabCaseKeys(yargsArgs);
+            const { output, ...config } = args;
+            const content = JSON.stringify(config, null, 2);
+            if (output) {
+                await mkdir(path.dirname(output), { recursive: true });
+                await writeFile(output, content);
+                ui().logger.info(`Config printed to file ${bold(output)}`);
+            }
+            else {
+                ui().logger.log(content);
+            }
         },
     };
 }

package/src/lib/print-config/print-config-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"print-config-command.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/print-config/print-config-command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAExE,MAAM,UAAU,wBAAwB;IACtC,MAAM,OAAO,GAAG,cAAc,CAAC;IAC/B,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,cAAc;QACxB,OAAO,EAAE,SAAS,CAAC,EAAE;YACnB,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC;YACrC,gDAAgD;YAChD,gEAAgE;YAChE,MAAM,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC5C,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACtD,CAAC;KACsB,CAAC;AAC5B,CAAC"}
+{"version":3,"file":"print-config-command.js","sourceRoot":"","sources":["../../../../../../packages/cli/src/lib/print-config/print-config-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAExE,OAAO,EAAE,iCAAiC,EAAE,MAAM,2CAA2C,CAAC;AAE9F,MAAM,UAAU,6BAA6B;IAC3C,MAAM,OAAO,GAAG,cAAc,CAAC;IAC/B,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,cAAc;QACxB,OAAO,EAAE,iCAAiC,EAAE;QAC5C,OAAO,EAAE,KAAK,EAAC,SAAS,EAAC,EAAE;YACzB,gDAAgD;YAChD,gEAAgE;YAChE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;YAC1D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IACL,CAAC;YAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAEhD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvD,MAAM,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBACjC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;KACsB,CAAC;AAC5B,CAAC"}