Allow skuba configure to accept stdin input (#1558)

Co-authored-by: Ryan Ling <[email protected]>

.changeset/stupid-oranges-switch.md

@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+configure: Accept template data from stdin to allow for integration testing

src/cli/configure/ensureTemplateCompletion.ts

@@ -3,6 +3,7 @@ import path from 'path';
 import chalk from 'chalk';
 import fs from 'fs-extra';
 import type { NormalizedReadResult } from 'read-pkg-up';
+import { z } from 'zod';
 
 import { copyFiles, createEjsRenderer } from '../../utils/copy';
 import { log } from '../../utils/logging';
@@ -11,7 +12,11 @@ import {
   ensureTemplateConfigDeletion,
 } from '../../utils/template';
 import { hasStringProp } from '../../utils/validation';
-import { getTemplateConfig, runForm } from '../init/getConfig';
+import {
+  getTemplateConfig,
+  readJSONFromStdIn,
+  runForm,
+} from '../init/getConfig';
 
 import { formatPackage } from './processing/package';
 
@@ -21,6 +26,28 @@ interface Props {
   manifest: NormalizedReadResult;
 }
 
+const templateDataSchema = z.object({ templateData: z.record(z.string()) });
+
+const getTemplateDataFromStdIn = async (
+  templateConfig: TemplateConfig,
+): Promise<Record<string, string>> => {
+  const config = await readJSONFromStdIn();
+  const data = templateDataSchema.parse(config);
+
+  templateConfig.fields.forEach((field) => {
+    const value = data.templateData[field.name];
+    if (value === undefined) {
+      throw new Error(`Missing field: ${field.name}`);
+    }
+
+    if (field.validate && !field.validate(value)) {
+      throw new Error(`Invalid value for field: ${field.name}`);
+    }
+  });
+
+  return data.templateData;
+};
+
 export const ensureTemplateCompletion = async ({
   destinationRoot,
   include,
@@ -37,11 +64,13 @@ export const ensureTemplateCompletion = async ({
     : 'template';
 
   log.newline();
-  const templateData = await runForm({
-    choices: templateConfig.fields,
-    message: chalk.bold(`Complete ${chalk.cyan(templateName)}:`),
-    name: 'customAnswers',
-  });
+  const templateData = process.stdin.isTTY
+    ? await runForm({
+        choices: templateConfig.fields,
+        message: chalk.bold(`Complete ${chalk.cyan(templateName)}:`),
+        name: 'customAnswers',
+      })
+    : await getTemplateDataFromStdIn(templateConfig);
 
   const updatedPackageJson = await formatPackage(manifest.packageJson);
   const packageJsonFilepath = path.join(destinationRoot, 'package.json');

src/cli/configure/index.ts

@@ -19,6 +19,9 @@ import { getEntryPoint } from './getEntryPoint';
 import { getProjectType } from './getProjectType';
 
 const shouldApply = async (name: string) => {
+  if (!process.stdin.isTTY) {
+    return 'yes';
+  }
   const prompt = new Select({
     choices: ['yes', 'no'] as const,
     message: 'Apply changes?',
@@ -118,8 +121,8 @@ export const configure = async () => {
       log.warn(log.bold('✗ Failed to install dependencies. Resume with:'));
 
       log.newline();
-      log.plain(log.bold(packageManager, 'install'));
-      log.plain(log.bold(packageManager, 'run', 'format'));
+      log.plain(log.bold(packageManager.install));
+      log.plain(log.bold(packageManager, 'format'));
 
       log.newline();
       process.exitCode = 1;
@@ -132,7 +135,7 @@ export const configure = async () => {
     log.ok(log.bold('✔ All done! Try running:'));
 
     log.newline();
-    log.plain(log.bold(packageManager, 'run', 'format'));
+    log.plain(log.bold(packageManager, 'format'));
   }
 
   log.newline();

src/cli/init/getConfig.ts

@@ -287,7 +287,7 @@ export const configureFromPrompt = async (): Promise<InitConfig> => {
   };
 };
 
-const configureFromPipe = async (): Promise<InitConfig> => {
+export const readJSONFromStdIn = async () => {
   let text = '';
 
   await new Promise((resolve) =>
@@ -312,6 +312,12 @@ const configureFromPipe = async (): Promise<InitConfig> => {
     process.exit(1);
   }
 
+  return value;
+};
+
+const configureFromPipe = async (): Promise<InitConfig> => {
+  const value = await readJSONFromStdIn();
+
   const result = initConfigInputSchema.safeParse(value);
 
   if (!result.success) {