Add more info to debug command (#931)

.changeset/nervous-dolphins-fix.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": minor
+---
+
+Added a new `debug` command to inspect the detected configuration options.

.changeset/silly-seals-arrive.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": minor
+---
+
+Removed the obsolete `publish` option which hasn't been used since v6.

README.md

@@ -44,7 +44,6 @@ Alternatively, you can pass your answers to the `init` command directly as flags
 
 ```sh
   -o, --openSource  Whether the project is open-source                 [boolean]
-      --publish     Whether to publish to NPM                          [boolean]
   -c, --configDir   The directory to write configs to    [string] [default: "."]
       --overwrite   Whether to overwrite existing config files
                                                       [boolean] [default: false]

src/cli/debug.ts

@@ -13,15 +13,20 @@
  * limitations under the License.
  */
 
-import { readPackageJson } from '../lib/files';
-import {
-  warnAboutMissingPlugins,
-  warnAboutUnsupportedPlugins,
-} from '../lib/options';
+import { isArray, isEmpty, mapValues } from 'lodash/fp';
+
+import { getOptions } from '../lib/options';
+import * as logger from '../lib/logger';
 
 export function debug(): void {
-  const packageJson = readPackageJson();
+  const options = getOptions();
+
+  const stringifiedOptions = mapValues(
+    (value) => (isArray(value) && !isEmpty(value) ? value.join(', ') : value),
+    options,
+  );
 
-  warnAboutUnsupportedPlugins(packageJson);
-  warnAboutMissingPlugins(packageJson);
+  logger.empty();
+  logger.info('Detected configuration:');
+  logger.table(stringifiedOptions);
 }

src/cli/defaults.ts

@@ -18,6 +18,5 @@ import { InitOptions } from '../types/shared';
 export const DEFAULT_OPTIONS: InitOptions = {
   configDir: '.',
   openSource: false,
-  publish: false,
   overwrite: false,
 };

src/cli/index.ts

@@ -33,10 +33,6 @@ void yargs
         desc: 'Whether the project is open-source',
         type: 'boolean',
       },
-      publish: {
-        desc: 'Whether to publish to NPM',
-        type: 'boolean',
-      },
       configDir: {
         alias: 'c',
         desc: 'The directory to write configs to',

src/cli/init.ts

@@ -44,7 +44,6 @@ import { DEFAULT_OPTIONS } from './defaults';
 export interface InitParams {
   configDir: string;
   openSource?: boolean;
-  publish?: boolean;
   overwrite?: boolean;
   $0?: string;
   _?: string[];

src/lib/logger.ts

@@ -58,3 +58,7 @@ export const debug = (arg: LogMessage): void => {
 export const empty = (): void => {
   console.log('');
 };
+
+export const table = (obj: Record<string, unknown>): void => {
+  console.table(obj);
+};

src/lib/options.ts

@@ -107,7 +107,6 @@ export function getOptions(): Required<Options> {
     frameworks: pick(config.frameworks, detectFrameworks),
     plugins: pick(config.plugins, detectPlugins),
     openSource: pick(config.openSource, detectOpenSource),
-    publish: Boolean(config.publish),
   };
 }
 

src/types/shared.ts

@@ -63,7 +63,6 @@ export interface Options {
   frameworks?: Framework[];
   plugins?: Plugin[];
   openSource?: boolean;
-  publish?: boolean;
 }
 
 export interface InitOptions extends Options {