Skip to content

Commit 4815bdc

Browse files
morinokamiclaude
andauthored
fix(init): ask every new-project question before writing the starter (#860)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 915ee74 commit 4815bdc

2 files changed

Lines changed: 110 additions & 22 deletions

File tree

‎packages/void/src/cli/init.ts‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1664,12 +1664,12 @@ async function promptDatabaseSetup(root: string): Promise<DatabaseSetupChoice> {
16641664
return choice as DatabaseSetupChoice;
16651665
}
16661666

1667-
async function promptDeploymentPlatform(
1667+
/** Ask where the project deploys, unless `deploy` answers it. The caller saves the answer. */
1668+
async function askDeploymentPlatform(
16681669
root: string,
16691670
deploy?: DeploymentPlatform,
16701671
): Promise<DeploymentPlatform> {
16711672
if (deploy) {
1672-
writeDeploymentPlatform(root, deploy);
16731673
return deploy;
16741674
}
16751675
assertInteractive('deploy', DEPLOYMENT_PLATFORMS);
@@ -1701,9 +1701,7 @@ async function promptDeploymentPlatform(
17011701
process.exit(0);
17021702
}
17031703

1704-
const platform = choice as DeploymentPlatform;
1705-
writeDeploymentPlatform(root, platform);
1706-
return platform;
1704+
return choice as DeploymentPlatform;
17071705
}
17081706

17091707
export async function ensureVoidPlatformConnection(
@@ -2581,7 +2579,6 @@ function ensureExistingProjectViteConfig(root: string, framework?: DetectedFrame
25812579

25822580
/** Returns whether a dependency was added. */
25832581
function setupExistingProject(root: string, framework?: DetectedFramework): boolean {
2584-
log.info('Existing project detected. Configuring Void...');
25852582
const dependencyAdded = ensureExistingProjectPackage(root, {
25862583
plainViteSetup: framework?.class !== 'c',
25872584
});
@@ -2775,25 +2772,31 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
27752772
'init: The --git/--no-git options are not available when adding a package to an existing monorepo.',
27762773
);
27772774
}
2775+
// Say what init will do before its first question. `.git` is allowed in an
2776+
// empty project, so detecting before `git init` gives the same result.
2777+
const framework = detectFramework(root);
2778+
const scaffoldStarter = !targeted && !framework && isScaffoldableEmptyProject(root);
2779+
if (framework) {
2780+
log.info(`Detected ${framework.name} framework`);
2781+
} else if (scaffoldStarter) {
2782+
log.info('Empty project detected. Creating a Pages starter.');
2783+
} else if (!targeted) {
2784+
log.info('Existing project detected. Configuring Void.');
2785+
}
27782786
const gitInitialized =
27792787
!workspaceSubpackage && (!targeted || initArgs?.git !== undefined)
27802788
? await setupGit(root, initArgs?.git)
27812789
: false;
2782-
const framework = detectFramework(root);
27832790
const preScaffoldState = detectProjectState(root);
27842791
const detectedPagesFramework = detectPagesFramework(root);
27852792
let scaffoldedPagesFramework: ScaffoldFramework | undefined;
27862793
let scaffoldedStarterMode: Exclude<ScaffoldStarterMode, 'static'> | undefined;
2794+
let starterDeploymentPlatform: DeploymentPlatform | undefined;
27872795
let didScaffoldStarter = false;
27882796
let scaffoldAddedDependencies = false;
27892797
let workspaceSubpackageSkip = false;
27902798

2791-
if (framework) {
2792-
log.info(`Detected ${framework.name} framework`);
2793-
}
2794-
2795-
if (!targeted && !framework && isScaffoldableEmptyProject(root)) {
2796-
log.info('Empty project detected. Creating a Pages starter.');
2799+
if (scaffoldStarter) {
27972800
const scaffoldToolchain = await promptScaffoldToolchain(initArgs?.toolchain);
27982801
if (detectedPagesFramework) {
27992802
scaffoldedPagesFramework = detectedPagesFramework;
@@ -2804,11 +2807,9 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
28042807
scaffoldedPagesFramework = await promptScaffoldFramework(initArgs?.framework);
28052808
}
28062809
const starterMode = await promptStarterMode(initArgs?.starter);
2807-
// A partial starter takes the existing-project path on retry, so check
2808-
// the last required flag before creating its files.
2809-
if (initArgs?.deploy === undefined) {
2810-
assertInteractive('deploy', DEPLOYMENT_PLATFORMS);
2811-
}
2810+
// A partial starter takes the existing-project path on retry, so ask every
2811+
// question before creating its files. The deployment choice is saved below.
2812+
starterDeploymentPlatform = await askDeploymentPlatform(root, initArgs?.deploy);
28122813
const existingPackageJson = readPackageJson(root);
28132814
const hasPackageManager =
28142815
hasLocalLockfile(root) ||
@@ -2956,10 +2957,15 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
29562957
}
29572958
}
29582959

2959-
// Targeted runs keep the saved deployment preference without prompting.
2960-
const deploymentPlatform = !targeted
2961-
? await promptDeploymentPlatform(root, initArgs?.deploy)
2962-
: readDeploymentPlatform(root);
2960+
let deploymentPlatform: DeploymentPlatform | null;
2961+
if (targeted) {
2962+
// Targeted runs keep the saved deployment preference without prompting.
2963+
deploymentPlatform = readDeploymentPlatform(root);
2964+
} else {
2965+
deploymentPlatform =
2966+
starterDeploymentPlatform ?? (await askDeploymentPlatform(root, initArgs?.deploy));
2967+
writeDeploymentPlatform(root, deploymentPlatform);
2968+
}
29632969
let voidPlatformDiscovery: PlatformDiscoveryDocument | null = null;
29642970

29652971
if (!targeted && deploymentPlatform === 'cloudflare') {

‎packages/void/test/unit/init.test.ts‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,88 @@ describe('init scaffold arguments', () => {
220220
});
221221
});
222222

223+
describe('init question order', () => {
224+
const DEPLOY_PROMPT = 'Where should this project deploy?';
225+
const answers: Record<string, unknown> = {
226+
'Choose a Pages scaffold toolchain:': 'vite',
227+
'Choose a Pages framework to scaffold:': 'react',
228+
'Choose a Pages starter:': 'static',
229+
'Choose a database setup for this project:': 'none',
230+
[DEPLOY_PROMPT]: 'none',
231+
};
232+
233+
it('asks where a new starter deploys before writing its files', async () => {
234+
const root = mkdtempSync(join(tmpdir(), 'void-init-order-'));
235+
let entriesAtDeployPrompt: Array<string> | undefined;
236+
try {
237+
mockSelect.mockImplementation((options: { message: string }) => {
238+
if (options.message === DEPLOY_PROMPT) {
239+
entriesAtDeployPrompt = readdirSync(root);
240+
}
241+
return answers[options.message];
242+
});
243+
244+
await runInitCommand(root);
245+
246+
expect(entriesAtDeployPrompt).toEqual([]);
247+
expect(existsSync(join(root, 'pages', 'index.tsx'))).toBe(true);
248+
expect(readDeploymentPlatform(root)).toBe('none');
249+
} finally {
250+
rmSync(root, { recursive: true, force: true });
251+
}
252+
});
253+
254+
it('leaves the folder empty when the deployment question is cancelled', async () => {
255+
const root = mkdtempSync(join(tmpdir(), 'void-init-order-cancel-'));
256+
const exit = vi.spyOn(process, 'exit').mockImplementation(() => {
257+
throw new Error('Cancelled');
258+
});
259+
try {
260+
mockSelect.mockImplementation((options: { message: string }) =>
261+
options.message === DEPLOY_PROMPT ? Symbol.for('cancel') : answers[options.message],
262+
);
263+
264+
await expect(runInitCommand(root)).rejects.toThrow('Cancelled');
265+
266+
expect(exit).toHaveBeenCalledWith(0);
267+
expect(readdirSync(root)).toEqual([]);
268+
} finally {
269+
exit.mockRestore();
270+
rmSync(root, { recursive: true, force: true });
271+
}
272+
});
273+
274+
it.each([
275+
['an empty folder', 'Empty project detected. Creating a Pages starter.', false],
276+
['an existing app', 'Existing project detected. Configuring Void.', true],
277+
])('says what it does in %s before asking about Git', async (_name, message, existing) => {
278+
const root = mkdtempSync(join(tmpdir(), 'void-init-order-git-'));
279+
// Outside CI, init asks whether to initialize Git.
280+
delete process.env.CI;
281+
try {
282+
if (existing) {
283+
writeExistingViteApp(root, { void: '^0.0.1' });
284+
}
285+
mockSelect.mockImplementation((options: { message: string }) => answers[options.message]);
286+
mockConfirm.mockResolvedValue(false);
287+
288+
await runInitCommand(root);
289+
290+
const infoIndex = mockLogInfo.mock.calls.findIndex(([text]) => text === message);
291+
const gitIndex = mockConfirm.mock.calls.findIndex(
292+
([options]) => options?.message === 'Initialize a git repository?',
293+
);
294+
expect(infoIndex).not.toBe(-1);
295+
expect(gitIndex).not.toBe(-1);
296+
expect(mockLogInfo.mock.invocationCallOrder[infoIndex]).toBeLessThan(
297+
mockConfirm.mock.invocationCallOrder[gitIndex]!,
298+
);
299+
} finally {
300+
rmSync(root, { recursive: true, force: true });
301+
}
302+
});
303+
});
304+
223305
describe('GitHub Actions deployment workflows', () => {
224306
it('requires a selected URL for a Void deployment workflow', () => {
225307
expect(() => getWorkflowYaml('/project', 'npm', 'my-app', 'void')).toThrow('void connect');

0 commit comments

Comments
 (0)