@robsun/create-keystone-app 0.1.18 → 0.2.1

package/README.md

@@ -5,20 +5,32 @@
 npx @robsun/create-keystone-app <dir> [options]
 pnpm dlx @robsun/create-keystone-app <dir> [options]
 ```
+不传 options 会进入交互式向导。
 
 ## 选项
 - `<dir>`：目标目录（必填），可为新目录名或 `.`（当前目录）。
-- `--profile <starter|full>`：模板档位，默认 `starter`。
-- `--demo` / `--no-demo`：是否包含 Demo 模块（`full` 默认包含）。
 - `--db <sqlite|postgres>`：数据库驱动（默认 `sqlite`）。
 - `--queue <memory|redis>`：队列驱动（默认 `memory`）。
 - `--storage <local|s3>`：存储驱动（默认 `local`）。
 
 ## 示例
 ```bash
-npx @robsun/create-keystone-app my-app --profile=full --db=postgres --queue=redis
+npx @robsun/create-keystone-app my-app --db=postgres --queue=redis --storage=s3
 ```
 
+## 模块生成器
+```bash
+npx --package @robsun/create-keystone-app create-keystone-module <module-name> [options]
+pnpm dlx --package @robsun/create-keystone-app create-keystone-module <module-name> [options]
+```
+不传 options 会进入交互式向导。
+
+选项：
+- `--frontend-only`：只生成前端模块。
+- `--backend-only`：只生成后端模块。
+- `--with-crud`：包含 CRUD 示例代码。
+- `--skip-register`：跳过自动注册步骤。
+
 ## 初始化后操作
 ```bash
 cd <dir>
@@ -28,6 +40,7 @@ pnpm web:dev
 pnpm dev
 ```
 
-## 端口与 Demo
+## 端口与 Example
 - Web 默认端口：`3000`；后端默认端口：`8080`。
-- Demo API：`/api/v1/demo/tasks`（仅在包含 Demo 时可用）。
+- Example API：`/api/v1/example/items`。
+- 权限：`example:item:view`、`example:item:manage`。

package/{bin → dist}/create-keystone-app.js

@@ -1,78 +1,140 @@
 #!/usr/bin/env node
 const fs = require('fs');
 const path = require('path');
+const readline = require('readline/promises');
+const { stdin: input, stdout: output } = require('process');
 
 const usage = [
   'Usage: create-keystone-app <dir> [options]',
   '',
   'Options:',
-  '  --profile <starter|full>  Template profile (default: starter)',
-  '  --demo                    Include demo module',
-  '  --no-demo                 Exclude demo module',
   '  --db <sqlite|postgres>    Database driver (default: sqlite)',
   '  --queue <memory|redis>    Queue driver (default: memory)',
   '  --storage <local|s3>      Storage driver (default: local)',
   '  -h, --help                Show help',
+  '',
+  'Run without options to use guided prompts.',
 ].join('\n');
 
-const args = parseArgs(process.argv.slice(2));
-if (args.help) {
-  console.log(usage);
-  process.exit(0);
-}
-
-if (!args.target) {
-  console.error(usage);
+main().catch((err) => {
+  const message = err instanceof Error ? err.message : String(err);
+  console.error(message);
   process.exit(1);
-}
+});
 
-const profile = normalizeChoice(args.profile, ['starter', 'full'], 'profile') || 'starter';
-const db = normalizeChoice(args.db, ['sqlite', 'postgres'], 'db') || 'sqlite';
-const queue = normalizeChoice(args.queue, ['memory', 'redis'], 'queue') || 'memory';
-const storage = normalizeChoice(args.storage, ['local', 's3'], 'storage') || 'local';
+async function main() {
+  const args = parseArgs(process.argv.slice(2));
+  if (args.help) {
+    console.log(usage);
+    return;
+  }
 
-let includeDemo = profile === 'full';
-if (args.demo === true) {
-  includeDemo = true;
-}
-if (args.demo === false) {
-  includeDemo = false;
-}
+  const canPrompt = isInteractive();
+  const rl = canPrompt ? readline.createInterface({ input, output }) : null;
+  let db;
+  let queue;
+  let storage;
+
+  try {
+    if (!args.target) {
+      if (!rl) {
+        console.error(usage);
+        process.exit(1);
+      }
+      args.target = await promptText(rl, 'Project directory', 'keystone-app');
+    }
 
-const targetDir = path.resolve(process.cwd(), args.target);
-const targetName = args.target === '.'
-  ? path.basename(process.cwd())
-  : path.basename(targetDir);
+    db = normalizeChoice(args.db, ['sqlite', 'postgres'], 'db') || null;
+    queue = normalizeChoice(args.queue, ['memory', 'redis'], 'queue') || null;
+    storage = normalizeChoice(args.storage, ['local', 's3'], 'storage') || null;
 
-if (fs.existsSync(targetDir)) {
-  const entries = fs.readdirSync(targetDir);
-  if (entries.length > 0) {
-    console.error(`Target directory is not empty: ${targetDir}`);
-    process.exit(1);
+    if (!db) {
+      db = rl ? await promptSelect(rl, 'Select database driver', ['sqlite', 'postgres'], 0) : 'sqlite';
+    }
+    if (!queue) {
+      queue = rl ? await promptSelect(rl, 'Select queue driver', ['memory', 'redis'], 0) : 'memory';
+    }
+    if (!storage) {
+      storage = rl ? await promptSelect(rl, 'Select storage driver', ['local', 's3'], 0) : 'local';
+    }
+  } finally {
+    if (rl) {
+      rl.close();
+    }
   }
-} else {
-  fs.mkdirSync(targetDir, { recursive: true });
-}
 
-const templateDir = path.resolve(__dirname, '..', 'template');
-copyDir(templateDir, targetDir, {
-  '__APP_NAME__': normalizePackageName(targetName),
-  '__RAW_NAME__': targetName,
-});
+  const targetDir = path.resolve(process.cwd(), args.target);
+  const targetName = args.target === '.'
+    ? path.basename(process.cwd())
+    : path.basename(targetDir);
+
+  if (fs.existsSync(targetDir)) {
+    const entries = fs.readdirSync(targetDir);
+    if (entries.length > 0) {
+      console.error(`Target directory is not empty: ${targetDir}`);
+      process.exit(1);
+    }
+  } else {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  const templateDir = path.resolve(__dirname, '..', 'template');
+  copyDir(templateDir, targetDir, {
+    '__APP_NAME__': normalizePackageName(targetName),
+    '__RAW_NAME__': targetName,
+  });
+
+  applyConfigOptions(targetDir, { db, queue, storage });
+
+  console.log(`Created ${targetName}`);
+  console.log('Next steps:');
+  console.log(`  cd ${args.target}`);
+  console.log('  pnpm install');
+  console.log('  pnpm server:dev');
+  console.log('  pnpm web:dev');
+  console.log('  pnpm dev');
+}
 
-applyConfigOptions(targetDir, { db, queue, storage });
+function isInteractive() {
+  return Boolean(input.isTTY && output.isTTY);
+}
 
-if (!includeDemo) {
-  stripDemo(targetDir);
+async function promptText(rl, label, defaultValue) {
+  while (true) {
+    const suffix = defaultValue ? ` (${defaultValue})` : '';
+    const answer = await rl.question(`${label}${suffix}: `);
+    const trimmed = answer.trim();
+    if (trimmed) {
+      return trimmed;
+    }
+    if (defaultValue) {
+      return defaultValue;
+    }
+    console.log('Please enter a value.');
+  }
 }
 
-console.log(`Created ${targetName}`);
-console.log('Next steps:');
-console.log(`  cd ${args.target}`);
-console.log('  pnpm install');
-console.log('  pnpm server:dev');
-console.log('  pnpm web:dev');
-console.log('  pnpm dev');
+async function promptSelect(rl, label, choices, defaultIndex) {
+  while (true) {
+    const options = choices.map((choice, index) => `  ${index + 1}) ${choice}`).join('\n');
+    const answer = await rl.question(
+      `${label}\n${options}\nSelect an option [${defaultIndex + 1}]: `
+    );
+    const normalized = answer.trim().toLowerCase();
+    if (!normalized) {
+      return choices[defaultIndex];
+    }
+    const numeric = Number(normalized);
+    if (Number.isInteger(numeric) && numeric >= 1 && numeric <= choices.length) {
+      return choices[numeric - 1];
+    }
+    const match = choices.find((choice) => choice.toLowerCase() === normalized);
+    if (match) {
+      return match;
+    }
+    console.log('Invalid selection. Try again.');
+  }
+}
 
 function normalizePackageName(name) {
   const cleaned = String(name || '')
@@ -120,49 +182,6 @@ function shouldSkipDir(name) {
   return name === 'node_modules' || name === '.git';
 }
 
-function stripDemo(targetDir) {
-  removePath(path.join(targetDir, 'apps', 'web', 'src', 'modules', 'demo'));
-  removePath(path.join(targetDir, 'apps', 'server', 'internal', 'modules', 'demo'));
-
-  updateFile(path.join(targetDir, 'apps', 'web', 'src', 'main.tsx'), (content) =>
-    content.replace(/^\s*import ['"]\.\/modules\/demo['"];?\r?\n/m, '')
-  );
-  updateFile(path.join(targetDir, 'apps', 'web', 'src', 'app.config.ts'), (content) =>
-    content.replace(/,\s*['"]demo['"]/, '')
-  );
-  updateFile(path.join(targetDir, 'apps', 'server', 'config.yaml'), (content) =>
-    content.replace(/\r?\n\s*-\s*['"]demo['"]\s*/g, '')
-  );
-  updateFile(path.join(targetDir, 'apps', 'server', 'config.example.yaml'), (content) =>
-    content.replace(/\r?\n\s*-\s*['"]demo['"]\s*/g, '')
-  );
-  updateFile(path.join(targetDir, 'README.md'), (content) =>
-    content.replace(/<!-- DEMO_START -->[\s\S]*?<!-- DEMO_END -->\s*/m, '')
-  );
-
-  const manifestPath = path.join(
-    targetDir,
-    'apps',
-    'server',
-    'internal',
-    'modules',
-    'manifest.go'
-  );
-  const manifest = `package modules
-
-import (
-\texample "__APP_NAME__/apps/server/internal/modules/example"
-)
-
-// RegisterAll wires the module registry for this app.
-func RegisterAll() {
-\tClear()
-\tRegister(example.NewModule())
-}
-`;
-  fs.writeFileSync(manifestPath, manifest, 'utf8');
-}
-
 function applyConfigOptions(targetDir, options) {
   const configFiles = [
     path.join(targetDir, 'apps', 'server', 'config.yaml'),
@@ -172,7 +191,6 @@ function applyConfigOptions(targetDir, options) {
   for (const filePath of configFiles) {
     updateFile(filePath, (content) => applyYamlOptions(content, options));
   }
-
 }
 
 function applyYamlOptions(content, options) {
@@ -202,12 +220,6 @@ function updateYamlSectionValue(content, section, key, value) {
   return content.replace(pattern, `$1${value}$3`);
 }
 
-function removePath(target) {
-  if (fs.existsSync(target)) {
-    fs.rmSync(target, { recursive: true, force: true });
-  }
-}
-
 function updateFile(filePath, updater) {
   if (!fs.existsSync(filePath)) {
     return;
@@ -228,28 +240,14 @@ function shouldMakeExecutable(filePath) {
 }
 
 function parseArgs(argv) {
-  const out = { demo: null };
+  const out = {};
   for (let i = 0; i < argv.length; i++) {
     const arg = argv[i];
-    if (arg === '--demo') {
-      out.demo = true;
-      continue;
-    }
-    if (arg === '--no-demo') {
-      out.demo = false;
-      continue;
-    }
     if (arg === '--help' || arg === '-h') {
       out.help = true;
       continue;
     }
 
-    const profile = readValueOption(arg, argv, i, '--profile');
-    if (profile) {
-      out.profile = profile.value;
-      i += profile.skip;
-      continue;
-    }
     const db = readValueOption(arg, argv, i, '--db');
     if (db) {
       out.db = db.value;
@@ -315,4 +313,4 @@ function fail(message) {
   console.error(message);
   console.error(usage);
   process.exit(1);
-}
+}