@django-stack/cli 0.9.0 → 0.11.0

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { $ as dockerRunning, A as projectStack, C as RUN_DOMAIN, D as composeOutput, E as compose, F as DEFAULT_STACK, G as DEV_PORTS, H as pendingChoices, I as NAMED_PRESETS, J as envPorts, K as chooseFreePorts, L as PROMPT_ORDER, M as readLocalRun, N as readProject, O as findProjectDirectory, P as runningServices, Q as dockerNotRunning, R as STACK_OPTIONS, S as generateSecret, T as activeProject, U as resolvePreset, V as encodePreset, W as stackOption, X as runDoctor, Y as portValues, Z as checkTools, _ as validateProjectName, a as LOCAL_S3, b as PACKAGE_NAME, c as lockBackend, d as scaffold, et as isDockerDown, f as setNotificationsApp, g as usesValkey, h as umamiEnv, j as projectUrls, k as parseProfiles, m as toProjectName, n as productionEnv$1, nt as quoteEnvValue, o as cacheEnv, p as timeZones, q as describeMove, r as validateDomain, rt as setEnvValues, s as localS3, t as missingS3, tt as parseEnv, u as relativeDirectory, v as validateTimeZone, w as RUN_ENV, x as generateProjectSecrets, y as CLI_VERSION, z as applies } from "./production-M2SsuuBb.js";
+import { $ as envPorts, A as compose, B as NAMED_PRESETS, C as PACKAGE_NAME, D as RUN_DOMAIN, E as CAPTCHA_APP, F as projectUrls, H as PROMPT_ORDER, I as readLocalRun, J as resolvePreset, K as encodePreset, L as readProject, M as findProjectDirectory, N as parseProfiles, O as RUN_ENV, P as projectStack, Q as describeMove, R as runningServices, S as CLI_VERSION, T as generateSecret, U as STACK_OPTIONS, V as NODE_FRONTENDS, W as applies, X as DEV_PORTS, Y as stackOption, Z as chooseFreePorts, _ as umamiEnv, a as LOCAL_S3, at as isDockerDown, b as validateProjectName, c as localS3, ct as setEnvValues, et as portValues, f as relativeDirectory, g as toProjectName, h as timeZones, it as dockerRunning, j as composeOutput, k as activeProject, l as lockBackend, m as setNotificationsApp, n as productionEnv$1, nt as checkTools, o as cacheEnv, ot as parseEnv, p as scaffold, q as pendingChoices, r as validateDomain, rt as dockerNotRunning, s as frontendPackageManager, st as quoteEnvValue, t as missingS3, tt as runDoctor, u as lockFrontend, v as updateFrontendLock, w as generateProjectSecrets, x as validateTimeZone, y as usesValkey, z as DEFAULT_STACK } from "./production-WThC1aS2.js";
 import { createRequire } from "node:module";
 import { chmodSync, existsSync, mkdirSync, mkdtempSync, readFileSync, readdirSync, rmSync, writeFileSync } from "node:fs";
 import { basename, delimiter, dirname, join, posix, relative, resolve, sep } from "node:path";
@@ -3930,7 +3930,8 @@ function choices(key, stack = {}) {
 /**
 * The stack from, in order of precedence, the flags, the preset, the prompts
 * and the defaults. `askDatabase` asks for the Postgres version together with
-* the external database choice; it returns the version, or a URL.
+* the external database choice; it returns the version, and the URL for
+* production when there is one.
 */
 async function chooseStack(options, interactive, askDatabase) {
 	let preset;
@@ -3949,10 +3950,9 @@ async function chooseStack(options, interactive, askDatabase) {
 		else if (!interactive || !applies(key, stack)) continue;
 		else if (key === "postgres" && askDatabase && !options.databaseUrl) {
 			const answer = await askDatabase(stack[key]);
-			if ("databaseUrl" in answer) databaseUrl = answer.databaseUrl;
-			else stack[key] = answer.postgres;
-		} else if (key === "postgres" && options.databaseUrl) continue;
-		else {
+			if (answer.databaseUrl) databaseUrl = answer.databaseUrl;
+			stack[key] = answer.postgres;
+		} else {
 			const initialValue = key === "storage" && stack.media === "s3" ? "s3" : stack[key];
 			stack[key] = unwrap(await p.select({
 				message: option.message,
@@ -4018,19 +4018,31 @@ async function init(directoryArgument, options) {
 				label: `Bundled Postgres, ${value.label.toLowerCase()}`
 			})), {
 				value: "external",
-				label: "External Postgres",
-				hint: "a URL to your own server"
+				label: "External Postgres in production",
+				hint: "a URL to your server; development runs the bundled one"
 			}]
 		}));
 		if (choice !== "external") return { postgres: choice };
-		return { databaseUrl: unwrap(await p.text({
-			message: "Postgres URL",
+		const databaseUrl = unwrap(await p.text({
+			message: "Postgres URL for production",
 			placeholder: "postgres://user:password@host:5432/name",
 			validate: (value) => value?.startsWith("postgres") ? void 0 : "Enter a postgres:// URL."
-		})) };
+		}));
+		return {
+			postgres: unwrap(await p.select({
+				message: "Its Postgres version",
+				initialValue: initial,
+				options: choices("postgres")
+			})),
+			databaseUrl
+		};
 	});
 	const stack = chosen.stack;
 	const databaseUrl = options.databaseUrl ?? chosen.databaseUrl;
+	if (!applies("analytics", stack) && stack.analytics !== "off") {
+		if (options.fromCli("analytics")) fail("--analytics umami needs a frontend: a headless project has no pages to count.");
+		stack.analytics = "off";
+	}
 	const pending = pendingChoices(stack);
 	const unavailable = pending.filter((item) => !item.isDefault);
 	if (unavailable.length) fail(`${unavailable.map((item) => item.choice).join(", ")} ${unavailable.length > 1 ? "are" : "is"} not available yet. Leave ${unavailable.length > 1 ? "them" : "it"} at the default.`);
@@ -4066,10 +4078,13 @@ async function init(directoryArgument, options) {
 			frontend: stack.frontend,
 			demoContent,
 			databaseUrl,
+			postgres: stack.postgres,
 			localS3: stack.storage === "s3",
 			analytics: stack.analytics === "umami",
 			cache: stack.cache,
 			notifications: stack.notifications === "on",
+			captcha: stack.captcha === "on",
+			packageManager: stack.packageManager,
 			errors: stack.errors,
 			tasks: stack.tasks,
 			preset: encodePreset(stack),
@@ -4087,6 +4102,16 @@ async function init(directoryArgument, options) {
 		if (lockBackend(target)) spinner.stop(`Locked the backend dependencies in ${pc.bold("backend/uv.lock")}`);
 		else spinner.error("Could not lock the backend dependencies. The image build resolves them instead.");
 	}
+	if (NODE_FRONTENDS.includes(stack.frontend)) {
+		const lockfile = {
+			pnpm: "pnpm-lock.yaml",
+			npm: "package-lock.json",
+			bun: "bun.lock"
+		}[stack.packageManager];
+		spinner.start(`Locking the frontend dependencies with ${stack.packageManager}`);
+		if (lockFrontend(target, stack.packageManager)) spinner.stop(`Locked the frontend dependencies in ${pc.bold(`frontend/${lockfile}`)}`);
+		else spinner.error("Could not lock the frontend dependencies. The image build resolves them instead.");
+	}
 	if (options.git && has("git")) try {
 		execFileSync("git", ["init", "--quiet"], {
 			cwd: target,
@@ -4115,7 +4140,7 @@ async function init(directoryArgument, options) {
 		command(`cd ${relativeDirectory(target)}`),
 		command(startCommand),
 		"",
-		`${pc.bold("Site")}    ${url(`http://localhost:${ports.ports.SITE_PORT}`)}`,
+		stack.frontend === "headless" ? `${pc.bold("API")}     ${url(`http://localhost:${ports.ports.SITE_PORT}/api/`)}` : `${pc.bold("Site")}    ${url(`http://localhost:${ports.ports.SITE_PORT}`)}`,
 		`${pc.bold("Admin")}   ${url(`http://localhost:${ports.ports.SITE_PORT}/admin/`)}`,
 		`${pc.bold("Mail")}    ${url(`http://localhost:${ports.ports.MAIL_PORT}`)}`,
 		"",
@@ -4512,7 +4537,8 @@ const SWITCHABLE = [
 	"media",
 	"cache",
 	"tasks",
-	"notifications"
+	"notifications",
+	"captcha"
 ];
 const EMPTY_S3 = Object.fromEntries(Object.keys(LOCAL_S3).map((key) => [key, key === "S3_CREATE_BUCKET" ? "0" : ""]));
 /**
@@ -4528,6 +4554,7 @@ function applyStack(envText, env, from, to) {
 		if (from[key] === to[key]) continue;
 		const value = option.values.find((candidate) => candidate.value === to[key]);
 		if (!value) throw new Error(`${JSON.stringify(to[key])} is not a ${option.key}.`);
+		if (key === "postgres") throw new Error("--postgres can't change on an existing project: a new major version needs a backup and a restore. See the docs on backups.");
 		if (!SWITCHABLE.includes(key) || !value.generated) throw new Error(`${option.flag} ${to[key]} can't be set on an existing project in this version yet.`);
 		if (key === "storage") {
 			if (profiles.includes("prod")) throw new Error("--storage only changes development; this .env runs the prod profile.");
@@ -4580,6 +4607,10 @@ function applyStack(envText, env, from, to) {
 			}
 		}
 		if (key === "notifications") changes.push(to.notifications === "on" ? "Notifications are on: content_studio.notifications is in INSTALLED_APPS." : "Notifications are off: content_studio.notifications is out of INSTALLED_APPS; its tables stay.");
+		if (key === "captcha") {
+			text = setEnvValues(text, { CAPTCHA: to.captcha });
+			changes.push(to.captcha === "on" ? "The captcha of the contact form is on." : "The captcha is off: public forms need no captcha token.");
+		}
 		if (key === "media") changes.push(to.media === "s3" ? "Uploads in production go to S3; dstack settings asks for the S3 settings." : "Uploads in production stay on the server.");
 	}
 	return {
@@ -4622,7 +4653,8 @@ function ensureRunEnv(project) {
 	if (!existsSync(path)) {
 		const result = productionEnv$1(readFileSync(join(project.directory, ".env"), "utf8"), {
 			domain: RUN_DOMAIN,
-			emailUrl: "console://"
+			emailUrl: "console://",
+			bundledDatabase: true
 		});
 		writeFileSync(path, result.text, { mode: 384 });
 		p.log.success(`Wrote ${pc.bold(RUN_ENV)}: the prod profile at ${url(`https://${RUN_DOMAIN}`)}, with its own secrets and data.`);
@@ -4678,7 +4710,8 @@ async function dev(options) {
 	intro("Develop");
 	project = await freeDevPorts(project);
 	urlsNote(project, "Starting");
-	p.log.message(pc.dim("Changes in backend/ and frontend/ reload. Press Ctrl+C to stop."));
+	const reloads = project.services.frontend ? "backend/ and frontend/" : "backend/";
+	p.log.message(pc.dim(`Changes in ${reloads} reload. Press Ctrl+C to stop.`));
 	exitWith(compose(project, ["up", ...options.build ? ["--build"] : []]));
 }
 /** `dstack stop`: stop the containers of the project and of its local run; volumes and data stay. */
@@ -4827,6 +4860,10 @@ async function types(options) {
 		"--file",
 		"openapi.json"
 	], false)) !== 0) fail("The backend could not write its schema.");
+	if (!project.services.frontend) {
+		p.outro(`Wrote ${pc.bold("backend/openapi.json")}`);
+		return;
+	}
 	const generate = [
 		"npx",
 		"headless",
@@ -4914,7 +4951,7 @@ function checkSteps(project, tests) {
 		],
 		devOnly: true
 	});
-	return steps.filter((step) => !(step.devOnly && project.prod));
+	return steps.filter((step) => !(step.devOnly && project.prod) && (step.service !== "frontend" || project.services.frontend));
 }
 /** `dstack check`: the doctor's checks, Django's checks, the linters and, with --tests, the tests. */
 async function check(options) {
@@ -4998,6 +5035,11 @@ async function update(options) {
 		}).status !== 0) fail("uv could not update backend/uv.lock.");
 		p.log.success(options.all ? "Updated backend/uv.lock" : "Updated django-stack in backend/uv.lock");
 	} else if (existsSync(lock)) p.log.warn("uv is not installed, so backend/uv.lock stays as it is: https://docs.astral.sh/uv/");
+	if (frontendPackageManager(project.directory)) {
+		const lockfile = updateFrontendLock(project.directory, options.all);
+		if (!lockfile) fail("The package manager could not update the frontend's lockfile.");
+		p.log.success(options.all ? `Updated frontend/${lockfile}` : `Updated the @django-stack packages in frontend/${lockfile}`);
+	}
 	for (const target of targets) {
 		if (compose(target, ["pull", "--ignore-buildable"]) !== 0) fail("Pulling the images failed.");
 		const build = [
@@ -5007,8 +5049,8 @@ async function update(options) {
 		];
 		if (compose(target, build) !== 0) fail("Building the images failed.");
 	}
-	const volume = project.prod ? void 0 : nodeModulesVolume(project);
-	if (volume) {
+	const volume = project.prod || !project.services.frontend ? void 0 : nodeModulesVolume(project);
+	if (volume && project.services.frontend) {
 		compose(project, [
 			"rm",
 			"--stop",
@@ -5058,6 +5100,9 @@ async function config(options) {
 		if (!existsSync(compose) || !/^ {2}umami:/m.test(readFileSync(compose, "utf8"))) fail("compose.yaml has no umami service. Add it as the analytics docs describe, then run this again.");
 	}
 	const settingsPath = join(project.directory, "backend", "config", "settings.py");
+	if (next.captcha === "on" && current.captcha !== "on") {
+		if (!existsSync(settingsPath) || !CAPTCHA_APP.test(readFileSync(settingsPath, "utf8"))) fail("The backend has no django_stack.contrib.captcha. Add it and the widget as the captcha docs describe, then run this again.");
+	}
 	let settingsText;
 	if (next.notifications !== current.notifications) {
 		if (!existsSync(settingsPath)) fail("This project has no backend/config/settings.py.");
@@ -5288,7 +5333,7 @@ function createProgram() {
 		styleArgumentText: (text) => pc.yellow(text),
 		styleDescriptionText: (text) => text
 	}).configureOutput({ outputError: (text, write) => write(pc.red(text)) });
-	const initCommand = program.command("init").alias("create").description("Create a project").argument("[directory]", "Where to create the project").option("--name <name>", "The project name (default: from the directory)").option("--preset <preset>", `A preset code from a previous init, or ${Object.keys(NAMED_PRESETS).join(", ")}`).option("--database-url <url>", "Use an external Postgres instead of the bundled one").option("--time-zone <zone>", "The time zone of the backend, such as Europe/Amsterdam (default: UTC)").addOption(new Option("--local-s3", "Same as --storage s3").hideHelp()).option("--no-demo-content", "Start with an empty site").option("--no-git", "Don't create a git repository").option("--start", "Run `docker compose up` when done").option("-y, --yes", "Accept the defaults without asking").addOption(new Option("--link <repository>", "Take the packages from a DjangoStack checkout").hideHelp()).action((directory, options, cmd) => init(directory, {
+	const initCommand = program.command("init").alias("create").description("Create a project").argument("[directory]", "Where to create the project").option("--name <name>", "The project name (default: from the directory)").option("--preset <preset>", `A preset code from a previous init, or ${Object.keys(NAMED_PRESETS).join(", ")}`).option("--database-url <url>", "An external Postgres for production; development runs the bundled one").option("--time-zone <zone>", "The time zone of the backend, such as Europe/Amsterdam (default: UTC)").addOption(new Option("--local-s3", "Same as --storage s3").hideHelp()).option("--no-demo-content", "Start with an empty site").option("--no-git", "Don't create a git repository").option("--start", "Run `docker compose up` when done").option("-y, --yes", "Accept the defaults without asking").addOption(new Option("--link <repository>", "Take the packages from a DjangoStack checkout").hideHelp()).action((directory, options, cmd) => init(directory, {
 		...options,
 		installPrompt: program.opts().installPrompt,
 		fromCli: (option) => cmd.getOptionValueSource(option) === "cli"
@@ -5301,7 +5346,7 @@ function createProgram() {
 	program.command("logs").description("Show the logs of the services").argument("[services...]", "Only these services, such as backend").addOption(dirOption()).option("--no-follow", "Print the logs and exit").option("-n, --tail <lines>", "Only the last lines of each service").action(logs);
 	program.command("status").description("Show the containers and whether the database, cache, worker and backups are healthy").addOption(dirOption()).action(status);
 	program.command("check").description("Check the project: setup, Django checks, migrations and linters").addOption(dirOption()).option("--tests", "Run the backend and frontend tests too").action(check);
-	program.command("update").description("Pull and rebuild the images and update the DjangoStack packages").addOption(dirOption()).option("--all", "Update every backend package in uv.lock, not only django-stack").option("--no-cache", "Rebuild the images from scratch").option("--no-restart", "Don't restart what was running").action(update);
+	program.command("update").description("Pull and rebuild the images and update the DjangoStack packages").addOption(dirOption()).option("--all", "Update every package in the lockfiles, not only DjangoStack's").option("--no-cache", "Rebuild the images from scratch").option("--no-restart", "Don't restart what was running").action(update);
 	const configCommand = program.command("config").description("Change the stack options of a project").addOption(dirOption()).option("-y, --yes", "Don't ask; change only what the flags set").action((options, cmd) => config({
 		...options,
 		fromCli: (option) => cmd.getOptionValueSource(option) === "cli"

package/dist/index.d.ts

@@ -20,6 +20,8 @@ interface ProductionOptions {
   emailUrl?: string;
   /** Where uploads go: `s3` asks for the S3 settings (the `media` stack option). */
   media?: string;
+  /** Keep the bundled database even with PRODUCTION_DATABASE_URL: the local run on this machine. */
+  bundledDatabase?: boolean;
 }
 interface ProductionEnv {
   text: string;
@@ -54,12 +56,12 @@ export declare const STACK_OPTIONS: readonly [{
     readonly value: "headless";
     readonly label: "Headless";
     readonly hint: "just the API and the admin";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "templates";
     readonly label: "Django templates";
     readonly hint: "no Node, Django renders the site";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "nuxt";
     readonly label: "Nuxt";
@@ -86,7 +88,7 @@ export declare const STACK_OPTIONS: readonly [{
     readonly value: "latest";
     readonly label: "Latest";
     readonly hint: "Postgres 18";
-    readonly generated: false;
+    readonly generated: true;
   }];
 }, {
   readonly key: "analytics";
@@ -174,7 +176,7 @@ export declare const STACK_OPTIONS: readonly [{
     readonly value: "on";
     readonly label: "On";
     readonly hint: "proof of work, no tracking";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "off";
     readonly label: "Off";
@@ -206,7 +208,8 @@ export declare const STACK_OPTIONS: readonly [{
   readonly values: readonly [{
     readonly value: "pnpm";
     readonly label: "pnpm";
-    readonly generated: false;
+    readonly hint: "with a day's delay on new releases";
+    readonly generated: true;
   }, {
     readonly value: "npm";
     readonly label: "npm";
@@ -214,7 +217,8 @@ export declare const STACK_OPTIONS: readonly [{
   }, {
     readonly value: "bun";
     readonly label: "Bun";
-    readonly generated: false;
+    readonly hint: "for installs; the frontend runs on Node.js";
+    readonly generated: true;
   }];
 }, {
   readonly key: "media";
@@ -247,8 +251,8 @@ export declare const STACK_OPTIONS: readonly [{
   }, {
     readonly value: "sentry";
     readonly label: "Sentry";
-    readonly hint: "or GlitchTip, with SENTRY_DSN";
-    readonly generated: false;
+    readonly hint: "sentry.io, with SENTRY_DSN";
+    readonly generated: true;
   }, {
     readonly value: "off";
     readonly label: "Off";
@@ -288,14 +292,23 @@ interface ScaffoldOptions {
   frontend: Frontend;
   /** Demo pages and posts on the first start. */
   demoContent: boolean;
-  /** An external Postgres URL; the bundled Postgres when not set. */
+  /**
+   * An external Postgres URL for production, saved as PRODUCTION_DATABASE_URL;
+   * development runs the bundled Postgres either way.
+   */
   databaseUrl?: string;
+  /** The bundled Postgres's version, and the backend's Postgres client; stable by default. */
+  postgres?: Stack["postgres"];
   /** Store uploads in the local S3 service in development, like S3 in production. */
   localS3?: boolean;
   /** Page analytics with the bundled Umami (the `analytics` profile). */
   analytics?: boolean;
   /** Content Studio's notifications app; on by default. */
   notifications?: boolean;
+  /** The captcha of the contact form; on by default. */
+  captcha?: boolean;
+  /** The frontend's package manager; pnpm by default. */
+  packageManager?: PackageManager;
   /** How errors are reported in production; by email by default. */
   errors?: Stack["errors"];
   /** The cache backend; the database by default. */
@@ -313,6 +326,8 @@ interface ScaffoldOptions {
   /** Where the templates are; the ones in the package by default. */
   templatesDir?: string;
 }
+/** A package manager of the frontend. */
+type PackageManager = Stack["packageManager"];
 interface ScaffoldResult {
   directory: string;
   adminUsername: string;

package/dist/index.js

@@ -1 +1 @@
-export { F as DEFAULT_STACK, i as FRONTENDS, I as NAMED_PRESETS, R as STACK_OPTIONS, y as VERSION, o as cacheEnv, B as decodePreset, V as encodePreset, x as generateProjectSecrets, S as generateSecret, l as normalizeDatabaseUrl, tt as parseEnv, H as pendingChoices, n as productionEnv, U as resolvePreset, X as runDoctor, d as scaffold, rt as setEnvValues, f as setNotificationsApp, m as toProjectName, g as usesValkey, r as validateDomain, _ as validateProjectName } from "./production-M2SsuuBb.js";
+export { z as DEFAULT_STACK, i as FRONTENDS, B as NAMED_PRESETS, U as STACK_OPTIONS, S as VERSION, o as cacheEnv, G as decodePreset, K as encodePreset, w as generateProjectSecrets, T as generateSecret, d as normalizeDatabaseUrl, ot as parseEnv, q as pendingChoices, n as productionEnv, J as resolvePreset, tt as runDoctor, p as scaffold, ct as setEnvValues, m as setNotificationsApp, g as toProjectName, y as usesValkey, r as validateDomain, b as validateProjectName } from "./production-WThC1aS2.js";