create-wakii-stack 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# create-wakii-stack
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Scaffold the **full Wakii architecture** (FE + BE + infra) as a pruned monorepo snapshot — CRA-style CLI: interactive multiselect, non-interactive flags. Strategy **Hybrid C**: copy the full template, then **prune against a manifest** (delete paths, cut compose blocks, clean `depends_on`, filter gateway conf/env keys) — no template engine, original content untouched.
+
+> **Not on npm yet — publishing soon.** The CLI ships in this repository today.
+
+## Usage
+
+```bash
+pnpm create wakii-stack my-stack                      # interactive (multiselect services)
+pnpm create wakii-stack my-stack --all --yes          # every service, skip the confirm
+pnpm create wakii-stack stacks/billing --services node-svc,shell,tasks --skip-install
+```
+
+Interactive flow — pick services from the manifest (**11**: `postgres · kafka · auth-svc · gateway · node-svc · spring-svc · go-svc · shell · remote-tasks · remote-activity · admin`, each labeled with its layer), confirm the summary, watch the scaffold spinner, then follow the generated next steps:
+
+```
+cd my-stack
+cp platform/.env.example platform/.env   # fill in secrets before up
+docker compose --env-file platform/.env up -d
+
+URLs: gateway http://localhost:8080 · shell http://localhost:3000 (if you picked FE)
+```
+
+## Flags
+
+| Flag | Meaning | Default |
+|---|---|---|
+| `[stackName]` (positional) | A name **or a path** — the package/stack name is always the **basename** | prompt (`my-wakii-stack`) |
+| `--services <list>` | comma-separated service ids (also accepts `--services=a,b`); unknown ids are rejected with the valid list | prompt multiselect |
+| `--all` | select every service in the manifest | — |
+| `--yes` | skip the confirm summary | — |
+| `--skip-install` | omit the per-app `pnpm install` hint | — |
+| `-h`, `--help` | print usage | — |
+
+An **empty selection** (no `--all`, no `--services`, or an empty list) is an error — pick at least one service. The destination directory must not already exist non-empty.
+
+## Tier rules (applied automatically from the manifest)
+
+- **≥ 1 BE service** → automatically pulls `postgres` + `kafka` + `gateway` + `auth-svc`.
+- **≥ 1 FE service** → automatically pulls `gateway`.
+- **Per-service requires** close transitively — e.g. picking `shell` pulls `gateway` + `remote-tasks` + `remote-activity`.
+
+## What you get
+
+A monorepo snapshot pruned according to `stack-manifest.json`:
+
+- `platform/docker-compose.yml` stays **YAML-valid** — unselected service blocks removed, `depends_on` references cleaned, pgdata volume dropped with a warning comment.
+- `platform/gateway/nginx/nginx.conf` — only the routes of your services (brace-count pruning between markers).
+- `platform/.env.example` — keys filtered per service (+ shared keys like `JWT_SECRET`).
+- A generated **README** with the up command and ports (`gateway :8080`, `shell :3000`).
+- Placeholders `__STACK_NAME__` / `__STACK_ORG__` rendered into package.json `name`, the compose project `name:`, the README H1, and docs org — **service names inside `services/` are never rewritten** so the stack runs as-is.
+- FE-only SPA outside a stack? Use [`create-wakii-app`](https://www.npmjs.com/package/create-wakii-app) instead.
+
+## Architecture (repo)
+
+- `src/manifest.ts` — loads + validates `stack-manifest.json` (schema documented as JSDoc in-file: services/layer/paths/envKeys/gatewayBlocks + files + ports + smoke). **Contract with worker-compose** — the engine only knows the schema, never hardcodes a service.
+- `src/options.ts` — flag parsing + tier-1 rules
+- `src/scaffold.ts` — full copy → renders `__STACK_NAME__`/`__STACK_ORG__` (binaries skipped) → prunes paths/compose (text indentation-based: 2-space blocks, 6-space `depends_on` entries + reference cleanup + pgdata removal + warning comment) / gateway conf (brace-count between markers) / env keys → generates the README
+- `src/index.ts` — the `@clack/prompts` flow
+
+## Development
+
+```bash
+pnpm --filter create-wakii-stack typecheck
+pnpm --filter create-wakii-stack test   # 3-service fixture template in tmp — no network
+```

package/dist/chunk-7XGW4UJ5.js

@@ -0,0 +1,75 @@
+// src/manifest.ts
+import { readFileSync } from "fs";
+var STACK_LAYERS = ["core", "infra", "be", "fe"];
+function loadManifest(path) {
+  let raw;
+  try {
+    raw = JSON.parse(readFileSync(path, "utf8"));
+  } catch (err) {
+    throw new Error(`stack-manifest.json kh\xF4ng \u0111\u1ECDc/parse \u0111\u01B0\u1EE3c t\u1EA1i ${path}: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  return validateManifest(raw, path);
+}
+function validateManifest(raw, source = "manifest") {
+  if (typeof raw !== "object" || raw === null) throw new Error(`${source}: manifest ph\u1EA3i l\xE0 object`);
+  const m = raw;
+  if (m.version !== 1) throw new Error(`${source}: version ph\u1EA3i l\xE0 1`);
+  const services = {};
+  const rawServices = m.services;
+  if (Array.isArray(rawServices)) {
+    for (const item of rawServices) {
+      if (typeof item !== "object" || item === null) throw new Error(`${source}: services[] item ph\u1EA3i l\xE0 object`);
+      const e = item;
+      const name = typeof e.id === "string" ? e.id : void 0;
+      const layer = e.type ?? e.layer;
+      if (!name) throw new Error(`${source}: services[].id b\u1EAFt bu\u1ED9c`);
+      if (typeof layer !== "string" || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name} layer (type) ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = {
+        layer,
+        ...Array.isArray(e.paths) ? { paths: e.paths } : {},
+        ...Array.isArray(e.envKeys) ? { envKeys: e.envKeys } : {},
+        ...Array.isArray(e.gatewayBlocks) ? { gatewayBlocks: e.gatewayBlocks } : {}
+      };
+    }
+  } else if (typeof rawServices === "object" && rawServices !== null) {
+    for (const [name, meta] of Object.entries(rawServices)) {
+      if (typeof meta !== "object" || meta === null) throw new Error(`${source}: services.${name} ph\u1EA3i l\xE0 object`);
+      const layer = meta.layer;
+      if (!layer || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name}.layer ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = meta;
+    }
+  } else {
+    throw new Error(`${source}: services ph\u1EA3i l\xE0 object KH\xD4NG r\u1ED7ng ho\u1EB7c array`);
+  }
+  if (Object.keys(services).length === 0) throw new Error(`${source}: services kh\xF4ng \u0111\u01B0\u1EE3c r\u1ED7ng`);
+  const filesRaw = typeof m.files === "object" && m.files !== null ? m.files : {};
+  if (filesRaw.compose !== void 0 && typeof filesRaw.compose !== "string") {
+    throw new Error(`${source}: files.compose ph\u1EA3i l\xE0 string`);
+  }
+  if (filesRaw.env !== void 0 && typeof filesRaw.env !== "string") throw new Error(`${source}: files.env ph\u1EA3i l\xE0 string`);
+  if (filesRaw.gatewayConf !== void 0 && typeof filesConfRaw(filesRaw) !== "string") {
+    throw new Error(`${source}: files.gatewayConf ph\u1EA3i l\xE0 string`);
+  }
+  const files = {
+    compose: filesRaw.compose ?? "platform/docker-compose.yml",
+    env: filesRaw.env ?? "platform/.env.example",
+    gatewayConf: filesRaw.gatewayConf ?? "platform/gateway/nginx/nginx.conf"
+  };
+  const manifest = { version: 1, services, files };
+  if (typeof m.ports === "object" && m.ports !== null) manifest.ports = m.ports;
+  if (typeof m.smoke === "string") manifest.smoke = m.smoke;
+  return manifest;
+}
+function filesConfRaw(files) {
+  return files.gatewayConf;
+}
+
+export {
+  STACK_LAYERS,
+  loadManifest,
+  validateManifest
+};

package/dist/chunk-AKPWS7FJ.js

@@ -0,0 +1,76 @@
+// src/manifest.ts
+import { readFileSync } from "fs";
+var STACK_LAYERS = ["core", "infra", "be", "fe"];
+function loadManifest(path) {
+  let raw;
+  try {
+    raw = JSON.parse(readFileSync(path, "utf8"));
+  } catch (err) {
+    throw new Error(`stack-manifest.json kh\xF4ng \u0111\u1ECDc/parse \u0111\u01B0\u1EE3c t\u1EA1i ${path}: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  return validateManifest(raw, path);
+}
+function validateManifest(raw, source = "manifest") {
+  if (typeof raw !== "object" || raw === null) throw new Error(`${source}: manifest ph\u1EA3i l\xE0 object`);
+  const m = raw;
+  if (m.version !== 1) throw new Error(`${source}: version ph\u1EA3i l\xE0 1`);
+  const services = {};
+  const rawServices = m.services;
+  if (Array.isArray(rawServices)) {
+    for (const item of rawServices) {
+      if (typeof item !== "object" || item === null) throw new Error(`${source}: services[] item ph\u1EA3i l\xE0 object`);
+      const e = item;
+      const name = typeof e.id === "string" ? e.id : void 0;
+      const rawLayer = e.type ?? e.layer;
+      const layer = rawLayer === "fe-no-compose" ? "fe" : rawLayer;
+      if (!name) throw new Error(`${source}: services[].id b\u1EAFt bu\u1ED9c`);
+      if (typeof layer !== "string" || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name} layer (type) ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = {
+        layer,
+        ...Array.isArray(e.paths) ? { paths: e.paths } : {},
+        ...Array.isArray(e.envKeys) ? { envKeys: e.envKeys } : {},
+        ...Array.isArray(e.gatewayBlocks) ? { gatewayBlocks: e.gatewayBlocks } : {}
+      };
+    }
+  } else if (typeof rawServices === "object" && rawServices !== null) {
+    for (const [name, meta] of Object.entries(rawServices)) {
+      if (typeof meta !== "object" || meta === null) throw new Error(`${source}: services.${name} ph\u1EA3i l\xE0 object`);
+      const layer = meta.layer;
+      if (!layer || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name}.layer ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = meta;
+    }
+  } else {
+    throw new Error(`${source}: services ph\u1EA3i l\xE0 object KH\xD4NG r\u1ED7ng ho\u1EB7c array`);
+  }
+  if (Object.keys(services).length === 0) throw new Error(`${source}: services kh\xF4ng \u0111\u01B0\u1EE3c r\u1ED7ng`);
+  const filesRaw = typeof m.files === "object" && m.files !== null ? m.files : {};
+  if (filesRaw.compose !== void 0 && typeof filesRaw.compose !== "string") {
+    throw new Error(`${source}: files.compose ph\u1EA3i l\xE0 string`);
+  }
+  if (filesRaw.env !== void 0 && typeof filesRaw.env !== "string") throw new Error(`${source}: files.env ph\u1EA3i l\xE0 string`);
+  if (filesRaw.gatewayConf !== void 0 && typeof filesConfRaw(filesRaw) !== "string") {
+    throw new Error(`${source}: files.gatewayConf ph\u1EA3i l\xE0 string`);
+  }
+  const files = {
+    compose: filesRaw.compose ?? "platform/docker-compose.yml",
+    env: filesRaw.env ?? "platform/.env.example",
+    gatewayConf: filesRaw.gatewayConf ?? "platform/gateway/nginx/nginx.conf"
+  };
+  const manifest = { version: 1, services, files };
+  if (typeof m.ports === "object" && m.ports !== null) manifest.ports = m.ports;
+  if (typeof m.smoke === "string") manifest.smoke = m.smoke;
+  return manifest;
+}
+function filesConfRaw(files) {
+  return files.gatewayConf;
+}
+
+export {
+  STACK_LAYERS,
+  loadManifest,
+  validateManifest
+};

package/dist/chunk-ELM6GGC5.js

@@ -0,0 +1,50 @@
+// src/manifest.ts
+import { readFileSync } from "fs";
+var STACK_LAYERS = ["core", "infra", "be", "fe"];
+function loadManifest(path) {
+  let raw;
+  try {
+    raw = JSON.parse(readFileSync(path, "utf8"));
+  } catch (err) {
+    throw new Error(`stack-manifest.json kh\xF4ng \u0111\u1ECDc/parse \u0111\u01B0\u1EE3c t\u1EA1i ${path}: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  return validateManifest(raw, path);
+}
+function validateManifest(raw, source = "manifest") {
+  if (typeof raw !== "object" || raw === null) throw new Error(`${source}: manifest ph\u1EA3i l\xE0 object`);
+  const m = raw;
+  if (m.version !== 1) throw new Error(`${source}: version ph\u1EA3i l\xE0 1`);
+  if (typeof m.services !== "object" || m.services === null || Object.keys(m.services).length === 0) {
+    throw new Error(`${source}: services ph\u1EA3i l\xE0 object KH\xD4NG r\u1ED7ng`);
+  }
+  const services = {};
+  for (const [name, meta] of Object.entries(m.services)) {
+    if (typeof meta !== "object" || meta === null) throw new Error(`${source}: services.${name} ph\u1EA3i l\xE0 object`);
+    const layer = meta.layer;
+    if (!layer || !STACK_LAYERS.includes(layer)) {
+      throw new Error(`${source}: services.${name}.layer ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+    }
+    services[name] = meta;
+  }
+  if (typeof m.files !== "object" || m.files === null) throw new Error(`${source}: files ph\u1EA3i l\xE0 object`);
+  const files = m.files;
+  if (typeof files.compose !== "string" || files.compose.length === 0) {
+    throw new Error(`${source}: files.compose b\u1EAFt bu\u1ED9c (\u0111\u01B0\u1EDDng d\u1EABn docker-compose trong template)`);
+  }
+  if (files.env !== void 0 && typeof files.env !== "string") throw new Error(`${source}: files.env ph\u1EA3i l\xE0 string`);
+  if (files.gatewayConf !== void 0 && typeof files.gatewayConf !== "string") {
+    throw new Error(`${source}: files.gatewayConf ph\u1EA3i l\xE0 string`);
+  }
+  const manifest = { version: 1, services, files: { compose: files.compose } };
+  if (typeof files.env === "string") manifest.files.env = files.env;
+  if (typeof files.gatewayConf === "string") manifest.files.gatewayConf = files.gatewayConf;
+  if (typeof m.ports === "object" && m.ports !== null) manifest.ports = m.ports;
+  if (typeof m.smoke === "string") manifest.smoke = m.smoke;
+  return manifest;
+}
+
+export {
+  STACK_LAYERS,
+  loadManifest,
+  validateManifest
+};

package/dist/chunk-ON2WTGZH.js

@@ -0,0 +1,77 @@
+// src/manifest.ts
+import { readFileSync } from "fs";
+var STACK_LAYERS = ["core", "infra", "be", "fe"];
+function loadManifest(path) {
+  let raw;
+  try {
+    raw = JSON.parse(readFileSync(path, "utf8"));
+  } catch (err) {
+    throw new Error(`stack-manifest.json kh\xF4ng \u0111\u1ECDc/parse \u0111\u01B0\u1EE3c t\u1EA1i ${path}: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  return validateManifest(raw, path);
+}
+function validateManifest(raw, source = "manifest") {
+  if (typeof raw !== "object" || raw === null) throw new Error(`${source}: manifest ph\u1EA3i l\xE0 object`);
+  const m = raw;
+  if (m.version !== 1) throw new Error(`${source}: version ph\u1EA3i l\xE0 1`);
+  const services = {};
+  const rawServices = m.services;
+  if (Array.isArray(rawServices)) {
+    for (const item of rawServices) {
+      if (typeof item !== "object" || item === null) throw new Error(`${source}: services[] item ph\u1EA3i l\xE0 object`);
+      const e = item;
+      const name = typeof e.id === "string" ? e.id : void 0;
+      const rawLayer = e.type ?? e.layer;
+      const layer = rawLayer === "fe-no-compose" ? "fe" : rawLayer;
+      if (!name) throw new Error(`${source}: services[].id b\u1EAFt bu\u1ED9c`);
+      if (typeof layer !== "string" || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name} layer (type) ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = {
+        layer,
+        ...Array.isArray(e.paths) ? { paths: e.paths } : {},
+        ...Array.isArray(e.envKeys) ? { envKeys: e.envKeys } : {},
+        ...Array.isArray(e.gatewayBlocks) ? { gatewayBlocks: e.gatewayBlocks } : {},
+        ...Array.isArray(e.requires) ? { requires: e.requires } : {}
+      };
+    }
+  } else if (typeof rawServices === "object" && rawServices !== null) {
+    for (const [name, meta] of Object.entries(rawServices)) {
+      if (typeof meta !== "object" || meta === null) throw new Error(`${source}: services.${name} ph\u1EA3i l\xE0 object`);
+      const layer = meta.layer;
+      if (!layer || !STACK_LAYERS.includes(layer)) {
+        throw new Error(`${source}: services.${name}.layer ph\u1EA3i thu\u1ED9c ${STACK_LAYERS.join("|")} \u2014 nh\u1EADn: ${String(layer)}`);
+      }
+      services[name] = meta;
+    }
+  } else {
+    throw new Error(`${source}: services ph\u1EA3i l\xE0 object KH\xD4NG r\u1ED7ng ho\u1EB7c array`);
+  }
+  if (Object.keys(services).length === 0) throw new Error(`${source}: services kh\xF4ng \u0111\u01B0\u1EE3c r\u1ED7ng`);
+  const filesRaw = typeof m.files === "object" && m.files !== null ? m.files : {};
+  if (filesRaw.compose !== void 0 && typeof filesRaw.compose !== "string") {
+    throw new Error(`${source}: files.compose ph\u1EA3i l\xE0 string`);
+  }
+  if (filesRaw.env !== void 0 && typeof filesRaw.env !== "string") throw new Error(`${source}: files.env ph\u1EA3i l\xE0 string`);
+  if (filesRaw.gatewayConf !== void 0 && typeof filesConfRaw(filesRaw) !== "string") {
+    throw new Error(`${source}: files.gatewayConf ph\u1EA3i l\xE0 string`);
+  }
+  const files = {
+    compose: filesRaw.compose ?? "platform/docker-compose.yml",
+    env: filesRaw.env ?? "platform/.env.example",
+    gatewayConf: filesRaw.gatewayConf ?? "platform/gateway/nginx/nginx.conf"
+  };
+  const manifest = { version: 1, services, files };
+  if (typeof m.ports === "object" && m.ports !== null) manifest.ports = m.ports;
+  if (typeof m.smoke === "string") manifest.smoke = m.smoke;
+  return manifest;
+}
+function filesConfRaw(files) {
+  return files.gatewayConf;
+}
+
+export {
+  STACK_LAYERS,
+  loadManifest,
+  validateManifest
+};