@forinda/kickjs-cli 1.2.1 → 1.2.3

package/dist/index.d.ts

@@ -77,6 +77,7 @@ interface GenerateModuleOptions {
     minimal?: boolean;
     force?: boolean;
     pattern?: ProjectPattern;
+    dryRun?: boolean;
 }
 /**
  * Generate a module — structure depends on the project pattern.

package/dist/index.js

@@ -8,7 +8,9 @@ import { createInterface } from "readline";
 // src/utils/fs.ts
 import { writeFile, mkdir, access, readFile } from "fs/promises";
 import { dirname } from "path";
+var _dryRun = false;
 async function writeFileSafe(filePath, content) {
+  if (_dryRun) return;
   await mkdir(dirname(filePath), {
     recursive: true
   });
@@ -1394,7 +1396,7 @@ function promptUser(question) {
 }
 __name(promptUser, "promptUser");
 async function generateModule(options) {
-  const { name, modulesDir, noEntity, noTests, repo = "inmemory", force } = options;
+  const { name, modulesDir, noEntity, noTests, repo = "inmemory", force, dryRun } = options;
   let pattern = options.pattern ?? "ddd";
   if (options.minimal) pattern = "minimal";
   const kebab = toKebabCase(name);
@@ -1406,6 +1408,10 @@ async function generateModule(options) {
   let overwriteAll = force ?? false;
   const write = /* @__PURE__ */ __name(async (relativePath, content) => {
     const fullPath = join(moduleDir, relativePath);
+    if (dryRun) {
+      files.push(fullPath);
+      return;
+    }
     if (!overwriteAll && await fileExists(fullPath)) {
       const answer = await promptUser(`  File already exists: ${relativePath}
   Overwrite? (y/n/a = yes/no/all) `);
@@ -1447,7 +1453,9 @@ async function generateModule(options) {
       await generateDddFiles(ctx);
       break;
   }
-  await autoRegisterModule(modulesDir, pascal, plural);
+  if (!dryRun) {
+    await autoRegisterModule(modulesDir, pascal, plural);
+  }
   return files;
 }
 __name(generateModule, "generateModule");
@@ -2181,6 +2189,7 @@ export default defineConfig({
   },
 })
 `);
+  await writeFileSafe(join9(dir, "README.md"), generateReadme(name, template, packageManager));
   if (options.initGit) {
     try {
       execSync("git init", {
@@ -2338,6 +2347,91 @@ bootstrap({
   }
 }
 __name(getEntryFile, "getEntryFile");
+function generateReadme(name, template, pm) {
+  const templateLabels = {
+    rest: "REST API",
+    graphql: "GraphQL API",
+    ddd: "Domain-Driven Design",
+    cqrs: "CQRS + Event-Driven",
+    minimal: "Minimal"
+  };
+  const packages = [
+    "@forinda/kickjs-core",
+    "@forinda/kickjs-http",
+    "@forinda/kickjs-config"
+  ];
+  if (template !== "minimal") {
+    packages.push("@forinda/kickjs-swagger", "@forinda/kickjs-devtools");
+  }
+  if (template === "graphql") packages.push("@forinda/kickjs-graphql");
+  if (template === "cqrs") {
+    packages.push("@forinda/kickjs-queue", "@forinda/kickjs-ws", "@forinda/kickjs-otel");
+  }
+  return `# ${name}
+
+A **${templateLabels[template] ?? "REST API"}** built with [KickJS](https://forinda.github.io/kick-js/) \u2014 a decorator-driven Node.js framework on Express 5 and TypeScript.
+
+## Getting Started
+
+\`\`\`bash
+${pm} install
+kick dev
+\`\`\`
+
+## Scripts
+
+| Command | Description |
+|---|---|
+| \`kick dev\` | Start dev server with Vite HMR |
+| \`kick build\` | Production build |
+| \`kick start\` | Run production build |
+| \`${pm} run test\` | Run tests with Vitest |
+| \`kick g module <name>\` | Generate a DDD module |
+| \`kick g scaffold <name> <fields...>\` | Generate CRUD from field definitions |
+| \`kick add <package>\` | Add a KickJS package |
+
+## Project Structure
+
+\`\`\`
+src/
+\u251C\u2500\u2500 index.ts           # Application entry point
+\u251C\u2500\u2500 modules/           # Feature modules (controllers, services, repos)
+\u2502   \u2514\u2500\u2500 index.ts       # Module registry
+\u2514\u2500\u2500 ...
+\`\`\`
+
+## Packages
+
+${packages.map((p) => `- \`${p}\``).join("\n")}
+
+## Adding Features
+
+\`\`\`bash
+kick add auth          # Authentication (JWT, API key, OAuth)
+kick add swagger       # OpenAPI documentation
+kick add ws            # WebSocket support
+kick add queue         # Background job processing
+kick add mailer        # Email sending
+kick add cron          # Scheduled tasks
+kick add --list        # Show all available packages
+\`\`\`
+
+## Environment Variables
+
+Copy \`.env.example\` to \`.env\` and configure:
+
+| Variable | Default | Description |
+|---|---|---|
+| \`PORT\` | \`3000\` | Server port |
+| \`NODE_ENV\` | \`development\` | Environment |
+
+## Learn More
+
+- [KickJS Documentation](https://forinda.github.io/kick-js/)
+- [CLI Reference](https://forinda.github.io/kick-js/api/cli.html)
+`;
+}
+__name(generateReadme, "generateReadme");
 
 // src/config.ts
 import { readFile as readFile3, access as access2 } from "fs/promises";