@django-stack/cli 0.0.1 → 0.1.0

package/dist/index.d.ts

@@ -1,2 +1,251 @@
+interface Check {
+  name: string;
+  ok: boolean;
+  /** Not a failure: the check could not run or only warns. */
+  warning?: boolean;
+  detail?: string;
+}
+/** Checks a project directory: tools, .env, and the running services. */
+export declare function runDoctor(directory: string): Promise<Check[]>;
+/** Reads a .env file: KEY=value lines, comments and blank lines ignored. */
+export declare function parseEnv(text: string): Record<string, string>;
+/** Sets KEY=value lines in .env text, replacing existing ones and appending new ones. */
+export declare function setEnvValues(text: string, values: Record<string, string>): string;
+interface ProductionOptions {
+  /** The domain the site runs on, such as example.com. */
+  domain: string;
+  /** The SMTP server for outgoing mail. */
+  emailUrl?: string;
+}
+interface ProductionEnv {
+  text: string;
+  adminPassword: string;
+  /** Things to finish by hand before the first deploy. */
+  todo: string[];
+}
+export declare function validateDomain(domain: string): string | undefined;
+/**
+ * The .env for a server, from a project's development .env: the prod
+ * profile, HTTPS on the domain, and fresh secrets, so nothing from the
+ * laptop works on the server.
+ */
+export declare function productionEnv(devEnv: string, options: ProductionOptions): ProductionEnv;
+export declare const FRONTENDS: readonly ["astro"];
+type Frontend = (typeof FRONTENDS)[number];
+interface ScaffoldOptions {
+  /** The directory to create the project in. */
+  directory: string;
+  /** The project name: lowercase letters, digits and dashes. */
+  name: string;
+  frontend: Frontend;
+  /** Demo pages and posts on the first start. */
+  demoContent: boolean;
+  /** An external Postgres URL; the bundled Postgres when not set. */
+  databaseUrl?: string;
+  /** Store uploads in the local S3 service in development, like S3 in production. */
+  localS3?: boolean;
+  /** A DjangoStack monorepo to take the packages from instead of the registries (for development). */
+  link?: string;
+  /** The time zone of the backend, such as Europe/Amsterdam. UTC by default. */
+  timeZone?: string;
+  /** The preset code of the stack, saved in package.json for `config`. */
+  preset?: string;
+  /** Where the templates are; the ones in the package by default. */
+  templatesDir?: string;
+}
+interface ScaffoldResult {
+  directory: string;
+  adminUsername: string;
+  adminPassword: string;
+  files: number;
+}
+/** A valid project name from a directory name: `My Site` becomes `my-site`. */
+export declare function toProjectName(value: string): string;
+export declare function validateProjectName(value: string): string | undefined;
+/** Postgres URLs for hosts other than this machine must use TLS. */
+export declare function normalizeDatabaseUrl(url: string): string;
+export declare function scaffold(options: ScaffoldOptions): ScaffoldResult;
+/** A URL-safe random secret with `bytes` bytes of randomness. */
+export declare function generateSecret(bytes?: number): string;
+/** The secrets a project's .env needs, by the name used in `{{secret:<name>}}`. */
+export declare function generateProjectSecrets(): Record<string, string>;
+export declare const STACK_OPTIONS: readonly [{
+  readonly key: "frontend";
+  readonly flag: "--frontend";
+  readonly message: "Frontend";
+  readonly description: "The frontend framework";
+  readonly values: readonly [{
+    readonly value: "astro";
+    readonly label: "Astro";
+    readonly hint: "server-rendered, fast by default";
+    readonly generated: true;
+  }, {
+    readonly value: "next";
+    readonly label: "Next.js";
+    readonly hint: "React, server components";
+    readonly generated: false;
+  }, {
+    readonly value: "headless";
+    readonly label: "Headless";
+    readonly hint: "just the API and the admin";
+    readonly generated: false;
+  }, {
+    readonly value: "templates";
+    readonly label: "Django templates";
+    readonly hint: "no Node, Django renders the site";
+    readonly generated: false;
+  }];
+}, {
+  readonly key: "postgres";
+  readonly flag: "--postgres";
+  readonly message: "Postgres version";
+  readonly description: "The bundled Postgres version";
+  readonly values: readonly [{
+    readonly value: "stable";
+    readonly label: "Stable";
+    readonly hint: "Postgres 17";
+    readonly generated: true;
+  }, {
+    readonly value: "latest";
+    readonly label: "Latest";
+    readonly hint: "Postgres 18";
+    readonly generated: false;
+  }];
+}, {
+  readonly key: "analytics";
+  readonly flag: "--analytics";
+  readonly message: "Analytics";
+  readonly description: "Page analytics";
+  readonly values: readonly [{
+    readonly value: "umami";
+    readonly label: "Umami";
+    readonly hint: "built in, private, no cookies";
+    readonly generated: false;
+  }, {
+    readonly value: "off";
+    readonly label: "Off";
+    readonly generated: true;
+  }];
+}, {
+  readonly key: "tasks";
+  readonly flag: "--tasks";
+  readonly message: "Background tasks";
+  readonly description: "The task queue";
+  readonly values: readonly [{
+    readonly value: "huey";
+    readonly label: "Huey";
+    readonly hint: "a worker container with Valkey";
+    readonly generated: true;
+  }, {
+    readonly value: "off";
+    readonly label: "Off";
+    readonly generated: false;
+  }];
+}, {
+  readonly key: "cache";
+  readonly flag: "--cache";
+  readonly message: "Cache";
+  readonly description: "The cache backend";
+  readonly values: readonly [{
+    readonly value: "database";
+    readonly label: "Database";
+    readonly hint: "a Postgres table, nothing extra to run";
+    readonly generated: false;
+  }, {
+    readonly value: "valkey";
+    readonly label: "Valkey";
+    readonly hint: "in memory, Redis-compatible";
+    readonly generated: false;
+  }, {
+    readonly value: "off";
+    readonly label: "Off";
+    readonly generated: false;
+  }];
+}, {
+  readonly key: "notifications";
+  readonly flag: "--notifications";
+  readonly message: "Notifications";
+  readonly description: "Notifications in the admin and by email";
+  readonly values: readonly [{
+    readonly value: "on";
+    readonly label: "On";
+    readonly hint: "in the admin and by email";
+    readonly generated: false;
+  }, {
+    readonly value: "off";
+    readonly label: "Off";
+    readonly generated: true;
+  }];
+}, {
+  readonly key: "captcha";
+  readonly flag: "--captcha";
+  readonly message: "Captcha";
+  readonly description: "The built-in captcha for forms";
+  readonly values: readonly [{
+    readonly value: "on";
+    readonly label: "On";
+    readonly hint: "proof of work, no tracking";
+    readonly generated: false;
+  }, {
+    readonly value: "off";
+    readonly label: "Off";
+    readonly generated: true;
+  }];
+}, {
+  readonly key: "storage";
+  readonly flag: "--storage";
+  readonly message: "Uploads in development";
+  readonly description: "Where uploads go in development";
+  readonly values: readonly [{
+    readonly value: "local";
+    readonly label: "Local files";
+    readonly hint: "a Docker volume";
+    readonly generated: true;
+  }, {
+    readonly value: "s3";
+    readonly label: "Local S3";
+    readonly hint: "the same code path as S3 in production";
+    readonly generated: true;
+  }];
+}, {
+  readonly key: "packageManager";
+  readonly flag: "--package-manager";
+  readonly message: "Package manager";
+  readonly description: "The frontend's package manager";
+  readonly values: readonly [{
+    readonly value: "pnpm";
+    readonly label: "pnpm";
+    readonly generated: false;
+  }, {
+    readonly value: "npm";
+    readonly label: "npm";
+    readonly generated: true;
+  }, {
+    readonly value: "bun";
+    readonly label: "Bun";
+    readonly generated: false;
+  }];
+}];
+type Options = (typeof STACK_OPTIONS)[number];
+type StackKey = Options["key"];
+type Stack = { [O in Options as O["key"]]: O["values"][number]["value"]; };
+export declare const DEFAULT_STACK: Stack;
+/** A preset code for a stack: the version, then one character per option, trailing defaults left out. */
+export declare function encodePreset(stack: Stack): string;
+/** The stack of a preset code. Throws with a one-line reason for a bad code. */
+export declare function decodePreset(code: string): Stack;
+export declare const NAMED_PRESETS: Record<string, {
+  description: string;
+  stack: Partial<Stack>;
+}>;
+/** The stack of a preset name or code. */
+export declare function resolvePreset(input: string): Stack;
+/** The choices this CLI version does not generate yet, as `--flag value`. */
+export declare function pendingChoices(stack: Stack): {
+  key: StackKey;
+  choice: string;
+  isDefault: boolean;
+}[];
 /** The version of this package, the same for every @django-stack package. */
-export declare const VERSION = "0.0.1";
+declare const CLI_VERSION: string;
+export { type Check, type Frontend, type ProductionEnv, type ProductionOptions, type ScaffoldOptions, type ScaffoldResult, type Stack, CLI_VERSION as VERSION };

package/dist/index.js

@@ -1,4 +1 @@
-// src/index.ts
-/** The version of this package, the same for every @django-stack package. */
-const VERSION = "0.0.1";
-export { VERSION };
+export { t as DEFAULT_STACK, u as FRONTENDS, n as NAMED_PRESETS, r as STACK_OPTIONS, b as VERSION, a as decodePreset, o as encodePreset, C as generateProjectSecrets, w as generateSecret, p as normalizeDatabaseUrl, E as parseEnv, s as pendingChoices, x as productionEnv, c as resolvePreset, T as runDoctor, h as scaffold, D as setEnvValues, _ as toProjectName, S as validateDomain, v as validateProjectName } from "./stack-OTrWHXrO.js";