feat(cli): drop print-config to stdout, output arg is now required

Author: matejchalk

e2e/cli-e2e/tests/print-config.e2e.test.ts

@@ -40,11 +40,12 @@ describe('CLI print-config', () => {
   it.each(extensions)(
     'should load .%s config file with correct arguments',
     async ext => {
-      const { code, stdout } = await executeProcess({
+      const { code } = await executeProcess({
         command: 'npx',
         args: [
           '@code-pushup/cli',
           'print-config',
+          '--output=config.json',
           `--config=${configFilePath(ext)}`,
           '--tsconfig=tsconfig.base.json',
           '--persist.outputDir=output-dir',
@@ -56,7 +57,11 @@ describe('CLI print-config', () => {
 
       expect(code).toBe(0);
 
-      expect(JSON.parse(stdout)).toEqual(
+      const output = await readFile(
+        path.join(testFileDummySetup, 'config.json'),
+        'utf8',
+      );
+      expect(JSON.parse(output)).toEqual(
         expect.objectContaining({
           config: expect.stringContaining(`code-pushup.config.${ext}`),
           tsconfig: 'tsconfig.base.json',
@@ -71,30 +76,4 @@ describe('CLI print-config', () => {
       );
     },
   );
-
-  it('should print config to output file', async () => {
-    const { code, stdout } = await executeProcess({
-      command: 'npx',
-      args: ['@code-pushup/cli', 'print-config', '--output=config.json'],
-      cwd: testFileDummySetup,
-    });
-
-    expect(code).toBe(0);
-
-    const output = await readFile(
-      path.join(testFileDummySetup, 'config.json'),
-      'utf8',
-    );
-    expect(JSON.parse(output)).toEqual(
-      expect.objectContaining({
-        plugins: [
-          expect.objectContaining({
-            slug: 'dummy-plugin',
-            title: 'Dummy Plugin',
-          }),
-        ],
-      }),
-    );
-    expect(stdout).not.toContain('dummy-plugin');
-  });
 });

packages/cli/README.md

@@ -331,9 +331,9 @@ Print the resolved configuration.
 
 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). |
+| Option         | Required | Type     | Description                          |
+| -------------- | :------: | -------- | ------------------------------------ |
+| **`--output`** |   yes    | `string` | Path to output file to print config. |
 
 #### `merge-diffs` command
 

packages/cli/src/lib/implementation/log-intro.middleware.ts

@@ -7,10 +7,6 @@ import { getVersion } from './version.js';
 export function logIntroMiddleware(
   args: ArgumentsCamelCase,
 ): ArgumentsCamelCase {
-  // prevent interference with JSON output
-  if (args._.includes('print-config') && !('output' in args)) {
-    return args;
-  }
   logger.info(
     ansis.bold.blue(
       `${CODE_PUSHUP_UNICODE_LOGO} ${CLI_DISPLAY_NAME} v${getVersion()}`,

packages/cli/src/lib/implementation/print-config.model.ts

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

packages/cli/src/lib/implementation/print-config.options.ts

@@ -7,8 +7,9 @@ export function yargsPrintConfigOptionsDefinition(): Record<
 > {
   return {
     output: {
-      describe: 'Output file path to use instead of stdout',
+      describe: 'Output file path for resolved JSON config',
       type: 'string',
+      demandOption: true,
     },
   };
 }

packages/cli/src/lib/print-config/print-config-command.ts

@@ -15,26 +15,19 @@ export function yargsPrintConfigCommandObject() {
     describe: 'Print config',
     builder: yargsPrintConfigOptionsDefinition(),
     handler: async yargsArgs => {
+      printCliCommand(command);
+
       // it is important to filter out kebab case keys
       // because yargs duplicates options in camel case and kebab case
       const { _, $0, ...args } = filterKebabCaseKeys(yargsArgs);
       const { output, ...config } = args as PrintConfigOptions &
         Record<string, unknown>;
 
-      // stdout should be valid JSON
-      if (output) {
-        printCliCommand(command);
-      }
-
       const content = JSON.stringify(config, null, 2);
 
-      if (output) {
-        await mkdir(path.dirname(output), { recursive: true });
-        await writeFile(output, content);
-        logger.info(`Config printed to file ${ansis.bold(output)}`);
-      } else {
-        logger.info(content);
-      }
+      await mkdir(path.dirname(output), { recursive: true });
+      await writeFile(output, content);
+      logger.info(`Config printed to file ${ansis.bold(output)}`);
     },
   } satisfies CommandModule;
 }

packages/cli/src/lib/print-config/print-config-command.unit.test.ts

@@ -19,17 +19,6 @@ vi.mock('@code-pushup/core', async () => {
 });
 
 describe('print-config-command', () => {
-  it('should log config to stdout by default', async () => {
-    await yargsCli(['print-config'], {
-      ...DEFAULT_CLI_CONFIGURATION,
-      commands: [yargsPrintConfigCommandObject()],
-    }).parseAsync();
-
-    expect(logger.info).toHaveBeenCalledWith(
-      expect.stringContaining('"plugins": ['),
-    );
-  });
-
   it('should write config to file if output option is given', async () => {
     const outputPath = path.join(MEMFS_VOLUME, 'config.json');
     await yargsCli(['print-config', `--output=${outputPath}`], {
@@ -40,32 +29,30 @@ describe('print-config-command', () => {
     await expect(readFile(outputPath, 'utf8')).resolves.toContain(
       '"plugins": [',
     );
-    expect(logger.info).not.toHaveBeenCalledWith(
-      expect.stringContaining('"plugins": ['),
-    );
     expect(logger.info).toHaveBeenCalledWith(
       `Config printed to file ${ansis.bold(outputPath)}`,
     );
   });
 
   it('should filter out meta arguments and kebab duplicates', async () => {
-    await yargsCli(['print-config', '--persist.outputDir=destinationDir'], {
-      ...DEFAULT_CLI_CONFIGURATION,
-      commands: [yargsPrintConfigCommandObject()],
-    }).parseAsync();
-
-    expect(logger.info).not.toHaveBeenCalledWith(
-      expect.stringContaining('"$0":'),
-    );
-    expect(logger.info).not.toHaveBeenCalledWith(
-      expect.stringContaining('"_":'),
-    );
-
-    expect(logger.info).toHaveBeenCalledWith(
-      expect.stringContaining('"outputDir": "destinationDir"'),
-    );
-    expect(logger.info).not.toHaveBeenCalledWith(
-      expect.stringContaining('"output-dir":'),
-    );
+    const outputPath = path.join(MEMFS_VOLUME, 'config.json');
+    await yargsCli(
+      [
+        'print-config',
+        `--output=${outputPath}`,
+        '--persist.outputDir=destinationDir',
+      ],
+      {
+        ...DEFAULT_CLI_CONFIGURATION,
+        commands: [yargsPrintConfigCommandObject()],
+      },
+    ).parseAsync();
+    const output = await readFile(outputPath, 'utf8');
+
+    expect(output).not.toContain('"$0":');
+    expect(output).not.toContain('"_":');
+
+    expect(output).toContain('"outputDir": "destinationDir"');
+    expect(output).not.toContain('"output-dir":');
   });
 });