Merge pull request #18786 from backstage/djam/non-merged

feat(cli): enable to print the config schema non merged

.changeset/rare-pens-exist.md

@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Enable to print the config schema not merged with the `--no-merge` flag

packages/cli/cli-report.md

@@ -97,6 +97,8 @@ Usage: backstage-cli config:schema [options]
 Options:
   --package <name>
   --format <format>
+  --merge
+  --no-merge
   -h, --help
 ```
 

packages/cli/src/commands/config/schema.ts

@@ -28,19 +28,23 @@ export default async (opts: OptionValues) => {
     mockEnv: true,
   });
 
-  const merged = mergeConfigSchemas(
-    (schema.serialize().schemas as JsonObject[]).map(
-      _ => _.value as JSONSchema,
-    ),
-  );
-
-  merged.title = 'Application Configuration Schema';
-  merged.description =
-    'This is the schema describing the structure of the app-config.yaml configuration file.';
+  let configSchema: JsonObject | JSONSchema;
+  if (opts.merge) {
+    configSchema = mergeConfigSchemas(
+      (schema.serialize().schemas as JsonObject[]).map(
+        _ => _.value as JSONSchema,
+      ),
+    );
+    configSchema.title = 'Application Configuration Schema';
+    configSchema.description =
+      'This is the schema describing the structure of the app-config.yaml configuration file.';
+  } else {
+    configSchema = schema.serialize();
+  }
 
   if (opts.format === 'json') {
-    process.stdout.write(`${JSON.stringify(merged, null, 2)}\n`);
+    process.stdout.write(`${JSON.stringify(configSchema, null, 2)}\n`);
   } else {
-    process.stdout.write(`${stringifyYaml(merged)}\n`);
+    process.stdout.write(`${stringifyYaml(configSchema)}\n`);
   }
 };

packages/cli/src/commands/index.ts

@@ -365,6 +365,8 @@ export function registerCommands(program: Command) {
       '--format <format>',
       'Format to print the schema in, either json or yaml [yaml]',
     )
+    .option('--merge', 'Print the config schemas merged', true)
+    .option('--no-merge', 'Print the config schemas not merged')
     .description('Print configuration schema')
     .action(lazy(() => import('./config/schema').then(m => m.default)));