Skip to content
Open
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
4 changes: 3 additions & 1 deletion apps/cli/src/prompts/backend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ export async function getBackendFrameworkChoice(
) {
if (backendFramework !== undefined) return backendFramework;

const hasIncompatibleFrontend = frontends?.some((f) => f === "solid" || f === "astro");
const hasIncompatibleFrontend = frontends?.some(
(f) => f === "solid" || f === "astro" || f === "foldkit",
);
const hasFullstackFrontend = frontends?.some((f) => FULLSTACK_FRONTENDS.includes(f));

const backendOptions: Array<{
Expand Down
6 changes: 6 additions & 0 deletions apps/cli/src/prompts/frontend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const WEB_FRONTEND_VALUES: readonly Frontend[] = [
"svelte",
"solid",
"astro",
"foldkit",
"tanstack-start",
];

Expand Down Expand Up @@ -103,6 +104,11 @@ export async function getFrontendChoice(
label: "Astro",
hint: "The web framework for content-driven websites",
},
{
value: "foldkit" as const,
label: "Foldkit",
hint: "Effect-powered TypeScript framework architected like Elm",
},
{
value: "tanstack-start" as const,
label: "TanStack Start",
Expand Down
4 changes: 2 additions & 2 deletions apps/cli/src/prompts/payments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export async function getPaymentsChoice(
payments?: Payments,
auth?: Auth,
backend?: Backend,
_frontends?: Frontend[],
frontends?: Frontend[],
previousValue?: Payments,
) {
if (payments !== undefined) return payments;
Expand All @@ -16,7 +16,7 @@ export async function getPaymentsChoice(
return "none" as Payments;
}

const isPolarCompatible = auth === "better-auth";
const isPolarCompatible = auth === "better-auth" && !frontends?.includes("foldkit");

if (!isPolarCompatible) {
return "none" as Payments;
Expand Down
19 changes: 11 additions & 8 deletions apps/cli/src/prompts/web-deploy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import type {
} from "../types";
import { WEB_FRAMEWORKS } from "../utils/compatibility";
import {
supportsCloudflareWebDeploy,
supportsPrismaWebDeploy,
validateCloudflareWebDeployKnownIssues,
} from "../utils/compatibility-rules";
Expand Down Expand Up @@ -84,13 +85,15 @@ export async function getDeploymentChoice(
}

const supportsPrismaCompute = supportsPrismaWebDeploy(frontend);
const supportsCloudflare = validateCloudflareWebDeployKnownIssues({
webDeploy: "cloudflare",
frontend,
dbSetup,
database,
orm,
}).isOk();
const supportsCloudflare =
supportsCloudflareWebDeploy(frontend) &&
validateCloudflareWebDeployKnownIssues({
webDeploy: "cloudflare",
frontend,
dbSetup,
database,
orm,
}).isOk();
const availableDeployments = [
...(supportsCloudflare ? (["cloudflare"] as const) : []),
...(supportsPrismaCompute ? (["prisma"] as const) : []),
Expand Down Expand Up @@ -131,7 +134,7 @@ export async function getDeploymentToAdd(frontend: Frontend[], existingDeploymen

const supportsPrismaCompute = supportsPrismaWebDeploy(frontend);
const deployments = [
"cloudflare",
...(supportsCloudflareWebDeploy(frontend) ? (["cloudflare"] as const) : []),
...(supportsPrismaCompute ? (["prisma"] as const) : []),
"docker",
"vercel",
Expand Down
70 changes: 55 additions & 15 deletions apps/cli/src/utils/compatibility-rules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -205,17 +205,25 @@ export function validateWorkersCompatibility(
return Result.ok(undefined);
}

// Frontends whose web client templates exist for oRPC only.
const TRPC_UNSUPPORTED_FRONTENDS: readonly Frontend[] = [
"nuxt",
"svelte",
"solid",
"astro",
"foldkit",
];

export function validateApiFrontendCompatibility(
api: API | undefined,
frontends: Frontend[] = [],
): ValidationResult {
const includesNuxt = frontends.includes("nuxt");
const includesSvelte = frontends.includes("svelte");
const includesSolid = frontends.includes("solid");
const includesAstro = frontends.includes("astro");
if ((includesNuxt || includesSvelte || includesSolid || includesAstro) && api === "trpc") {
if (api !== "trpc") return Result.ok(undefined);

const unsupported = frontends.find((frontend) => TRPC_UNSUPPORTED_FRONTENDS.includes(frontend));
if (unsupported) {
return validationErr(
`tRPC API is not supported with '${includesNuxt ? "nuxt" : includesSvelte ? "svelte" : includesSolid ? "solid" : "astro"}' frontend. Please use --api orpc or --api none or remove '${includesNuxt ? "nuxt" : includesSvelte ? "svelte" : includesSolid ? "solid" : "astro"}' from --frontend.`,
`tRPC API is not supported with '${unsupported}' frontend. Please use --api orpc or --api none or remove '${unsupported}' from --frontend.`,
);
}
return Result.ok(undefined);
Expand All @@ -236,11 +244,11 @@ export function isFrontendAllowedWithBackend(
return false;
}

if (frontend === "solid" || frontend === "astro") return false;
if (frontend === "solid" || frontend === "astro" || frontend === "foldkit") return false;
}

if (auth === "clerk") {
const incompatibleFrontends = ["nuxt", "svelte", "solid", "astro"];
const incompatibleFrontends = ["nuxt", "svelte", "solid", "astro", "foldkit"];
if (incompatibleFrontends.includes(frontend)) return false;
}

Expand All @@ -256,12 +264,8 @@ export function supportsConvexBetterAuth(frontends: readonly Frontend[] = []) {
}

export function allowedApisForFrontends(frontends: Frontend[] = []) {
const includesNuxt = frontends.includes("nuxt");
const includesSvelte = frontends.includes("svelte");
const includesSolid = frontends.includes("solid");
const includesAstro = frontends.includes("astro");
const base: API[] = ["trpc", "orpc", "none"];
if (includesNuxt || includesSvelte || includesSolid || includesAstro) {
if (frontends.some((frontend) => TRPC_UNSUPPORTED_FRONTENDS.includes(frontend))) {
return ["orpc", "none"];
}
return base;
Expand All @@ -284,7 +288,8 @@ export function isExampleAIAllowed(backend?: ProjectConfig["backend"], frontends

const includesSolid = frontends.includes("solid");
const includesAstro = frontends.includes("astro");
if (includesSolid || includesAstro) return false;
const includesFoldkit = frontends.includes("foldkit");
if (includesSolid || includesAstro || includesFoldkit) return false;

// Convex AI example only supports React-based frontends (not Svelte or Nuxt)
if (backend === "convex") {
Expand Down Expand Up @@ -415,6 +420,31 @@ export function validatePrismaWebDeploy(
return Result.ok(undefined);
}

// Frontends the Alchemy generator has no Cloudflare Workers recipe for.
const CLOUDFLARE_WEB_DEPLOY_UNSUPPORTED_FRONTENDS: readonly Frontend[] = ["foldkit"];

export function supportsCloudflareWebDeploy(frontend: Frontend[] = []): boolean {
return !frontend.some((value) => CLOUDFLARE_WEB_DEPLOY_UNSUPPORTED_FRONTENDS.includes(value));
}

export function validateCloudflareWebDeploy(
webDeploy: WebDeploy | undefined,
frontend: Frontend[] | undefined,
): ValidationResult {
if (webDeploy !== "cloudflare" || !frontend) return Result.ok(undefined);

const unsupported = frontend.find((value) =>
CLOUDFLARE_WEB_DEPLOY_UNSUPPORTED_FRONTENDS.includes(value),
);
if (unsupported) {
return validationErr(
`'--web-deploy cloudflare' has no Alchemy recipe for the '${unsupported}' frontend. Choose '--web-deploy docker', '--web-deploy vercel', or '--web-deploy none'.`,
);
}

return Result.ok(undefined);
}

export function validateCloudflareWebDeployKnownIssues(
config: Partial<Pick<ProjectConfig, "database" | "dbSetup" | "frontend" | "orm" | "webDeploy">>,
): ValidationResult {
Expand Down Expand Up @@ -651,7 +681,7 @@ export function validatePaymentsCompatibility(
payments: Payments | undefined,
auth: Auth | undefined,
_backend: Backend | undefined,
_frontends: Frontend[] = [],
frontends: Frontend[] = [],
): ValidationResult {
if (!payments || payments === "none") return Result.ok(undefined);

Expand All @@ -661,6 +691,12 @@ export function validatePaymentsCompatibility(
"Polar payments requires Better Auth. Please use '--auth better-auth' or choose a different payments provider.",
);
}

if (frontends.includes("foldkit")) {
return validationErr(
"Polar payments has no Foldkit checkout template yet. Please use '--payments none' or choose a different frontend.",
);
}
}

return Result.ok(undefined);
Expand Down Expand Up @@ -697,6 +733,10 @@ export function validateExamplesCompatibility(
return validationErr("The 'ai' example is not compatible with the Astro frontend.");
}

if (examplesArr.includes("ai") && (frontend ?? []).includes("foldkit")) {
return validationErr("The 'ai' example is not compatible with the Foldkit frontend.");
}

if (examplesArr.includes("ai") && backend === "none") {
return validationErr("The 'ai' example requires a backend.");
}
Expand Down
1 change: 1 addition & 0 deletions apps/cli/src/utils/compatibility.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ export const WEB_FRAMEWORKS: readonly Frontend[] = [
"svelte",
"solid",
"astro",
"foldkit",
] as const;
8 changes: 6 additions & 2 deletions apps/cli/src/utils/config-validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
validateServerDeployRequiresBackend,
validateVercelServerDeploy,
validatePrismaServerDeploy,
validateCloudflareWebDeploy,
validatePrismaWebDeploy,
validatePrismaWebDeployDesktopAddons,
validateCloudflareWebDeployKnownIssues,
Expand Down Expand Up @@ -433,7 +434,7 @@ export function validateBackendConstraints(

if (config.auth === "clerk" && config.frontend) {
const incompatibleFrontends = config.frontend.filter((f) =>
["nuxt", "svelte", "solid", "astro"].includes(f),
["nuxt", "svelte", "solid", "astro", "foldkit"].includes(f),
);
if (incompatibleFrontends.length > 0) {
return validationErr(
Expand All @@ -459,7 +460,9 @@ export function validateBackendConstraints(
}

if (backend === "convex" && providedFlags.has("frontend") && options.frontend) {
const incompatibleFrontends = options.frontend.filter((f) => f === "solid" || f === "astro");
const incompatibleFrontends = options.frontend.filter(
(f) => f === "solid" || f === "astro" || f === "foldkit",
);
if (incompatibleFrontends.length > 0) {
return validationErr(
`The following frontends are not compatible with '--backend convex': ${incompatibleFrontends.join(
Expand Down Expand Up @@ -547,6 +550,7 @@ export function validateFullConfig(
yield* validateVercelServerDeploy(config.serverDeploy, config.backend, config.runtime);
yield* validatePrismaServerDeploy(config.serverDeploy, config.backend, config.runtime);
yield* validatePrismaWebDeploy(config.webDeploy, config.frontend);
yield* validateCloudflareWebDeploy(config.webDeploy, config.frontend);
yield* validateCloudflareWebDeployKnownIssues(config);
yield* validateDockerWebDeployDesktopAddons(
config.webDeploy,
Expand Down
3 changes: 3 additions & 0 deletions apps/cli/src/utils/requirements.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ function getNodeToolingRequirements(config: RequirementConfig): VersionRequireme
case "solid":
addNodeRequirement(requirements, ">=24.0.0", "Solid");
break;
case "foldkit":
addNodeRequirement(requirements, "^20.19.0 || >=22.12.0", "Foldkit");
break;
case "react-router":
addNodeRequirement(requirements, ">=22.22.0", "React Router 8");
break;
Expand Down
Loading