Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 28 additions & 22 deletions packages/void/src/cli/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1664,12 +1664,12 @@ async function promptDatabaseSetup(root: string): Promise<DatabaseSetupChoice> {
return choice as DatabaseSetupChoice;
}

async function promptDeploymentPlatform(
/** Ask where the project deploys, unless `deploy` answers it. The caller saves the answer. */
async function askDeploymentPlatform(
root: string,
deploy?: DeploymentPlatform,
): Promise<DeploymentPlatform> {
if (deploy) {
writeDeploymentPlatform(root, deploy);
return deploy;
}
assertInteractive('deploy', DEPLOYMENT_PLATFORMS);
Expand Down Expand Up @@ -1701,9 +1701,7 @@ async function promptDeploymentPlatform(
process.exit(0);
}

const platform = choice as DeploymentPlatform;
writeDeploymentPlatform(root, platform);
return platform;
return choice as DeploymentPlatform;
}

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

/** Returns whether a dependency was added. */
function setupExistingProject(root: string, framework?: DetectedFramework): boolean {
log.info('Existing project detected. Configuring Void...');
const dependencyAdded = ensureExistingProjectPackage(root, {
plainViteSetup: framework?.class !== 'c',
});
Expand Down Expand Up @@ -2775,25 +2772,31 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
'init: The --git/--no-git options are not available when adding a package to an existing monorepo.',
);
}
// Say what init will do before its first question. `.git` is allowed in an
// empty project, so detecting before `git init` gives the same result.
const framework = detectFramework(root);
const scaffoldStarter = !targeted && !framework && isScaffoldableEmptyProject(root);
if (framework) {
log.info(`Detected ${framework.name} framework`);
} else if (scaffoldStarter) {
log.info('Empty project detected. Creating a Pages starter.');
} else if (!targeted) {
log.info('Existing project detected. Configuring Void.');
}
const gitInitialized =
!workspaceSubpackage && (!targeted || initArgs?.git !== undefined)
? await setupGit(root, initArgs?.git)
: false;
const framework = detectFramework(root);
const preScaffoldState = detectProjectState(root);
const detectedPagesFramework = detectPagesFramework(root);
let scaffoldedPagesFramework: ScaffoldFramework | undefined;
let scaffoldedStarterMode: Exclude<ScaffoldStarterMode, 'static'> | undefined;
let starterDeploymentPlatform: DeploymentPlatform | undefined;
let didScaffoldStarter = false;
let scaffoldAddedDependencies = false;
let workspaceSubpackageSkip = false;

if (framework) {
log.info(`Detected ${framework.name} framework`);
}

if (!targeted && !framework && isScaffoldableEmptyProject(root)) {
log.info('Empty project detected. Creating a Pages starter.');
if (scaffoldStarter) {
const scaffoldToolchain = await promptScaffoldToolchain(initArgs?.toolchain);
if (detectedPagesFramework) {
scaffoldedPagesFramework = detectedPagesFramework;
Expand All @@ -2804,11 +2807,9 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
scaffoldedPagesFramework = await promptScaffoldFramework(initArgs?.framework);
}
const starterMode = await promptStarterMode(initArgs?.starter);
// A partial starter takes the existing-project path on retry, so check
// the last required flag before creating its files.
if (initArgs?.deploy === undefined) {
assertInteractive('deploy', DEPLOYMENT_PLATFORMS);
}
// A partial starter takes the existing-project path on retry, so ask every
// question before creating its files. The deployment choice is saved below.
starterDeploymentPlatform = await askDeploymentPlatform(root, initArgs?.deploy);
const existingPackageJson = readPackageJson(root);
const hasPackageManager =
hasLocalLockfile(root) ||
Expand Down Expand Up @@ -2956,10 +2957,15 @@ export async function runInitCommand(root: string, initArgs?: InitArgs): Promise
}
}

// Targeted runs keep the saved deployment preference without prompting.
const deploymentPlatform = !targeted
? await promptDeploymentPlatform(root, initArgs?.deploy)
: readDeploymentPlatform(root);
let deploymentPlatform: DeploymentPlatform | null;
if (targeted) {
// Targeted runs keep the saved deployment preference without prompting.
deploymentPlatform = readDeploymentPlatform(root);
} else {
deploymentPlatform =
starterDeploymentPlatform ?? (await askDeploymentPlatform(root, initArgs?.deploy));
writeDeploymentPlatform(root, deploymentPlatform);
}
let voidPlatformDiscovery: PlatformDiscoveryDocument | null = null;

if (!targeted && deploymentPlatform === 'cloudflare') {
Expand Down
82 changes: 82 additions & 0 deletions packages/void/test/unit/init.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,88 @@ describe('init scaffold arguments', () => {
});
});

describe('init question order', () => {
const DEPLOY_PROMPT = 'Where should this project deploy?';
const answers: Record<string, unknown> = {
'Choose a Pages scaffold toolchain:': 'vite',
'Choose a Pages framework to scaffold:': 'react',
'Choose a Pages starter:': 'static',
'Choose a database setup for this project:': 'none',
[DEPLOY_PROMPT]: 'none',
};

it('asks where a new starter deploys before writing its files', async () => {
const root = mkdtempSync(join(tmpdir(), 'void-init-order-'));
let entriesAtDeployPrompt: Array<string> | undefined;
try {
mockSelect.mockImplementation((options: { message: string }) => {
if (options.message === DEPLOY_PROMPT) {
entriesAtDeployPrompt = readdirSync(root);
}
return answers[options.message];
});

await runInitCommand(root);

expect(entriesAtDeployPrompt).toEqual([]);
expect(existsSync(join(root, 'pages', 'index.tsx'))).toBe(true);
expect(readDeploymentPlatform(root)).toBe('none');
} finally {
rmSync(root, { recursive: true, force: true });
}
});

it('leaves the folder empty when the deployment question is cancelled', async () => {
const root = mkdtempSync(join(tmpdir(), 'void-init-order-cancel-'));
const exit = vi.spyOn(process, 'exit').mockImplementation(() => {
throw new Error('Cancelled');
});
try {
mockSelect.mockImplementation((options: { message: string }) =>
options.message === DEPLOY_PROMPT ? Symbol.for('cancel') : answers[options.message],
);

await expect(runInitCommand(root)).rejects.toThrow('Cancelled');

expect(exit).toHaveBeenCalledWith(0);
expect(readdirSync(root)).toEqual([]);
} finally {
exit.mockRestore();
rmSync(root, { recursive: true, force: true });
}
});

it.each([
['an empty folder', 'Empty project detected. Creating a Pages starter.', false],
['an existing app', 'Existing project detected. Configuring Void.', true],
])('says what it does in %s before asking about Git', async (_name, message, existing) => {
const root = mkdtempSync(join(tmpdir(), 'void-init-order-git-'));
// Outside CI, init asks whether to initialize Git.
delete process.env.CI;
try {
if (existing) {
writeExistingViteApp(root, { void: '^0.0.1' });
}
mockSelect.mockImplementation((options: { message: string }) => answers[options.message]);
mockConfirm.mockResolvedValue(false);

await runInitCommand(root);

const infoIndex = mockLogInfo.mock.calls.findIndex(([text]) => text === message);
const gitIndex = mockConfirm.mock.calls.findIndex(
([options]) => options?.message === 'Initialize a git repository?',
);
expect(infoIndex).not.toBe(-1);
expect(gitIndex).not.toBe(-1);
expect(mockLogInfo.mock.invocationCallOrder[infoIndex]).toBeLessThan(
mockConfirm.mock.invocationCallOrder[gitIndex]!,
);
} finally {
rmSync(root, { recursive: true, force: true });
}
});
});

describe('GitHub Actions deployment workflows', () => {
it('requires a selected URL for a Void deployment workflow', () => {
expect(() => getWorkflowYaml('/project', 'npm', 'my-app', 'void')).toThrow('void connect');
Expand Down
Loading