Merge pull request #1872 from spotify/rugvip/print-config

cli: add config:print command

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Command } from 'commander';
+import { loadConfig } from '@backstage/config-loader';
+import { ConfigReader } from '@backstage/config';
+import { paths } from '../../lib/paths';
+import { stringify as stringifyYaml } from 'yaml';
+
+export default async (cmd: Command) => {
+  const appConfigs = await loadConfig({
+    env: cmd.env ?? process.env.NODE_ENV ?? 'development',
+    shouldReadSecrets: cmd.withSecrets ?? false,
+    rootPaths: [paths.targetRoot, paths.targetDir],
+  });
+
+  const flatConfig = ConfigReader.fromConfigs(appConfigs).get();
+
+  if (cmd.format === 'json') {
+    process.stdout.write(`${JSON.stringify(flatConfig, null, 2)}\n`);
+  } else {
+    process.stdout.write(`${stringifyYaml(flatConfig)}\n`);
+  }
+};

packages/cli/src/index.ts

@@ -124,6 +124,20 @@ const main = (argv: string[]) => {
     .description('Run tests, forwarding args to Jest, defaulting to watch mode')
     .action(lazyAction(() => import('./commands/testCommand'), 'default'));
 
+  program
+    .command('config:print')
+    .option('--with-secrets', 'Include secrets in the printed configuration')
+    .option(
+      '--env <env>',
+      'The environment to print configuration for [NODE_ENV or development]',
+    )
+    .option(
+      '--format <format>',
+      'Format to print the configuration in, either json or yaml [yaml]',
+    )
+    .description('Print the app configuration for the current package')
+    .action(lazyAction(() => import('./commands/config/print'), 'default'));
+
   program
     .command('prepack')
     .description('Prepares a package for packaging before publishing')