@robsun/create-keystone-app 0.2.13 → 0.4.0

package/README.md

@@ -1,50 +1,53 @@
-# @robsun/create-keystone-app
-
-## 用法
-```bash
-npx @robsun/create-keystone-app <dir> [options]
-pnpm dlx @robsun/create-keystone-app <dir> [options]
-```
-不传 options 会进入交互式向导。
-
-## 选项
-- `<dir>`：目标目录（必填），可为新目录名或 `.`（当前目录）。
+# @robsun/create-keystone-app
+
+## 用法
+```bash
+npx @robsun/create-keystone-app <dir> [options]
+pnpm dlx @robsun/create-keystone-app <dir> [options]
+```
+不传 options 会进入交互式向导。
+
+## 选项
+- `<dir>`：目标目录（必填），可为新目录名或 `.`（当前目录）。
 - `--db <sqlite|postgres>`：数据库驱动（默认 `sqlite`）。
 - `--queue <memory|redis>`：队列驱动（默认 `memory`）。
 - `--storage <local|s3>`：存储驱动（默认 `local`）。
-
-## 示例
-```bash
-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`：跳过自动注册步骤。
-
-## AI Skills
-- Codex：`.codex/skills/keystone-dev`
-- Claude：`.claude/skills/keystone-dev`
-
-## 初始化后操作
-```bash
-cd <dir>
+- `--with-example`：包含示例模块。
+- `--with-ci`：包含 CI 工作流模板。
+- `--verify`：生成后执行验证（安装依赖并构建）。
+
+## 示例
+```bash
+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 示例代码。
+- `--with-approval`：包含审批流代码（自动启用 `--with-crud`）。
+- `--skip-register`：跳过自动注册步骤。
+
+## AI Skills
+- Codex：`.codex/skills/keystone-dev`
+- Claude：`.claude/skills/keystone-dev`
+
+## 初始化后操作
+```bash
+cd <dir>
 pnpm install
 pnpm server:dev
-pnpm web:dev
 pnpm dev
 ```
-
-## 端口与 Example
-- Web 默认端口：`3000`；后端默认端口：`8080`。
-- Example API：`/api/v1/example/items`。
-- 权限：`example:item:view`、`example:item:manage`。
+
+## 端口与 Example
+- Web 默认端口：`3000`；后端默认端口：`8080`。
+- Example API：`/api/v1/example/items`。
+- 权限：`example:item:view`、`example:item:manage`。

package/dist/create-keystone-app.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 const fs = require('fs');
 const path = require('path');
+const os = require('os');
 const readline = require('readline/promises');
+const { execFileSync } = require('child_process');
 const { stdin: input, stdout: output } = require('process');
 
 const usage = [
@@ -11,6 +13,10 @@ const usage = [
   '  --db <sqlite|postgres>    Database driver (default: sqlite)',
   '  --queue <memory|redis>    Queue driver (default: memory)',
   '  --storage <local|s3>      Storage driver (default: local)',
+  '  --with-example            Include example module',
+  '  --with-ci                 Include CI workflow templates',
+  '  --verify                  Run post-generation verification',
+  '  --local                   Use local keystone packages (for development)',
   '  -h, --help                Show help',
   '',
   'Run without options to use guided prompts.',
@@ -34,6 +40,8 @@ async function main() {
   let db;
   let queue;
   let storage;
+  let withExample;
+  let withCi;
 
   try {
     if (!args.target) {
@@ -47,6 +55,12 @@ async function main() {
     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 (typeof args.withExample === 'boolean') {
+      withExample = args.withExample;
+    }
+    if (typeof args.withCi === 'boolean') {
+      withCi = args.withCi;
+    }
 
     if (!db) {
       db = rl ? await promptSelect(rl, 'Select database driver', ['sqlite', 'postgres'], 0) : 'sqlite';
@@ -57,6 +71,12 @@ async function main() {
     if (!storage) {
       storage = rl ? await promptSelect(rl, 'Select storage driver', ['local', 's3'], 0) : 'local';
     }
+    if (typeof withExample !== 'boolean') {
+      withExample = rl ? await promptConfirm(rl, 'Include example module', false) : false;
+    }
+    if (typeof withCi !== 'boolean') {
+      withCi = rl ? await promptConfirm(rl, 'Include CI workflows', false) : false;
+    }
   } finally {
     if (rl) {
       rl.close();
@@ -85,14 +105,33 @@ async function main() {
   });
 
   applyConfigOptions(targetDir, { db, queue, storage });
+  applyExampleOption(targetDir, { withExample });
+  applyCiOption(targetDir, { withCi });
 
-  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');
+  const localMode = Boolean(args.local);
+  if (localMode) {
+    const keystoneRoot = path.resolve(__dirname, '..', '..', '..');
+    applyLocalDev(targetDir, keystoneRoot);
+  }
+
+  if (args.verify) {
+    runVerify(targetDir);
+  }
+
+  if (localMode) {
+    console.log(`Created ${targetName} (local development mode)`);
+    console.log('Next steps:');
+    console.log(`  cd ${args.target}`);
+    console.log('  pnpm install');
+    console.log('  pnpm dev');
+  } else {
+    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 dev');
+  }
 }
 
 function isInteractive() {
@@ -136,6 +175,24 @@ async function promptSelect(rl, label, choices, defaultIndex) {
   }
 }
 
+async function promptConfirm(rl, label, defaultValue) {
+  const fallback = defaultValue ? 'Y/n' : 'y/N';
+  while (true) {
+    const answer = await rl.question(`${label} (${fallback}): `);
+    const normalized = answer.trim().toLowerCase();
+    if (!normalized) {
+      return Boolean(defaultValue);
+    }
+    if (['y', 'yes'].includes(normalized)) {
+      return true;
+    }
+    if (['n', 'no'].includes(normalized)) {
+      return false;
+    }
+    console.log('Invalid selection. Try again.');
+  }
+}
+
 function normalizePackageName(name) {
   const cleaned = String(name || '')
     .trim()
@@ -182,6 +239,79 @@ function shouldSkipDir(name) {
   return name === 'node_modules' || name === '.git';
 }
 
+function applyLocalDev(targetDir, keystoneRoot) {
+  // Create .npmrc to deduplicate React in local development
+  const npmrcPath = path.join(targetDir, '.npmrc');
+  const npmrcContent = [
+    '# Deduplicate React to avoid "Invalid hook call" errors with linked packages',
+    'public-hoist-pattern[]=react',
+    'public-hoist-pattern[]=react-dom',
+    'public-hoist-pattern[]=dayjs',
+    'public-hoist-pattern[]=@types/react',
+    'public-hoist-pattern[]=@types/react-dom',
+  ].join('\n') + '\n';
+  fs.writeFileSync(npmrcPath, npmrcContent, 'utf8');
+
+  // Update frontend package.json to use local packages
+  const webPkgPath = path.join(targetDir, 'apps', 'web', 'package.json');
+  if (fs.existsSync(webPkgPath)) {
+    const relPath = path.relative(path.dirname(webPkgPath), keystoneRoot).replace(/\\/g, '/');
+    updateFile(webPkgPath, (content) => {
+      const pkg = JSON.parse(content);
+      if (pkg.dependencies) {
+        if (pkg.dependencies['@robsun/keystone-web-core']) {
+          pkg.dependencies['@robsun/keystone-web-core'] = `link:${relPath}/packages/keystone-web-core`;
+        }
+        if (pkg.dependencies['@robsun/keystone-contracts']) {
+          pkg.dependencies['@robsun/keystone-contracts'] = `link:${relPath}/packages/keystone-contracts`;
+        }
+      }
+      return JSON.stringify(pkg, null, 2) + '\n';
+    });
+  }
+
+  // Update Vite config for local development
+  const viteConfigPath = path.join(targetDir, 'apps', 'web', 'vite.config.ts');
+  if (fs.existsSync(viteConfigPath)) {
+    const relPath = path.relative(path.join(targetDir, 'apps', 'web'), keystoneRoot).replace(/\\/g, '/');
+    updateFile(viteConfigPath, (content) => {
+      let updated = content;
+      // Add dedupe configuration to resolve section
+      if (updated.includes('resolve: {')) {
+        updated = updated.replace(
+          /resolve:\s*\{/,
+          `resolve: {\n    dedupe: ['react', 'react-dom', 'dayjs'],`
+        );
+      }
+      // Add fs.allow to server section to allow accessing linked packages
+      if (updated.includes('server: {')) {
+        updated = updated.replace(
+          /server:\s*\{/,
+          `server: {\n    fs: { allow: ['${relPath}', '.'] },`
+        );
+      }
+      return updated;
+    });
+  }
+
+  // Update backend go.mod to use local package
+  const goModPath = path.join(targetDir, 'apps', 'server', 'go.mod');
+  if (fs.existsSync(goModPath)) {
+    const relPath = path.relative(path.dirname(goModPath), keystoneRoot).replace(/\\/g, '/');
+    updateFile(goModPath, (content) => {
+      if (content.includes('replace github.com/robsuncn/keystone')) {
+        return content;
+      }
+      const lines = content.split('\n');
+      const requireIdx = lines.findIndex(l => l.startsWith('require '));
+      if (requireIdx !== -1) {
+        lines.splice(requireIdx, 0, `replace github.com/robsuncn/keystone => ${relPath}`, '');
+      }
+      return lines.join('\n');
+    });
+  }
+}
+
 function applyConfigOptions(targetDir, options) {
   const configFiles = [
     path.join(targetDir, 'apps', 'server', 'config.yaml'),
@@ -193,6 +323,156 @@ function applyConfigOptions(targetDir, options) {
   }
 }
 
+function applyExampleOption(targetDir, options) {
+  const withExample = Boolean(options?.withExample);
+  const webModulesIndex = path.join(targetDir, 'apps', 'web', 'src', 'modules', 'index.ts');
+  const webConfigPath = path.join(targetDir, 'apps', 'web', 'src', 'app.config.ts');
+  const serverManifestPath = path.join(targetDir, 'apps', 'server', 'internal', 'modules', 'manifest.go');
+  const modulePath = resolveGoModulePath(path.join(targetDir, 'apps', 'server', 'go.mod'));
+  const serverConfigPaths = [
+    path.join(targetDir, 'apps', 'server', 'config.yaml'),
+    path.join(targetDir, 'apps', 'server', 'config.example.yaml'),
+  ];
+
+  if (withExample) {
+    fs.mkdirSync(path.dirname(webModulesIndex), { recursive: true });
+    fs.writeFileSync(webModulesIndex, "import './example'\n", 'utf8');
+    updateFile(webConfigPath, enableExampleInWebConfig);
+    serverConfigPaths.forEach((filePath) => {
+      updateFile(filePath, addExampleModuleToYaml);
+    });
+    fs.writeFileSync(serverManifestPath, exampleManifestContent(modulePath), 'utf8');
+    return;
+  }
+
+  const exampleDirs = [
+    path.join(targetDir, 'apps', 'web', 'src', 'modules', 'example'),
+    path.join(targetDir, 'apps', 'server', 'internal', 'modules', 'example'),
+  ];
+  exampleDirs.forEach((dirPath) => {
+    if (fs.existsSync(dirPath)) {
+      fs.rmSync(dirPath, { recursive: true, force: true });
+    }
+  });
+
+  fs.mkdirSync(path.dirname(webModulesIndex), { recursive: true });
+  fs.writeFileSync(webModulesIndex, '// Register application modules here.\n', 'utf8');
+  updateFile(webConfigPath, removeExampleFromWebConfig);
+  serverConfigPaths.forEach((filePath) => {
+    updateFile(filePath, removeExampleFromYaml);
+  });
+  fs.writeFileSync(serverManifestPath, emptyManifestContent(), 'utf8');
+}
+
+function applyCiOption(targetDir, options) {
+  const withCi = Boolean(options?.withCi);
+  if (withCi) {
+    return;
+  }
+  const paths = [
+    path.join(targetDir, '.github'),
+    path.join(targetDir, '.golangci.yml'),
+    path.join(targetDir, '.eslintrc.js'),
+  ];
+  paths.forEach((target) => {
+    if (!fs.existsSync(target)) {
+      return;
+    }
+    fs.rmSync(target, { recursive: true, force: true });
+  });
+}
+
+function enableExampleInWebConfig(content) {
+  let next = content;
+  if (!next.includes("'example'")) {
+    next = next.replace("enabled: ['keystone'],", "enabled: ['keystone', 'example'],");
+  }
+  if (!next.includes('example_item')) {
+    next = next.replace(
+      "{ value: 'general', label: 'General Flow' },",
+      "{ value: 'general', label: 'General Flow' },\n      { value: 'example_item', label: 'Example Items' },"
+    );
+  }
+  return next;
+}
+
+function removeExampleFromWebConfig(content) {
+  let next = content;
+  next = next.replace("['keystone', 'example']", "['keystone']");
+  next = next.replace("['example', 'keystone']", "['keystone']");
+  next = next.replace(/\n\s*\{ value: 'example_item'[^}]*\},?/g, '');
+  return next;
+}
+
+function addExampleModuleToYaml(content) {
+  if (content.includes('"example"')) {
+    return content;
+  }
+  const pattern = /(modules:\s*[\s\S]*?enabled:\s*\n\s*-\s*"keystone")/m;
+  if (!pattern.test(content)) {
+    return content;
+  }
+  return content.replace(pattern, `$1\n    - "example"`);
+}
+
+function removeExampleFromYaml(content) {
+  return content.replace(/\n\s*-\s*"example"\s*/g, '');
+}
+
+function emptyManifestContent() {
+  return [
+    'package modules',
+    '',
+    'import servermodules "github.com/robsuncn/keystone/server/modules"',
+    '',
+    '// Register wires application modules into the shared registry.',
+    'func Register(registry *servermodules.Registry) {',
+    '\tif registry == nil {',
+    '\t\treturn',
+    '\t}',
+    '\tregistry.Register(servermodules.NewCoreModule())',
+    '}',
+    '',
+  ].join('\n');
+}
+
+function exampleManifestContent(modulePath) {
+  const importPath = modulePath
+    ? `${modulePath}/internal/modules/example`
+    : '__APP_NAME__/apps/server/internal/modules/example';
+  return [
+    'package modules',
+    '',
+    'import (',
+    '\tservermodules "github.com/robsuncn/keystone/server/modules"',
+    '',
+    `\texample "${importPath}"`,
+    ')',
+    '',
+    '// Register wires application modules into the shared registry.',
+    'func Register(registry *servermodules.Registry) {',
+    '\tif registry == nil {',
+    '\t\treturn',
+    '\t}',
+    '\tregistry.Register(servermodules.NewCoreModule())',
+    '\tregistry.Register(example.NewModule())',
+    '}',
+    '',
+  ].join('\n');
+}
+
+function resolveGoModulePath(goModPath) {
+  if (!fs.existsSync(goModPath)) {
+    return '';
+  }
+  const content = fs.readFileSync(goModPath, 'utf8');
+  const match = content.match(/^module\s+([^\s]+)\s*$/m);
+  if (!match) {
+    return '';
+  }
+  return match[1];
+}
+
 function applyYamlOptions(content, options) {
   let next = content;
   if (options.db) {
@@ -213,11 +493,23 @@ function applyYamlOptions(content, options) {
 }
 
 function updateYamlSectionValue(content, section, key, value) {
-  const pattern = new RegExp(`(^${section}:\\s*[\\s\\S]*?^\\s*${key}:\\s*\")([^\"]*)(\")`, 'm');
-  if (!pattern.test(content)) {
+  const sectionPattern = new RegExp(`(^${section}:[^\\n]*\\n)([\\s\\S]*?)(?=^\\S|\\Z)`, 'm');
+  const match = sectionPattern.exec(content);
+  if (!match) {
     return content;
   }
-  return content.replace(pattern, `$1${value}$3`);
+  const block = match[2];
+  const keyPattern = new RegExp(`(^\\s*${key}:\\s*\")([^\"]*)(\")`, 'm');
+  if (!keyPattern.test(block)) {
+    return content;
+  }
+  const updatedBlock = block.replace(keyPattern, `$1${value}$3`);
+  return (
+    content.slice(0, match.index) +
+    match[1] +
+    updatedBlock +
+    content.slice(match.index + match[0].length)
+  );
 }
 
 function updateFile(filePath, updater) {
@@ -239,6 +531,35 @@ function shouldMakeExecutable(filePath) {
   return normalized.includes('/.husky/');
 }
 
+function runVerify(targetDir) {
+  console.log('Running verification...');
+  runCmd('pnpm', ['install'], { cwd: targetDir });
+  runCmd('pnpm', ['-C', 'apps/web', 'build'], { cwd: targetDir });
+  runCmd('go', ['-C', 'apps/server', 'build', './...'], { cwd: targetDir });
+  console.log('Verification complete.');
+}
+
+function runCmd(command, commandArgs, options) {
+  execFileSync(resolveCmd(command), commandArgs, { stdio: 'inherit', ...options });
+}
+
+function resolveCmd(command) {
+  if (os.platform() !== 'win32') {
+    return command;
+  }
+  if (
+    path.isAbsolute(command) ||
+    command.includes('\\') ||
+    command.includes('/') ||
+    command.endsWith('.cmd') ||
+    command.endsWith('.exe') ||
+    command.endsWith('.bat')
+  ) {
+    return command;
+  }
+  return `${command}.cmd`;
+}
+
 function parseArgs(argv) {
   const out = {};
   for (let i = 0; i < argv.length; i++) {
@@ -247,6 +568,22 @@ function parseArgs(argv) {
       out.help = true;
       continue;
     }
+    if (arg === '--local') {
+      out.local = true;
+      continue;
+    }
+    if (arg === '--with-example') {
+      out.withExample = true;
+      continue;
+    }
+    if (arg === '--with-ci') {
+      out.withCi = true;
+      continue;
+    }
+    if (arg === '--verify') {
+      out.verify = true;
+      continue;
+    }
 
     const db = readValueOption(arg, argv, i, '--db');
     if (db) {