zudojs-cli 0.1.1 → 1.0.0

package/dist/src/templates/modular-monolith/modularMonolith.template.js

@@ -32,28 +32,35 @@
  * └── README.md
  * ```
  */
+import { ZUDOJS_PACKAGES_VERSION } from "../../constants/index.js";
+import { normalizeName } from "../../utils/utils.name.js";
+import { RUNTIME_APP_DEPENDENCIES, moduleSpec, renderAppFile, renderModuleFile, renderServerFile, renderZudojsConfig, } from "../shared/index.js";
 export function generateModularMonolithFiles(options) {
     const nameSlug = options.projectName
         .replace(/[^a-z0-9-]+/gi, "-")
         .toLowerCase();
-    const modules = options.services.length > 0
+    // Normalized: each name becomes a directory segment and a class name.
+    const modules = (options.services.length > 0
         ? options.services
-        : ["identity", "enrollment", "assessment"];
+        : ["identity", "enrollment", "assessment"])
+        .map((m) => normalizeName(m))
+        .filter((m) => m.length > 0);
     const deps = [
-        "@zudojs/core",
-        "@zudojs/container",
+        ...RUNTIME_APP_DEPENDENCIES,
         "@zudojs/config",
-        "@zudojs/logger",
         "@zudojs/errors",
-        "@zudojs/constants",
         "@zudojs/types",
         "@zudojs/validation",
         "@zudojs/cqrs",
-        "@zudojs/events",
         "@zudojs/messaging",
         "@zudojs/http",
     ];
-    const devDeps = ["tsx", "typescript", "@types/node", "vitest"];
+    const devDeps = {
+        tsx: "^4.7.0",
+        typescript: "^5.7.0",
+        "@types/node": "^24.0.0",
+        vitest: "^3.0.0",
+    };
     const files = {};
     // package.json
     files["package.json"] =
@@ -63,24 +70,29 @@ export function generateModularMonolithFiles(options) {
             private: true,
             type: "module",
             license: "MIT",
+            zudojs: {
+                projectType: "backend",
+                architecture: "modular-monolith",
+                features: [],
+            },
             scripts: {
-                dev: "node --import tsx watch src/server.ts",
+                dev: "tsx watch src/server.ts",
                 start: "node dist/server.js",
                 build: "tsc",
                 typecheck: "tsc --noEmit",
                 test: "vitest run",
             },
-            dependencies: Object.fromEntries(deps.map((d) => [d, "workspace:*"])),
-            devDependencies: Object.fromEntries(devDeps.map((d) => [d, "^1.0.0"])),
+            dependencies: Object.fromEntries([...new Set(deps)].map((d) => [d, ZUDOJS_PACKAGES_VERSION])),
+            devDependencies: devDeps,
         }, null, 2) + "\n";
     files["tsconfig.json"] = `{
   "compilerOptions": {
     "target": "ES2024",
     "module": "Node16",
     "moduleResolution": "Node16",
-    "allowImportingTsExtensions": true,
+    "outDir": "dist",
+    "rootDir": "src",
     "strict": true,
-    "noEmit": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
     "resolveJsonModule": true,
@@ -91,34 +103,11 @@ export function generateModularMonolithFiles(options) {
   "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }
 `;
-    files["zudojs.config.ts"] = `import { defineConfig } from "@zudojs/config";
-
-export default defineConfig({
-  application: {
-    name: "${nameSlug}",
-  },
-
-  architecture: "modular-monolith",
-
-  runtime: {
-    port: Number(process.env.PORT ?? 3000),
-    env: process.env.NODE_ENV ?? "development",
-  },
-
-  http: {
-    enabled: true,
-    port: 3000,
-  },
-
-  cqrs: {
-    enabled: true,
-  },
-
-  database: {
-    enabled: true,
-  },
-});
-`;
+    files["zudojs.config.ts"] = renderZudojsConfig({
+        projectName: nameSlug,
+        projectType: "backend",
+        architecture: "modular-monolith",
+    });
     files[".env.example"] = `NODE_ENV=development
 PORT=3000
 DATABASE_URL=postgresql://localhost:5432/${nameSlug}
@@ -141,8 +130,7 @@ ${modules.map((m) => `- **${m}**`).join("\n")}
 ## Getting Started
 
 \`\`\`bash
-pnpm install
-pnpm dev
+${options.packageManager === "npm" ? "npm run dev" : options.packageManager === "yarn" ? "yarn dev" : options.packageManager === "bun" ? "bun run dev" : "pnpm run dev"}
 \`\`\`
 
 ## License
@@ -152,54 +140,30 @@ MIT
     // Shared source directories
     files["src/index.ts"] = `export { createApp } from "./app.js";
 `;
-    files["src/app.ts"] = `import { logger } from "@zudojs/logger";
-import { createContainer } from "@zudojs/container";
-
-export async function createApp() {
-  const log = logger.child({ service: "app" });
-  const container = createContainer();
-
-  log.info("${nameSlug} v0.1.0 starting...");
-
-  return {
-    container,
-    listen: async () => {
-      log.info("Server started");
-    },
-    stop: async () => {
-      log.info("Shutting down...");
-    },
-  };
-}
-`;
-    files["src/server.ts"] = `import { createApp } from "./app.js";
-import { createRuntime } from "@zudojs/runtime";
-
-const app = await createApp();
-
-const runtime = createRuntime({
-  onShutdown: async () => {
-    await app.stop();
-  },
-});
-
-await runtime.start();
-await app.listen();
-
-process.on("SIGTERM", async () => {
-  await runtime.stop();
-  process.exit(0);
-});
-`;
+    const moduleSpecs = modules.map((m) => moduleSpec(m, `./modules/${m}/index.js`));
+    files["src/app.ts"] = renderAppFile({
+        applicationName: nameSlug,
+        modules: moduleSpecs,
+    });
+    files["src/server.ts"] = renderServerFile();
     const sharedDirs = [
         "configs",
         "constants",
+        "controllers",
         "databases",
+        "dtos",
+        "enums",
         "errors",
         "events",
         "interfaces",
+        "jobs",
         "loaders",
+        "loggers",
         "middlewares",
+        "models",
+        "repositories",
+        "routes",
+        "services",
         "types",
         "utils",
         "validators",
@@ -210,31 +174,15 @@ process.on("SIGTERM", async () => {
     files["src/modules/index.ts"] =
         modules.map((m) => `export * from "./${m}/index.js";`).join("\n") + "\n";
     // Generate each module with CQRS structure
-    for (const mod of modules) {
-        const modName = mod;
-        const modNamePascal = modName
-            .replace(/-([a-z])/g, (_m, c) => c.toUpperCase())
-            .replace(/^./, (c) => c.toUpperCase());
-        files[`src/modules/${modName}/index.ts`] =
-            `export { ${modNamePascal}Module } from "./${modName}.module.js";
-`;
-        files[`src/modules/${modName}/${modName}.module.ts`] =
-            `import { logger } from "@zudojs/logger";
-
-export class ${modNamePascal}Module {
-  private readonly log = logger.child({ module: "${modName}" });
-
-  id = "${modName}-module";
-
-  initialize() {
-    this.log.info("${modName} module initialized");
-  }
-}
-`;
+    for (const spec of moduleSpecs) {
+        files[`src/modules/${spec.name}/index.ts`] =
+            `export { ${spec.className} } from "./${spec.name}.module.js";\n`;
+        files[`src/modules/${spec.name}/${spec.name}.module.ts`] = renderModuleFile({
+            module: spec,
+        });
         // CQRS structure
-        files[`src/modules/${modName}/commands/index.ts`] = ``;
-        files[`src/modules/${modName}/queries/index.ts`] = ``;
-        files[`src/modules/${modName}/events/index.ts`] = ``;
+        files[`src/modules/${spec.name}/commands/index.ts`] = ``;
+        files[`src/modules/${spec.name}/queries/index.ts`] = ``;
     }
     files["tests/index.ts"] = `import { describe, it, expect } from "vitest";
 

package/dist/src/templates/monolith/monolith.template.d.ts

@@ -24,6 +24,7 @@
  * │   ├── loggers/
  * │   ├── middlewares/
  * │   ├── models/
+ * │   ├── modules/
  * │   ├── repositories/
  * │   ├── routes/
  * │   ├── services/

package/dist/src/templates/monolith/monolith.template.js

@@ -24,6 +24,7 @@
  * │   ├── loggers/
  * │   ├── middlewares/
  * │   ├── models/
+ * │   ├── modules/
  * │   ├── repositories/
  * │   ├── routes/
  * │   ├── services/
@@ -37,16 +38,16 @@
  * └── README.md
  * ```
  */
+import { ZUDOJS_PACKAGES_VERSION } from "../../constants/index.js";
+import { normalizeName, toPascalCase } from "../../utils/utils.name.js";
+import { RUNTIME_APP_DEPENDENCIES, moduleSpec, renderAppFile, renderModuleFile, renderServerFile, renderServiceFile, renderZudojsConfig, } from "../shared/index.js";
 export function generateMonolithFiles(options) {
     const name = options.projectName;
     const nameSlug = name.replace(/[^a-z0-9-]+/gi, "-").toLowerCase();
     const deps = [
-        "@zudojs/core",
-        "@zudojs/container",
+        ...RUNTIME_APP_DEPENDENCIES,
         "@zudojs/config",
-        "@zudojs/logger",
         "@zudojs/errors",
-        "@zudojs/constants",
         "@zudojs/types",
         "@zudojs/validation",
         "@zudojs/schema",
@@ -67,7 +68,12 @@ export function generateMonolithFiles(options) {
     if (options.enableOpenAPI) {
         deps.push("@zudojs/openapi");
     }
-    const devDeps = ["tsx", "typescript", "@types/node", "vitest"];
+    const devDeps = {
+        tsx: "^4.7.0",
+        typescript: "^5.7.0",
+        "@types/node": "^24.0.0",
+        vitest: "^3.0.0",
+    };
     const files = {};
     // Root files
     files["package.json"] =
@@ -77,16 +83,21 @@ export function generateMonolithFiles(options) {
             private: true,
             type: "module",
             license: "MIT",
+            zudojs: {
+                projectType: "backend",
+                architecture: "monolith",
+                features: [],
+            },
             scripts: {
-                dev: "node --import tsx watch src/server.ts",
+                dev: "tsx watch src/server.ts",
                 start: "node dist/server.js",
                 build: "tsc",
                 typecheck: "tsc --noEmit",
                 test: "vitest run",
                 lint: "tsc --noEmit",
             },
-            dependencies: Object.fromEntries([...new Set(deps)].map((d) => [d, "workspace:*"])),
-            devDependencies: Object.fromEntries(devDeps.map((d) => [d, "^1.0.0"])),
+            dependencies: Object.fromEntries([...new Set(deps)].map((d) => [d, ZUDOJS_PACKAGES_VERSION])),
+            devDependencies: devDeps,
         }, null, 2) + "\n";
     // tsconfig
     files["tsconfig.json"] = `{
@@ -94,9 +105,9 @@ export function generateMonolithFiles(options) {
     "target": "ES2024",
     "module": "Node16",
     "moduleResolution": "Node16",
-    "allowImportingTsExtensions": true,
+    "outDir": "dist",
+    "rootDir": "src",
     "strict": true,
-    "noEmit": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
     "resolveJsonModule": true,
@@ -107,45 +118,11 @@ export function generateMonolithFiles(options) {
   "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }
 `;
-    // zudojs.config.ts
-    files["zudojs.config.ts"] = `import { defineConfig } from "@zudojs/config";
-
-export default defineConfig({
-  application: {
-    name: "${nameSlug}",
-  },
-
-  architecture: "monolith",
-
-  runtime: {
-    port: Number(process.env.PORT ?? 3000),
-    env: process.env.NODE_ENV ?? "development",
-    shutdownTimeout: 30_000,
-  },
-
-  http: {
-    enabled: true,
-    host: "0.0.0.0",
-    port: Number(process.env.HTTP_PORT ?? 3000),
-  },
-
-  cqrs: {
-    enabled: ${options.enableCQRS},
-  },
-
-  database: {
-    enabled: ${options.enableDatabase},
-  },
-
-  events: {
-    enabled: ${options.enableMessaging},
-  },
-
-  observability: {
-    enabled: ${options.enableObservability},
-  },
-});
-`;
+    files["zudojs.config.ts"] = renderZudojsConfig({
+        projectName: nameSlug,
+        projectType: "backend",
+        architecture: "monolith",
+    });
     // Environment
     files[".env.example"] = `NODE_ENV=development
 PORT=3000
@@ -166,8 +143,7 @@ A Zudojs framework application.
 ## Getting Started
 
 \`\`\`bash
-pnpm install
-pnpm dev
+${options.packageManager === "npm" ? "npm run dev" : options.packageManager === "yarn" ? "yarn dev" : options.packageManager === "bun" ? "bun run dev" : "pnpm run dev"}
 \`\`\`
 
 ## Structure
@@ -190,6 +166,7 @@ src/
 ├── loggers/         # Logger configuration
 ├── middlewares/     # HTTP middleware
 ├── models/          # Data models
+├── modules/         # Runtime modules
 ├── repositories/    # Data repositories
 ├── routes/          # HTTP routes
 ├── services/        # Application services
@@ -205,47 +182,24 @@ MIT
     // src/ entry points
     files["src/index.ts"] = `export { createApp } from "./app.js";
 `;
-    files["src/server.ts"] = `import { createApp } from "./app.js";
-import { createRuntime } from "@zudojs/runtime";
-import { logger } from "@zudojs/logger";
-
-const app = await createApp();
-
-const runtime = createRuntime({
-  onShutdown: async () => {
-    await app.stop();
-  },
-});
-
-await runtime.start();
-
-const server = await app.listen();
-
-process.on("SIGTERM", async () => {
-  await runtime.stop();
-  process.exit(0);
-});
-`;
-    files["src/app.ts"] = `import { logger } from "@zudojs/logger";
-import { createContainer } from "@zudojs/container";
-
-export async function createApp() {
-  const log = logger.child({ service: "app" });
-  const container = createContainer();
-
-  log.info("${nameSlug} v0.1.0 starting...");
-
-  return {
-    container,
-    listen: async () => {
-      log.info("Server started");
-    },
-    stop: async () => {
-      log.info("Shutting down...");
-    },
-  };
-}
-`;
+    files["src/server.ts"] = renderServerFile();
+    // Normalized: the name becomes a file path segment and a class name.
+    const moduleName = normalizeName(options.services[0] ?? "app") || "app";
+    const serviceClassName = `${toPascalCase(moduleName)}Service`;
+    const appModule = moduleSpec(moduleName, "./modules/index.js");
+    files["src/app.ts"] = renderAppFile({
+        applicationName: nameSlug,
+        modules: [appModule],
+    });
+    files[`src/modules/${moduleName}.module.ts`] = renderModuleFile({
+        module: appModule,
+        service: {
+            className: serviceClassName,
+            importPath: "../services/index.js",
+        },
+    });
+    files["src/modules/index.ts"] =
+        `export { ${appModule.className} } from "./${moduleName}.module.js";\n`;
     // Shared directories with empty index.ts
     const sharedDirs = [
         "configs",
@@ -271,8 +225,10 @@ export async function createApp() {
     for (const dir of sharedDirs) {
         files[`src/${dir}/index.ts`] = "";
     }
-    // Services with CQRS structure
-    files["src/services/index.ts"] = ``;
+    // Services
+    files[`src/services/${moduleName}.service.ts`] = renderServiceFile(moduleName);
+    files["src/services/index.ts"] =
+        `export { ${serviceClassName} } from "./${moduleName}.service.js";\n`;
     // Controllers
     files["src/controllers/health.controller.ts"] =
         `export class HealthController {

package/dist/src/templates/shared/appRuntime.template.d.ts

@@ -0,0 +1,71 @@
+/**
+ * zudojs-cli — Shared Runtime App Templates
+ *
+ * Every architecture template assembles the same four framework pieces:
+ * a logger, a container, an event bus and a set of modules, handed to
+ * `createRuntime(dependencies, options)`.
+ *
+ * The emitted source is kept here rather than duplicated per architecture
+ * so it can be verified against the real `@zudojs/*` packages in one place.
+ * `tests/generatedProject.typecheck.test.ts` type-checks the output of every
+ * template against `packages/<name>/src/index.ts`, so any drift between these
+ * snippets and the framework API fails the CLI test suite.
+ */
+/** Packages every generated runtime entry point imports from. */
+export declare const RUNTIME_APP_DEPENDENCIES: readonly ["@zudojs/core", "@zudojs/runtime", "@zudojs/container", "@zudojs/events", "@zudojs/logger", "@zudojs/constants"];
+/** A module registered with the runtime by the generated `createApp`. */
+export interface RuntimeModuleSpec {
+    /** Slug used for the module id, file name and log messages. */
+    readonly name: string;
+    /** PascalCase class name. */
+    readonly className: string;
+    /** Import specifier the module class is imported from, relative to app.ts. */
+    readonly importPath: string;
+}
+/** Builds a module spec from a raw name. */
+export declare function moduleSpec(name: string, importPath: string): RuntimeModuleSpec;
+/**
+ * Renders `zudojs.config.ts`.
+ *
+ * The shape matches what the fullstack composer writes and what
+ * `zudojs generate` parses to detect the project architecture.
+ */
+export declare function renderZudojsConfig(options: {
+    readonly projectName: string;
+    readonly projectType: string;
+    readonly architecture: string;
+}): string;
+/**
+ * Renders `src/app.ts`: assembles the runtime dependencies and returns a
+ * started-on-demand `Runtime`.
+ */
+export declare function renderAppFile(options: {
+    readonly applicationName: string;
+    readonly modules: readonly RuntimeModuleSpec[];
+    /**
+     * Port this app is deployed on. Recorded as runtime metadata so the value
+     * in docker-compose.yml and the Dockerfile is also visible from the app.
+     */
+    readonly port?: number;
+}): string;
+/**
+ * Renders `src/server.ts`: the process entry point. Starts the runtime and
+ * stops it cleanly on SIGINT/SIGTERM.
+ */
+export declare function renderServerFile(appImportPath?: string): string;
+/**
+ * Renders a module class extending `BaseModule`.
+ *
+ * `BaseModule`'s constructor is protected, so the generated class declares a
+ * public constructor — without one the class cannot be instantiated.
+ */
+export declare function renderModuleFile(options: {
+    readonly module: RuntimeModuleSpec;
+    readonly service?: {
+        readonly className: string;
+        readonly importPath: string;
+    };
+}): string;
+/** Renders a service class using the real `createLogger` factory. */
+export declare function renderServiceFile(name: string): string;
+//# sourceMappingURL=appRuntime.template.d.ts.map