Allow defaults in initial prompt (#1343)

Per discussion in #1335.
seek-oss · Dec 13, 2023 · 5750ab3 · 5750ab3
1 parent 347b0bc
commit 5750ab3
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 8 deletions.
diff --git a/.changeset/orange-moles-yell.md b/.changeset/orange-moles-yell.md
@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+init: Default to `arm64` platform and `main` branch
diff --git a/docs/cli/init.md b/docs/cli/init.md
@@ -39,9 +39,10 @@ and answering a few starter questions:
 
 ```shell
 ? For starters, some project details:
-⊙    Owner : SEEK-Jobs/my-team
-⊙     Repo : my-repo
-⊙ Platform : amd64 | arm64
+⊙          Owner : SEEK-Jobs/my-team
+⊙           Repo : my-repo
+⊙       Platform : arm64
+⊙ Default Branch : main
 
 # ...
 ```

diff --git a/src/cli/init/getConfig.ts b/src/cli/init/getConfig.ts
@@ -18,6 +18,7 @@ import { downloadGitHubTemplate } from './git';
 import {
   BASE_PROMPT_PROPS,
   type BaseFields,
+  type Choice,
   GIT_PATH_PROMPT,
   SHOULD_CONTINUE_PROMPT,
   TEMPLATE_PROMPT,
@@ -27,7 +28,7 @@ import { type InitConfig, initConfigInputSchema } from './types';
 import { Form, type FormChoice } from 'enquirer';
 
 export const runForm = <T = Record<string, string>>(props: {
-  choices: Readonly<FormChoice[]>;
+  choices: Readonly<Choice[]>;
   message: string;
   name: string;
 }) => {
@@ -36,7 +37,11 @@ export const runForm = <T = Record<string, string>>(props: {
   const choices = props.choices.map((choice) => ({
     ...choice,
     validate: (value: string | undefined) => {
-      if (!value || value === '' || value === choice.initial) {
+      if (
+        !value ||
+        value === '' ||
+        (value === choice.initial && !choice.allowInitial)
+      ) {
         return 'Form is not complete';
       }
 

diff --git a/src/cli/init/prompts.ts b/src/cli/init/prompts.ts
@@ -11,7 +11,16 @@ import {
   isPlatform,
 } from './validation';
 
-import { Input, Select } from 'enquirer';
+import { type FormChoice, Input, Select } from 'enquirer';
+
+export type Choice = FormChoice & {
+  /**
+   * Whether the user is allowed to skip field entry and use the initial value.
+   *
+   * Defaults to `false`.
+   */
+  allowInitial?: boolean;
+};
 
 export type BaseFields = Record<
   (typeof BASE_CHOICES)[number]['name'],
@@ -62,14 +71,16 @@ const BASE_CHOICES = [
   {
     name: 'platformName',
     message: 'Platform',
-    initial: PLATFORM_OPTIONS,
+    initial: 'arm64',
+    allowInitial: true,
     validate: (value: unknown) =>
       isPlatform(value) || `must be ${PLATFORM_OPTIONS}`,
   },
   {
     name: 'defaultBranch',
     message: 'Default Branch',
-    initial: 'master | main',
+    initial: 'main',
+    allowInitial: true,
     validate: (value: unknown) =>
       typeof value === 'string' && value.length > 0 ? true : 'required',
   },