fix(commands): fix command args prompt

Author: nfroidure

packages/whook-example/src/cli.test.ts

@@ -49,7 +49,7 @@ On air 🚀🌕
 
   test('with env', async () => {
     const { stdout, stderr } = await execCommand(
-      'npm run whook --silent -- env --name NODE_ENV',
+      'NO_PROMPT=1 npm run whook --silent -- env --name NODE_ENV',
     );
 
     expect({
@@ -73,7 +73,7 @@ On air 🚀🌕
 
   test('with config', async () => {
     const { stdout, stderr } = await execCommand(
-      'npm run whook --silent -- config --name HOST',
+      'NO_PROMPT=1 npm run whook --silent -- config --name HOST',
     );
 
     expect({

packages/whook/src/libs/args.ts

@@ -20,8 +20,9 @@ export function parseArgs(rawArgs: string[]): WhookRawCommandArgs {
       (cleanArgs, key) => ({
         ...cleanArgs,
         // Avoid having the --arg shortcut for --arg=true to
-        // provide a boolean since we coerce the args later 
-        [key]: typeof args[key] === 'boolean' ? args[key].toString() : args[key],
+        // provide a boolean since we coerce the args later
+        [key]:
+          typeof args[key] === 'boolean' ? args[key].toString() : args[key],
       }),
       {},
     ),
@@ -53,16 +54,7 @@ export async function promptArgs(
           API,
           schema.$ref,
         )) as WhookCommandSchema;
-        newNamedArgs[argument.name] = await input({
-          message: `Enter the value for "${argument.name}": `,
-          default: schema.default?.toString(),
-          required: argument.required,
-        });
-        continue;
-      }
 
-      if (!('default' in schema)) {
-        newNamedArgs[argument.name] = schema.default?.toString();
         continue;
       }
 
@@ -107,7 +99,15 @@ export async function promptArgs(
         newNamedArgs[argument.name] = await input({
           message: `Enter the value for "${argument.name}": `,
           required: argument.required,
+          default: schema.default?.toString(),
         });
+
+        continue;
+      }
+
+      if ('default' in schema) {
+        newNamedArgs[argument.name] = schema.default;
+        continue;
       }
     }
   }

packages/whook/src/services/command.test.ts

@@ -35,6 +35,9 @@ describe('command', () => {
     schemaValidators.mockReturnValue(validator as unknown as ValidateFunction);
 
     await initCommand({
+      ENV: {
+        NO_PROMPT: '1',
+      },
       API,
       COMMAND_DEFINITION: initEnvCommandDefinition,
       COERCION_OPTIONS: DEFAULT_COERCION_OPTIONS,
@@ -88,6 +91,9 @@ describe('command', () => {
     schemaValidators.mockReturnValue(validator as unknown as ValidateFunction);
 
     await initCommand({
+      ENV: {
+        NO_PROMPT: '1',
+      },
       API,
       COMMAND_DEFINITION: initEnvCommandDefinition,
       COERCION_OPTIONS: DEFAULT_COERCION_OPTIONS,

packages/whook/src/services/command.ts

@@ -21,9 +21,13 @@ import { getCasterForSchema } from '../libs/validation.js';
 import { ensureResolvedObject } from 'ya-open-api-types';
 import { type ExpressiveJSONSchema } from 'ya-json-schema-types';
 
-export default location(autoService(initCommand), import.meta.url);
+export type WhookCommandEnv = {
+  CI?: string;
+  NO_PROMPT?: string;
+};
 
 async function initCommand({
+  ENV,
   API,
   COMMAND_DEFINITION,
   COERCION_OPTIONS = DEFAULT_COERCION_OPTIONS,
@@ -35,6 +39,7 @@ async function initCommand({
   args,
   log,
 }: {
+  ENV: WhookCommandEnv;
   API: WhookOpenAPI;
   COMMAND_DEFINITION: WhookCommandDefinition;
   COERCION_OPTIONS?: WhookCoercionOptions;
@@ -50,7 +55,7 @@ async function initCommand({
     await $ready;
 
     try {
-      if (COMMAND_DEFINITION.config?.promptArgs) {
+      if (COMMAND_DEFINITION.config?.promptArgs && !ENV.CI && !ENV.NO_PROMPT) {
         // Required to ensure any logs are printed
         await Promise.resolve();
 
@@ -134,3 +139,5 @@ async function initCommand({
   }
   commandRunner();
 }
+
+export default location(autoService(initCommand), import.meta.url);

packages/whook/src/types/base.ts

@@ -23,6 +23,7 @@ import { type OpenAPITypesConfig } from '../commands/generateOpenAPITypes.js';
 import { type WhookErrorHandlerConfig } from '../services/errorHandler.js';
 import { type WhookSchemaValidatorsConfig } from '../services/schemaValidators.js';
 import { type WhookQueryParserBuilderConfig } from '../services/queryParserBuilder.js';
+import { type WhookCommandEnv } from '../services/command.js';
 
 export type WhookBaseMain = {
   AppEnv: string;
@@ -31,7 +32,8 @@ export type WhookBaseMain = {
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface WhookMain extends WhookBaseMain {}
 
-export type WhookBaseEnv = WhookHTTPServerEnv &
+export type WhookBaseEnv = WhookCommandEnv &
+  WhookHTTPServerEnv &
   WhookBaseURLEnv &
   WhookHostEnv &
   WhookPortEnv;