@django-stack/cli 0.10.0 → 0.12.0

package/README.md

@@ -1,6 +1,6 @@
 # @django-stack/cli
 
-The production-ready Django, batteries included stack. Create and manage DjangoStack projects: a Django backend, a frontend, Postgres and Docker Compose in one command.
+The production-ready batteries included Django stack. Create and manage DjangoStack projects: a Django backend, a frontend, Postgres and Docker Compose in one command.
 
 ```bash
 npx @django-stack/cli init my-site
@@ -27,7 +27,7 @@ Run `dstack help <command>` for the options of a command. Each command
 checks for a newer version once a day; turn that off with
 `--no-update-check` or `DJANGO_STACK_NO_UPDATE_CHECK=1`.
 
-Read the [documentation](https://github.com/dwarsbit/django-stack/tree/main/website/docs) of
+Read the [documentation](https://djangostack.org/) of
 [DjangoStack](https://github.com/dwarsbit/django-stack).
 
 ## License

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-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-Ct_qoeXk.js";
+import { $ as describeMove, A as activeProject, B as DEFAULT_STACK, C as CLI_VERSION, D as CAPTCHA_APP, E as generateSecret, F as projectStack, G as applies, H as NODE_FRONTENDS, I as projectUrls, J as pendingChoices, L as readLocalRun, M as composeOutput, N as findProjectDirectory, O as RUN_DOMAIN, P as parseProfiles, Q as chooseFreePorts, R as readProject, S as validateTimeZone, T as generateProjectSecrets, U as PROMPT_ORDER, V as NAMED_PRESETS, W as STACK_OPTIONS, X as stackOption, Y as resolvePreset, Z as DEV_PORTS, _ as toProjectName, at as dockerRunning, b as usesValkey, c as frontendPackageManager, ct as quoteEnvValue, d as lockFrontend, et as envPorts, f as normalizeDatabaseUrl, g as timeZones, h as setNotificationsApp, i as validateDomain, it as dockerNotRunning, j as compose, k as RUN_ENV, l as localS3, lt as setEnvValues, m as scaffold, n as postgresUrl, nt as runDoctor, o as LOCAL_S3, ot as isDockerDown, p as relativeDirectory, q as encodePreset, r as productionEnv$1, rt as checkTools, s as cacheEnv, st as parseEnv, t as missingS3, tt as portValues, u as lockBackend, v as umamiEnv, w as PACKAGE_NAME, x as validateProjectName, y as updateFrontendLock, z as runningServices } from "./production-1O8-1QUl.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";
@@ -3929,10 +3929,9 @@ 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.
+* and the defaults.
 */
-async function chooseStack(options, interactive, askDatabase) {
+async function chooseStack(options, interactive) {
 	let preset;
 	if (options.preset) try {
 		preset = resolvePreset(options.preset);
@@ -3940,18 +3939,12 @@ async function chooseStack(options, interactive, askDatabase) {
 		fail(error.message);
 	}
 	const stack = { ...DEFAULT_STACK };
-	let databaseUrl;
 	for (const key of PROMPT_ORDER) {
 		const option = stackOption(key);
 		if (options.fromCli(key)) stack[key] = options[key];
 		else if (key === "storage" && options.fromCli("localS3") && options.localS3) stack[key] = "s3";
 		else if (preset) stack[key] = preset[key];
 		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 {
 			const initialValue = key === "storage" && stack.media === "s3" ? "s3" : stack[key];
 			stack[key] = unwrap(await p.select({
@@ -3961,10 +3954,7 @@ async function chooseStack(options, interactive, askDatabase) {
 			}));
 		}
 	}
-	return {
-		stack,
-		databaseUrl
-	};
+	return stack;
 }
 function systemTimeZone() {
 	try {
@@ -4009,28 +3999,11 @@ async function init(directoryArgument, options) {
 			validate: (value) => validateProjectName(value ?? "")
 		}));
 	}
-	const chosen = await chooseStack(options, interactive, async (initial) => {
-		const choice = unwrap(await p.select({
-			message: "Database",
-			initialValue: initial,
-			options: [...choices("postgres").map((value) => ({
-				...value,
-				label: `Bundled Postgres, ${value.label.toLowerCase()}`
-			})), {
-				value: "external",
-				label: "External Postgres",
-				hint: "a URL to your own server"
-			}]
-		}));
-		if (choice !== "external") return { postgres: choice };
-		return { databaseUrl: unwrap(await p.text({
-			message: "Postgres URL",
-			placeholder: "postgres://user:password@host:5432/name",
-			validate: (value) => value?.startsWith("postgres") ? void 0 : "Enter a postgres:// URL."
-		})) };
-	});
-	const stack = chosen.stack;
-	const databaseUrl = options.databaseUrl ?? chosen.databaseUrl;
+	const stack = await chooseStack(options, interactive);
+	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.`);
@@ -4065,7 +4038,8 @@ async function init(directoryArgument, options) {
 			name,
 			frontend: stack.frontend,
 			demoContent,
-			databaseUrl,
+			databaseUrl: options.databaseUrl,
+			postgres: stack.postgres,
 			localS3: stack.storage === "s3",
 			analytics: stack.analytics === "umami",
 			cache: stack.cache,
@@ -4127,7 +4101,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}`)}`,
 		"",
@@ -4166,7 +4140,7 @@ async function preset(code, options) {
 		p.outro(`Use it with ${command(`${selfCommand()} init --preset ${code in NAMED_PRESETS ? code : encodePreset(stack)}`)}`);
 		return;
 	}
-	const { stack } = await chooseStack(options, isInteractive(options.yes));
+	const stack = await chooseStack(options, isInteractive(options.yes));
 	const encoded = encodePreset(stack);
 	p.outro(`Create this stack with ${command(`${selfCommand()} init --preset ${encoded}`)}`);
 }
@@ -4185,7 +4159,7 @@ function validateUrl(value) {
 	if (!value) return void 0;
 	return /^https?:\/\/[^\s/]+/.test(value) ? void 0 : "Enter a URL that starts with https://.";
 }
-const required = (label) => (value) => value.trim() ? void 0 : `Enter the ${label}.`;
+const required$1 = (label) => (value) => value.trim() ? void 0 : `Enter the ${label}.`;
 /**
 * An SMTP URL for EMAIL_URL: smtps:// on port 465, smtp:// on 25, otherwise
 * smtp+tls:// (STARTTLS), with the user name and password URL-encoded.
@@ -4281,7 +4255,7 @@ const SETTING_GROUPS = [
 				name: "S3_BUCKET",
 				message: "S3 bucket",
 				placeholder: "example-media",
-				validate: required("bucket")
+				validate: required$1("bucket")
 			},
 			{
 				name: "S3_ENDPOINT_URL",
@@ -4294,18 +4268,18 @@ const SETTING_GROUPS = [
 				name: "S3_REGION",
 				message: "S3 region",
 				placeholder: "eu-central-1",
-				validate: required("region")
+				validate: required$1("region")
 			},
 			{
 				name: "S3_ACCESS_KEY_ID",
 				message: "S3 access key ID",
-				validate: required("access key ID")
+				validate: required$1("access key ID")
 			},
 			{
 				name: "S3_SECRET_ACCESS_KEY",
 				message: "S3 secret access key",
 				secret: true,
-				validate: required("secret access key")
+				validate: required$1("secret access key")
 			},
 			{
 				name: "S3_PUBLIC_URL",
@@ -4460,6 +4434,86 @@ async function settings(options) {
 	else p.outro(pc.green("Done"));
 }
 // src/commands/production.ts
+const required = (label) => (value) => value?.trim() ? void 0 : `Enter the ${label}.`;
+/**
+* Asks for the server's database: the bundled Postgres, or your own as a URL
+* or as separate values. Returns the URL of your own, or undefined.
+*/
+async function askDatabase() {
+	if (unwrap(await p.select({
+		message: "Database on the server",
+		initialValue: "bundled",
+		options: [{
+			value: "bundled",
+			label: "Bundled Postgres",
+			hint: "a container next to the backend"
+		}, {
+			value: "external",
+			label: "Your own Postgres",
+			hint: "a managed database or another server"
+		}]
+	})) === "bundled") return void 0;
+	if (unwrap(await p.select({
+		message: "How do you want to enter it?",
+		initialValue: "parts",
+		options: [{
+			value: "parts",
+			label: "Host, port, name, user and password",
+			hint: "any password works"
+		}, {
+			value: "url",
+			label: "A postgres:// URL",
+			hint: "special characters in the password URL-encoded"
+		}]
+	})) === "url") {
+		const value = unwrap(await p.text({
+			message: "Postgres URL",
+			placeholder: "postgres://user:password@db.example.com:5432/app",
+			validate: (value) => {
+				try {
+					normalizeDatabaseUrl((value ?? "").trim());
+					return;
+				} catch (error) {
+					return error.message;
+				}
+			}
+		}));
+		return normalizeDatabaseUrl(value.trim());
+	}
+	const host = unwrap(await p.text({
+		message: "Host",
+		placeholder: "db.example.com",
+		validate: required("host")
+	}));
+	const port = unwrap(await p.text({
+		message: "Port",
+		placeholder: "5432",
+		defaultValue: "5432",
+		validate: (value) => {
+			if (!value) return void 0;
+			const port = Number(value);
+			return Number.isInteger(port) && port > 0 && port < 65536 ? void 0 : "Enter a port, such as 5432.";
+		}
+	}));
+	const name = unwrap(await p.text({
+		message: "Database name",
+		placeholder: "app",
+		validate: required("name")
+	}));
+	const user = unwrap(await p.text({
+		message: "User",
+		placeholder: "app",
+		validate: required("user")
+	}));
+	const password = unwrap(await p.password({ message: "Password" }));
+	return postgresUrl({
+		host: host.trim(),
+		port: port.trim(),
+		name: name.trim(),
+		user: user.trim(),
+		password
+	});
+}
 async function production(directoryArgument, options) {
 	const interactive = isInteractive(options.yes);
 	const directory = resolve(directoryArgument ?? ".");
@@ -4477,12 +4531,21 @@ async function production(directoryArgument, options) {
 			validate: (v) => validateDomain(v ?? "")
 		}));
 	}
+	const devEnv = readFileSync(envPath, "utf8");
+	let databaseUrl = options.databaseUrl;
+	if (databaseUrl) try {
+		normalizeDatabaseUrl(databaseUrl);
+	} catch (error) {
+		fail(error.message);
+	}
+	else if (interactive && !parseEnv(devEnv).PRODUCTION_DATABASE_URL) databaseUrl = await askDatabase();
 	const context = projectContext(directory);
 	let result;
 	try {
-		result = productionEnv$1(readFileSync(envPath, "utf8"), {
+		result = productionEnv$1(devEnv, {
 			domain,
 			emailUrl: options.emailUrl,
+			databaseUrl,
 			media: context.media
 		});
 	} catch (error) {
@@ -4541,6 +4604,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.");
@@ -4639,7 +4703,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.`);
@@ -4695,7 +4760,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. */
@@ -4844,6 +4910,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",
@@ -4931,7 +5001,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) {
@@ -5029,8 +5099,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",
@@ -5313,7 +5383,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"
@@ -5359,7 +5429,7 @@ function createProgram() {
 		fromCli: (option) => cmd.getOptionValueSource(option) === "cli"
 	}));
 	for (const flag of stackFlags()) presetCommand.addOption(flag);
-	program.command("production").description("Write .env.production for a server").argument("[directory]", "The project directory", ".").option("--domain <domain>", "The domain of the site, such as example.com").option("--email-url <url>", "The SMTP server, such as smtp+tls://user:pass@host:587").option("--force", "Overwrite an existing .env.production").option("-y, --yes", "Don't ask; fail when --domain is missing").action(production);
+	program.command("production").description("Write .env.production for a server").argument("[directory]", "The project directory", ".").option("--domain <domain>", "The domain of the site, such as example.com").option("--email-url <url>", "The SMTP server, such as smtp+tls://user:pass@host:587").option("--database-url <url>", "Your own Postgres for the server instead of the bundled one").option("--force", "Overwrite an existing .env.production").option("-y, --yes", "Don't ask; fail when --domain is missing").action(production);
 	program.command("settings").description("Ask for the missing production settings and credentials, and save them").addOption(dirOption()).option("--file <file>", "The file to change (default: .env.production, or .env on a server)").option("--set <NAME=value>", "Set a value without asking, such as --set ADMIN_EMAIL=you@example.com", (value, previous = []) => [...previous, value]).option("--all", "Ask for every setting, also the ones that are set").option("-y, --yes", "Don't ask; fail when a setting is still missing").action(settings);
 	program.command("doctor").description("Check a project and its services").argument("[directory]", "The project directory", ".").action(doctor);
 	program.command("self-update").description(`Update ${BIN} to the latest version on npm`).action(selfUpdate);

package/dist/index.d.ts

@@ -20,6 +20,10 @@ 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;
+  /** An external Postgres for the server; it takes the place of PRODUCTION_DATABASE_URL. */
+  databaseUrl?: string;
 }
 interface ProductionEnv {
   text: string;
@@ -54,12 +58,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 +90,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";
@@ -290,8 +294,13 @@ 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). */

package/dist/index.js

@@ -1 +1 @@
-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-Ct_qoeXk.js";
+export { B as DEFAULT_STACK, a as FRONTENDS, V as NAMED_PRESETS, W as STACK_OPTIONS, C as VERSION, s as cacheEnv, K as decodePreset, q as encodePreset, T as generateProjectSecrets, E as generateSecret, f as normalizeDatabaseUrl, st as parseEnv, J as pendingChoices, r as productionEnv, Y as resolvePreset, nt as runDoctor, m as scaffold, lt as setEnvValues, h as setNotificationsApp, _ as toProjectName, b as usesValkey, i as validateDomain, x as validateProjectName } from "./production-1O8-1QUl.js";